.. oe:namespace:: OEFastROCS



.. meta::
   :keywords: OEShapeDatabaseOptions, ShapeDatabaseOptions


.. _OEFastROCS_OEShapeDatabaseOptions:

.. oe:class:: OEShapeDatabaseOptions

   .. oe:api::


      class OEShapeDatabaseOptions

   This class is used to control the behavior of
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. It allows
   setting options on a per-search basis.

   .. note::

      It is possible for the options selected in this class to not
      match the settings of the constructed
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` causing an error to be
      thrown.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEShapeDatabaseOptions()
            OEShapeDatabaseOptions(const OEShapeDatabaseOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeDatabaseOptions() -> OEShapeDatabaseOptions
            OEShapeDatabaseOptions(arg2: OEShapeDatabaseOptions) -> OEShapeDatabaseOptions

      Default constructor for creating a new instance with default
      options. The copy constructor will copy all the options into a new object.

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

      .. oe:api::

         OEShapeDatabaseOptions &operator=(const OEShapeDatabaseOptions &)

      Assignment operator for making a copy of the options.

   .. _OEFastROCS_OEShapeDatabaseOptions_ClearCutoff:

      Assignment operator.


   .. oe:method:: ClearCutoff

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

         .. oe:api::

            void ClearCutoff()

      .. oe:language:: python

         .. oe:api:: python

            ClearCutoff() -> None

      Removes the cutoff from this set of options. The
      default is to have no cutoff value specified.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`

   .. _OEFastROCS_OEShapeDatabaseOptions_ClearTracer:

   .. oe:method:: ClearTracer

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

         .. oe:api::

            void ClearTracer()

      .. oe:language:: python

         .. oe:api:: python

            ClearTracer() -> None

      Removes the progress bar tracer from this set of options.

      .. note::

         This does not release the memory of the
         :oe:meth:`OEFastROCS::OEDBTracerBase` previously passed to
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTracer`.

      .. seealso::

         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTracer`

   .. _OEFastROCS_OEShapeDatabaseOptions_ClearUserStarts:

   .. oe:method:: ClearUserStarts

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

         .. oe:api::

            void ClearUserStarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearUserStarts() -> None

      Removes any user inertial starts that have been previously set. 

      .. seealso::

         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetUserStarts`
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetColorForceFieldType:


   .. oe:method:: GetColorForceFieldType

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

         .. oe:api::

            unsigned int GetColorForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceFieldType() -> int

   .. _OEFastROCS_OEShapeDatabaseOptions_GetColorOptimization:

   .. oe:method:: GetColorOptimization

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

         .. oe:api::

            bool GetColorOptimization() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorOptimization() -> bool

      Returns true if color score is being optimized in addition to shape score.

      .. seealso::
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetColorOptimization`


   .. _OEFastROCS_OEShapeDatabaseOptions_GetCutoff:

   .. oe:method:: GetCutoff

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

         .. oe:api::

            float GetCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      Returns the cutoff currently set in this set of options. The
      default is a cutoff of ``0.0``, i.e., no cutoff, all scores will
      be returned.
      This is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`.

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetCutoffGT:

   .. oe:method:: GetCutoffGT

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

         .. oe:api::

            float GetCutoffGT() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoffGT() -> float

      This method is identical in functionality to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
      and is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetCutoffLT:

   .. oe:method:: GetCutoffLT

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

         .. oe:api::

            float GetCutoffLT() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoffLT() -> float

      Returns the cutoff currently set in this set of options. The
      default is no cutoff, all scores will be returned. 
      This method applies to a cutoff set using :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`
      to retrieve results less than or equal to the cutoff value.

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetInitialOrientation:

   .. oe:method:: GetInitialOrientation

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

         .. oe:api::

            unsigned int GetInitialOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialOrientation() -> int

      Returns the initial orientation to be used for the overlay optimization
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSOrientation` namespace.
      The default orientation is :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`
      
      .. seealso::
     
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`   .. oe:method:: GetInitialOrientation

   .. _OEFastROCS_OEShapeDatabaseOptions_GetFastROCSMode:

   .. oe:method:: GetFastROCSMode

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

         .. oe:api::

            unsigned int GetFastROCSMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetFastROCSMode() -> int

      Returns the calculation mode to be used for the overlay optimization
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSMode` namespace.
      The default mode is :oe:constns:`OEFastROCS::OEFastROCSMode::FastROCS`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetLimit:

   .. oe:method:: GetLimit

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

         .. oe:api::

            unsigned int GetLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetLimit() -> int

      Returns the number of individual molecule "hits" that will be
      returned from
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`, i.e.,
      the number of individual
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects that will be
      returned.

      .. note::

         This method has no effect on the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` method.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetMaxConfs:

   .. oe:method:: GetMaxConfs

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

         .. oe:api::

            unsigned int GetMaxConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int

      Returns the maximum number of conformers to return per
      molecule. By default this value is ``1`` indicating only the
      best conformer of a molecule that matched the query molecule
      will be returned as a single
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object. The conformer
      with the highest score will be indicated by the
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetConfIdx` method.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetMaxOverlays:

   .. oe:method:: GetMaxOverlays

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

         .. oe:api::

            unsigned int GetMaxOverlays() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOverlays() -> int

      Returns the maximum number of starting points per conformer
      overlaid. By default this value is ``1`` indicating only the
      best of all optimizations performed will be returned.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetMaxRandomTranslation:

   .. oe:method:: GetMaxRandomTranslation

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

         .. oe:api::

            float GetMaxRandomTranslation() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRandomTranslation() -> float

      Returns the maximum allowed translation when using random starting 
      orientations. The default maximum is 2 angstroms.  
 
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumInertialStarts:

   .. oe:method:: GetNumInertialStarts

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

         .. oe:api::

            unsigned int GetNumInertialStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumInertialStarts() -> int

      Returns the number of inertial starts used as starting points
      for the shape optimization. The default value is ``4`` starting
      points oriented along the principle moment of inertia.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumStarts:

   .. oe:method:: GetNumStarts

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

         .. oe:api::

            unsigned int GetNumStarts() const
            unsigned int GetNumStarts(const OEChem::OEMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumStarts() -> int
            GetNumStarts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of alternative starting points set
      for shape optimization. When using 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms` 
      or :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`
      the query molecule is required by the method. 
      If alternative starts have **not** been set or 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` is set, 
      these methods will return a value of ``1``. 

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearUserStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumColorAtomStarts:

   .. oe:method:: GetNumColorAtomStarts

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

         .. oe:api::

            unsigned int GetNumColorAtomStarts(const OEChem::OEMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumColorAtomStarts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of color atom starting points set
      for shape optimization. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms` and
      the query molecule.
      If the query molecule does not have color atoms the search will throw a 
      warning and default to :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`.

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumHeavyAtomStarts:

   .. oe:method:: GetNumHeavyAtomStarts

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

         .. oe:api::

            unsigned int GetNumHeavyAtomStarts(const OEChem::OEMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumHeavyAtomStarts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of heavy atom starting points set
      for shape optimization. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms` and
      the query molecule.

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumRandomStarts:

   .. oe:method:: GetNumRandomStarts

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

         .. oe:api::

            unsigned int GetNumRandomStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRandomStarts() -> int

      Returns the number of random starting orientations when using the 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random` 
      alternative start. The default value is ``10``.
      
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumUserStarts:

   .. oe:method:: GetNumUserStarts

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

         .. oe:api::

            unsigned int GetNumUserStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumUserStarts() -> int

      Returns the number of user-defined starting points set
      for shape optimization. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts` and
      user-starts to have been set with 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`.

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`


   .. _OEFastROCS_OEShapeDatabaseOptions_GetRandomSeed:

   .. oe:method:: GetRandomSeed

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

         .. oe:api::

            unsigned int GetRandomSeed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRandomSeed() -> int

      Returns the random seed to be used with :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random`.
      The default random seed is set based on the time.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetScoreType:

   .. oe:method:: GetScoreType

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

         .. oe:api::

            unsigned int GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      Returns the score type drawn from the
      :oe:constns:`OEFastROCS::OEShapeDatabaseType` namespace to be
      used for the search.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetSimFunc:

   .. oe:method:: GetSimFunc

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

         .. oe:api::

            unsigned int GetSimFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetSimFunc() -> int

      Returns the type of similarity function to be used to score the
      search results. The constant type returned is either 'Tanimoto' or
      'Tversky' which is drawn from the :oe:constns:`OEFastROCS::OEShapeSimFuncType`
      namespace.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetTracer:

   .. oe:method:: GetTracer

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

         .. oe:api::

            OEDBTracerBase* GetTracer() const

      .. oe:language:: python

         .. oe:api:: python

            GetTracer() -> OEDBTracerBase

      Returns a pointer to the :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>` to
      be used to track the progress of this search. Returns a ``NULL``
      pointer to indicate that no tracer has been registered.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetTverskyAlpha:

   .. oe:method:: GetTverskyAlpha

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

         .. oe:api::

            float GetTverskyAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyAlpha() -> float

      Returns the alpha coefficient used in the Tversky similarity calculation.
      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTverskyCoeffs` for
      details of how to set alpha. The default value is ``0.95``.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetTverskyBeta:


   .. oe:method:: GetTverskyBeta

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

         .. oe:api::

            float GetTverskyBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyBeta() -> float

      Returns the beta coefficient used in the Tversky similarity calculation.
      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTverskyCoeffs` for
      details of how to set beta. The default value is ``0.05``.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetUserStarts:

   .. oe:method:: GetUserStarts

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

         .. oe:api::

            bool GetUserStarts(vector<float>& startsCoords) const

      .. oe:language:: python

         .. oe:api:: python

            GetUserStarts(xyz: OEFloatVector) -> bool

      Fills a float vector of size ``number of starts * 3`` with the starting coordinates previously set with :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`.
      To ensure vector of the correct size is passed in as an argument, the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts` method
      can be used to retrieve the number of starts set. 
      If successful the return value will be true. 

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

      .. warning::

         Code is not available. **FastROCS TK** is supported only in Python.
      
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`

   .. _OEFastROCS_OEShapeDatabaseOptions_HasCutoff:

   .. oe:method:: HasCutoff

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

         .. oe:api::

            bool HasCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoff() -> bool

      Returns a boolean value indicating whether a cutoff value, at which all scores greater than
      or equal to the value will be saved and all scores less than the value will be discarded,
      has been previously registered with this set of options. By default this is ``false``, no cutoff. 
      If :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff` or :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffGT` 
      has been called already, this will return ``true``. :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`
      will set this back to ``false`` again.
      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffGT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_HasCutoffGT:

   .. oe:method:: HasCutoffGT

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

         .. oe:api::

            bool HasCutoffGT() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoffGT() -> bool

      This method is identical in functionality to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
      and is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffGT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffGT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_HasCutoffLT:

   .. oe:method:: HasCutoffLT

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

         .. oe:api::

            bool HasCutoffLT() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoffLT() -> bool

      Returns a boolean value indicating whether a cutoff value, at which all scores less than
      or equal to the value will be saved and all scores greater than the value will be discarded,
      has been previously registered with this set of options. By default this is ``false``, no cutoffLT. 
      If :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT` 
      has been called already, this will return ``true``. :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`
      will set this back to ``false`` again.
      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffGT`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorForceField:

   .. oe:method:: SetColorForceField

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

         .. oe:api::

            bool SetColorForceField(const OEShape::OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(cff: OEColorForceField) -> bool

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorForceFieldType:

   .. oe:method:: SetColorForceFieldType

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

         .. oe:api::

            bool SetColorForceFieldType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceFieldType(type: int) -> bool

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorOptimization:

   .. oe:method:: SetColorOptimization

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

         .. oe:api::

            void SetColorOptimization(bool ColorOptimization)

      .. oe:language:: python

         .. oe:api:: python

            SetColorOptimization(colorOptimization: bool) -> None

      Set to true to optimize over color score in addition to shape score. Default is false.

      .. note::

         optimizing over color will impact performance. A decrease in 5-20% can be expected.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetColorOptimization`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetCutoff:

   .. oe:method:: SetCutoff

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

         .. oe:api::

            void SetCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(arg2: float) -> None

      Sets the cutoff to use when filtering the results of
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. Only
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects greater than or equal to
      ``cutoff`` depending on the score type will be returned.
      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetCutoffGT:

   .. oe:method:: SetCutoffGT

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

         .. oe:api::

            void SetCutoffGT(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoffGT(arg2: float) -> None

      This method is identical in functionality to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
      and is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`. 

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetCutoffLT:


   .. oe:method:: SetCutoffLT

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

         .. oe:api::

            void SetCutoffLT(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoffLT(arg2: float) -> None

      Sets the cutoff to use when filtering the results of
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. Only
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects less than or equal to
      ``cutoff`` depending on the score type will be returned.

      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`.

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetFastROCSMode:


   .. oe:method:: SetFastROCSMode

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

         .. oe:api::

            void SetFastROCSMode(unsigned int FRMode)

      .. oe:language:: python

         .. oe:api:: python

            SetFastROCSMode(FRMode: int) -> None

      Sets the calculation mode to be used for the overlay optimization
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSMode` namespace.
      The default mode is :oe:constns:`OEFastROCS::OEFastROCSMode::FastROCS`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode`


   .. _OEFastROCS_OEShapeDatabaseOptions_SetInitialOrientation:


   .. oe:method:: SetInitialOrientation

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

         .. oe:api::

            bool SetInitialOrientation(unsigned int orient)

      .. oe:language:: python

         .. oe:api:: python

            SetInitialOrientation(orient: int) -> bool

      Set the initial orientation to be used for optimization of the overlap. The options are 
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSOrientation` and the default is 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`. If user-defined inertial starts
      are to be used then the starting coordinates must be set using the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
      method. Returns true if successful. 

      .. seealso::
        
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetNumRandomStarts:

   .. oe:method:: SetNumRandomStarts

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

         .. oe:api::

            bool SetNumRandomStarts(unsigned int numStarts)

      .. oe:language:: python

         .. oe:api:: python

            SetNumRandomStarts(numStarts: int) -> bool

      Set the number of random starting orientations when using the :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random` 
      alternative start. The default value is ``10``.
      
      .. warning::

         Search speed and the amount of RAM required are proportional to the number of starting orientations therefore
         speed & memory degradation are to be expected if searching with a large number of random
         starting orientations.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetLimit:


   .. oe:method:: SetLimit

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

         .. oe:api::

            void SetLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetLimit(limit: int) -> None

      Set the number of individual
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects that will be
      returned by
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. This is
      a hard limit regardless of the multiplicative effect of also
      setting the
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs` and
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays`
      methods to values greater than ``1``.

      .. note::

         This method has no effect on the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` method.

   ..   _

   .. _OEFastROCS_OEShapeDatabaseOptions_SetMaxConfs:


   .. oe:method:: SetMaxConfs

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

         .. oe:api::

            void SetMaxConfs(unsigned int maxConfs)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(maxConfs: int) -> None

      Set how many conformers per molecule should be returned in the
      results. The default value is ``1``, only the best conformer for
      each database molecule will be returned as an
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object. The conformer
      with the highest score will be indicated by the
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetConfIdx` method.

      Setting this value to ``0`` means all database conformers will
      be returned for every molecule in the database.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetMaxOverlays:


   .. oe:method:: SetMaxOverlays

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

         .. oe:api::

            void SetMaxOverlays(unsigned int maxOverlaysToReturn)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOverlays(maxOverlaysToReturn: int) -> None

      Set how many starting points to return per conformer in the
      database. The default value is ``1``, only the best starting
      point for the conformer will be returned as an
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object.

      Setting this value to ``0`` means all the starting points will
      be returned, i.e., there will be
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumInertialStarts`
      objects returned.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetMaxRandomTranslation:

   .. oe:method:: SetMaxRandomTranslation

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

         .. oe:api::

            bool SetMaxRandomTranslation(float trans)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRandomTranslation(trans: float) -> bool

      Set the maximum allowed translation for each random orientation. The
      default is 2 angstroms. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random`. 

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetNumInertialStarts:


   .. oe:method:: SetNumInertialStarts

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

         .. oe:api::

            void SetNumInertialStarts(unsigned int numStarts)

      .. oe:language:: python

         .. oe:api:: python

            SetNumInertialStarts(numInertialStarts: int) -> None

      Set how many starting points the shape optimization will
      use. Currently, only values between ``1`` and ``8`` inclusive
      can be set. The default value is ``4``, i.e., assume there is a
      dominant moment of inertia for both the query and database
      conformer. Setting this value higher can yield better global
      overlays. However, there is a direct linear relation between the
      performance of **FastROCS TK** and the number of starting
      points.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetRandomSeed:

   .. oe:method:: SetRandomSeed

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

         .. oe:api::

            bool SetRandomSeed(unsigned int seed)

      .. oe:language:: python

         .. oe:api:: python

            SetRandomSeed(seed: int) -> bool

      Sets the random seed to be used with :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random`.
      Returns true if successfully set. The default random seed is set based on the time.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetScoreType:

   .. oe:method:: SetScoreType

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

         .. oe:api::

            void SetScoreType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(type: int) -> None

      Sets which scores to perform during the search. The constant
      ``type`` should be drawn from the
      :oe:constns:`OEFastROCS::OEShapeDatabaseType` namespace.

      .. note::

         The score type must be a proper subset of the score enabled
         during :oe:meth:`OEShapeDatabase construction
         <OEFastROCS::OEShapeDatabase::Constructors>`. That means if
         the database was started in "shape only" mode, this value can
         not include :oe:const:`OEFastROCS::OEShapeDatabaseType::Color`.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetSimFunc:

   .. oe:method:: SetSimFunc

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

         .. oe:api::

            void SetSimFunc(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetSimFunc(type: int) -> None

      Sets which type of similarity function to use to score search results.
      The constant type should be either "Tanimoto" or "Tversky" and should be
      drawn from the :oe:constns:`OEFastROCS::OEShapeSimFuncType`.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetTracer:


   .. oe:method:: SetTracer

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

         .. oe:api::

            void SetTracer(OEDBTracerBase& tracer)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(tracer: OEDBTracerBase) -> None

      Register a progress bar tracer with this set of options. The
      ``tracer`` will be updated with a count as chunks of the
      database are processed. It is very important that the
      implementation of :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>` is
      thread-safe as it will be updated from multiple threads
      simultaneously. It is also expected that the consumer of the
      progress bar will be operating in a separate thread to avoid
      wasting search thread time on progress update overhead.

      .. warning::

         The user must take care to keep the ``tracer`` in scope
         during the full duration of the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`
         call. The options object will not make a copy of the tracer
         at all, merely storing a pointer to the ``tracer``. If the
         ``tracer`` is prematurely ``deleted``, this will very likely
         result in a crash. Probably in a non-deterministic way due to
         the threading involved.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetTverskyCoeffs:


   .. oe:method:: SetTverskyCoeffs

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

         .. oe:api::

            void SetTverskyCoeffs(float alpha, float beta)

      .. oe:language:: python

         .. oe:api:: python

            SetTverskyCoeffs(alpha: float = 0.95, beta: float = 0.05) -> None

      Sets the alpha and beta coefficients to be used in the Tversky similarity
      calculation. See the :ref:`molecular_shape_section` section in the
      **Shape TK** theory documentation for a description of how this is calculated.
      Default values for alpha and beta are 0.95 and 0.05, respectively.
      Any new values of alpha and beta can be chosen provided they add up to 1.00.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetUserStarts:

   .. oe:method:: SetUserStarts

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

         .. oe:api::

            bool SetUserStarts(vector<float>& startsCoords,
                               unsigned int numStarts)

      .. oe:language:: python

         .. oe:api:: python

            SetUserStarts(startsCoords: OEFloatVector, numStarts: int) -> bool

      Sets the user-defined starting coordinates. The arguments are a vector of floats of
      length 3 * the number of starting points (x, y and z coordinates for each start) -
      ``startsCoords`` and the number of starting coordinates in an unsigned int variable - ``numStarts``. 


      .. warning::
      
         Currently, error checking is not performed for user-defined starting coordinates that fall out
         of scope of the molecule's coordinate range therefore, bad starting coordinates will yield
         zero shape/color overlap. It is the responsibility of the user to ensure sensible 
         starting coordinates.

      The following code snippet shows how to use :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
      and :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts` in a python example.

      .. oe:source:: OEShapeDatabaseOptions_SetUserStarts.py 
         :language:  python
         :noindent:
         :frag:      SNIPPET-SET-USER-STARTS

      :ref:`Full listing. <listing-OEShapeDatabaseOptions_SetUserStarts.py>`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetUserStarts`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetShapeScoreScale:

   .. oe:method:: SetShapeScoreScale

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

         .. oe:api::

            void SetShapeScoreScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeScoreScale(scale: float) -> None

      Set a scale factor for the shape component, defaults to 1.0

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorScoreScale:

   .. oe:method:: SetColorScoreScale

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

         .. oe:api::

            void SetColorScoreScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            SetColorScoreScale(scale: float) -> None

      Set a scale factor for the color component, defaults to 1.0

   .. _OEFastROCS_OEShapeDatabaseOptions_GetShapeScoreScale:

   .. oe:method:: GetShapeScoreScale

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

         .. oe:api::

            float GetShapeScoreScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeScoreScale() -> float

      Gets the scale factor for the shape component

   .. _OEFastROCS_OEShapeDatabaseOptions_GetColorScoreScale:

   .. oe:method:: GetColorScoreScale

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

         .. oe:api::

            void SetColorScoreScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            GetColorScoreScale() -> float

      Gets the scale factor for the color component


   .. Ignored as causes a performance slow-down so should only be used in the event
      that the perception of progress is more important than the performance.
   .. oe:method: GetSortLargest

      .. oe:api::

         bool GetSortLargest() const

      Returns true if set to sort the chunks in descending order (default) and false if
      set to sort the chunks in ascending order. This is good to improve the response
      time of a progress bar in a web interface scenario however, causes a performance
      slow-down.

   .. Ignored as causes a performance slow-down so should only be used in the event
      that the perception of progress is more important than the performance.
   .. oe:method: SetSortLargest

      .. oe:api::

         void SetSortLargest(bool sortLargest)

      Set to false if set to sort the chunks in ascending order.
      This is good to improve the response time of a progress bar in a web interface
      scenario however, causes a performance slow-down. Default is true (descending order).
