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