.. include:: ../substitutions

.. 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
