.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeQueryOptions, ShapeQueryOptions


.. _OEShape_OEShapeQueryOptions:

.. oe:class:: OEShapeQueryOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeQueryOptions : public OESystem::OEOptions


   This class provides an interface to setup options required for :ref:`OEShapeQuery <OEShape_OEShapeQuery>` class.
   
   The :ref:`OEShapeQueryOptions <OEShape_OEShapeQueryOptions>` class defines the following public methods:
    * :ref:`GetRelativeGridContourVal<OEShape_OEShapeQueryOptions_GetRelativeGridContourVal>`
    * :ref:`GetShapeGaussianRadius<OEShape_OEShapeQueryOptions_GetShapeGaussianRadius>`
    * :ref:`GetColorGaussianRadius<OEShape_OEShapeQueryOptions_GetColorGaussianRadius>`
    * :ref:`GetScoreType<OEShape_OEShapeQueryOptions_GetScoreType>`
    * :ref:`SetRelativeGridContourVal<OEShape_OEShapeQueryOptions_SetRelativeGridContourVal>`
    * :ref:`SetShapeGaussianRadius<OEShape_OEShapeQueryOptions_SetShapeGaussianRadius>`
    * :ref:`SetColorGaussianRadius<OEShape_OEShapeQueryOptions_SetColorGaussianRadius>`
    * :ref:`SetScoreType<OEShape_OEShapeQueryOptions_SetScoreType>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryOptions()
            OEShapeQueryOptions(const OEShapeQueryOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryOptions() -> OEShapeQueryOptions
            OEShapeQueryOptions(arg2: OEShapeQueryOptions) -> OEShapeQueryOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQueryOptions &operator=(const OEShapeQueryOptions &)

      The assignment operator.

   .. _OEShape_OEShapeQueryOptions_GetRelativeGridContourVal:

      Assignment operator.


   .. oe:method:: GetRelativeGridContourVal

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRelativeGridContourVal() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelativeGridContourVal() -> float

      Returns the maximum relative (to maximum grid value of the input grid) grid contour value allowed for the Gaussians in the final result.

   .. _OEShape_OEShapeQueryOptions_GetShapeGaussianRadius:

   .. oe:method:: GetShapeGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetShapeGaussianRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeGaussianRadius() -> float

      Returns the radius of shape Gaussians used in the grid-to-Gaussians fit. The number 1.70 is the default for the carbon radius.

   .. _OEShape_OEShapeQueryOptions_GetColorGaussianRadius:

   .. oe:method:: GetColorGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetColorGaussianRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorGaussianRadius() -> float

      Returns the radius of color Gaussians used in the grid-to-Gaussians fit. The number 1.08 corresponds to the color Gaussian radius and is the default.

   .. _OEShape_OEShapeQueryOptions_GetScoreType:

   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      Returns the grid score type via the namespace :oe:const:`OEShape::OEGridScoreType`, with possible values :oe:const:`OEShape::OEGridScoreType::CosAngle` and :oe:const:`OEShape::OEGridScoreType::Tanimoto`.

   .. _OEShape_OEShapeQueryOptions_SetRelativeGridContourVal:

   .. oe:method:: SetRelativeGridContourVal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRelativeGridContourVal(double)

      .. oe:language:: python

         .. oe:api:: python

            SetRelativeGridContourVal(value: float) -> bool

      Sets the maximum relative (to maximum grid value of the input grid) grid contour value allowed for the Gaussians in the final result.

   .. _OEShape_OEShapeQueryOptions_SetShapeGaussianRadius:

   .. oe:method:: SetShapeGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetShapeGaussianRadius(double)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeGaussianRadius(value: float) -> bool

      Sets the radius of shape Gaussians used in the grid-to-Gaussians fit.

   .. _OEShape_OEShapeQueryOptions_SetColorGaussianRadius:

   .. oe:method:: SetColorGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorGaussianRadius(double)

      .. oe:language:: python

         .. oe:api:: python

            SetColorGaussianRadius(value: float) -> bool

      Sets the radius of color Gaussians used in the grid-to-Gaussians fit.

   .. _OEShape_OEShapeQueryOptions_SetScoreType:

   .. oe:method:: SetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreType(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Sets the grid score type via the namespace :oe:const:`OEShape::OEGridScoreType`, with possible values :oe:const:`OEShape::OEGridScoreType::CosAngle` and :oe:const:`OEShape::OEGridScoreType::Tanimoto`.

   
