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

   

