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