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