.. oe:namespace:: OEShape

.. meta::
   :keywords: OEROCSOptions, ROCSOptions


.. _OEShape_OEROCSOptions:

.. oe:class:: OEROCSOptions

   .. oe:api::

      class OEROCSOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEROCS <OEShape_OEROCS>`.
   
   The :ref:`OEROCSOptions <OEShape_OEROCSOptions>` class defines the following public methods:
    * :oe:meth:`AddCutoff<OEShape::OEROCSOptions::AddCutoff>`
    * :oe:meth:`ClearCutoffs<OEShape::OEROCSOptions::ClearCutoffs>`
    * :oe:meth:`GetConfsPerHit<OEShape::OEROCSOptions::GetConfsPerHit>`
    * :oe:meth:`GetMaxHits<OEShape::OEROCSOptions::GetMaxHits>`
    * :oe:meth:`GetNumBestHits<OEShape::OEROCSOptions::GetNumBestHits>`
    * :oe:meth:`GetOverlayOptions<OEShape::OEROCSOptions::GetOverlayOptions>`
    * :oe:meth:`GetPerformPrep<OEShape::OEROCSOptions::GetPerformPrep>`
    * :oe:meth:`GetRankPredicate<OEShape::OEROCSOptions::GetRankPredicate>`
    * :oe:meth:`GetUseMaxHits<OEShape::OEROCSOptions::GetUseMaxHits>`
    * :oe:meth:`HasCutoff<OEShape::OEROCSOptions::HasCutoff>`
    * :oe:meth:`MeetsCutoff<OEShape::OEROCSOptions::MeetsCutoff>`
    * :oe:meth:`SetConfsPerHit<OEShape::OEROCSOptions::SetConfsPerHit>`
    * :oe:meth:`SetMaxHits<OEShape::OEROCSOptions::SetMaxHits>`
    * :oe:meth:`SetNumBestHits<OEShape::OEROCSOptions::SetNumBestHits>`
    * :oe:meth:`SetOverlayOptions<OEShape::OEROCSOptions::SetOverlayOptions>`
    * :oe:meth:`SetPerformPrep<OEShape::OEROCSOptions::SetPerformPrep>`
    * :oe:meth:`SetRankPredicate<OEShape::OEROCSOptions::SetRankPredicate>`
    * :oe:meth:`SetUseMaxHits<OEShape::OEROCSOptions::SetUseMaxHits>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEROCSOptions()
            OEROCSOptions(const OEROCSOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSOptions() -> OEROCSOptions
            OEROCSOptions(argRocs: OEROCSOptions) -> OEROCSOptions

      Default and copy constructors.

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

      .. oe:api::

         OEROCSOptions &operator=(const OEROCSOptions &)

      Assignment operator.


   .. oe:method:: AddCutoff

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

         .. oe:api::

            void AddCutoff(const OESystem::OEUnaryPredicate<OEBestOverlayScore>&)

      .. oe:language:: python

         .. oe:api:: python

            AddCutoff(argPred: OEOverlayScoreCutoffPred) -> None

      Add a new cutoff criteria for scanning if a hit is acceptable. Multiple
      cutoff criteria can used for a single :ref:`OEROCS <OEShape_OEROCS>` calculation.

   .. oe:method:: ClearCutoffs

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

         .. oe:api::

            void ClearCutoffs()

      .. oe:language:: python

         .. oe:api:: python

            ClearCutoffs() -> None

      Remove all currently defined cutoffs.

   .. oe:method:: GetConfsPerHit

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

         .. oe:api::

            unsigned int GetConfsPerHit() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfsPerHit() -> int

      Returns the current value for the desired number of conformers to be kept
      per hit in the :ref:`OEROCSResult <OEShape_OEROCSResult>` in a :ref:`OEROCS <OEShape_OEROCS>`
      calculation.

   .. oe:method:: GetMaxHits

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

         .. oe:api::

            unsigned int GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      Returns the current value of the maximum number of hits to be looked for 
      in a :ref:`OEROCS <OEShape_OEROCS>` calculation, based on cutoffs.

   .. oe:method:: GetNumBestHits

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

         .. oe:api::

            unsigned int GetNumBestHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBestHits() -> int

      Returns the current value of the maximum number of best hit results to be 
      returned from a :ref:`OEROCS <OEShape_OEROCS>` calculation.

   .. oe:method:: GetOverlayOptions

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

         .. oe:api::

            const OEOverlayOptions& GetOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayOptions() -> OEOverlayOptions

      Returns an instance of the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` as currently set
      for overlay optimization. These options are used in overlay optimization of conformers.

   .. oe:method:: GetPerformPrep

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

         .. oe:api::

            bool GetPerformPrep() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerformPrep() -> bool

      Returns the current state of the perform prep flag.  This flag defines if the reference
      and fit molecules should be prepared (or used as is), before :ref:`OEROCS <OEShape_OEROCS>`
      calculations.

   .. oe:method:: GetRankPredicate

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

         .. oe:api::

            const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& GetRankPredicate()

      .. oe:language:: python

         .. oe:api:: python

            GetRankPredicate() -> OEBestOverlayScoreSorterPred

      Returns an instance of the binary predicate as currently set
      for ranking the obtained hits.

   .. oe:method:: GetUseMaxHits

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

         .. oe:api::

            bool GetUseMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseMaxHits() -> bool

      Returns the current state of the use max hits flag.  This flag defines if a
      :ref:`OEROCS <OEShape_OEROCS>` calculation should be terminated when the defined maximum hits
      is reached.

   .. oe:method:: HasCutoff

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

         .. oe:api::

            bool HasCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoff() -> bool

      Returns `True` if any cutoffs are currently set, `False` otherwise.

   .. oe:method:: MeetsCutoff

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

         .. oe:api::

            bool MeetsCutoff(const OEBestOverlayScore&) const

      .. oe:language:: python

         .. oe:api:: python

            MeetsCutoff(argScore: OEBestOverlayScore) -> bool

      Returns `True` if the specified score meets the cutoffs criterion
      currently set, `False` otherwise.

   .. oe:method:: SetConfsPerHit

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

         .. oe:api::

            bool SetConfsPerHit(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetConfsPerHit(value: int) -> bool

      Sets the value for the desired number of conformers to be kept
      per hit in the :ref:`OEROCSResult <OEShape_OEROCSResult>` in a :ref:`OEROCS <OEShape_OEROCS>`
      calculation. Default: 1.
   
   .. oe:method:: SetMaxHits

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

         .. oe:api::

            bool SetMaxHits(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Sets the value of the maximum number of hits to be looked for 
      in a :ref:`OEROCS <OEShape_OEROCS>` calculation, based on cutoffs. Default: 500.

   .. oe:method:: SetNumBestHits

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

         .. oe:api::

            bool SetNumBestHits(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetNumBestHits(value: int) -> bool

      Sets the value of the maximum number of best hit results to be 
      returned from a :ref:`OEROCS <OEShape_OEROCS>` calculation. Default: 500.

   .. oe:method:: SetOverlayOptions

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

         .. oe:api::

            void SetOverlayOptions(const OEOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlayOptions(opts: OEOverlayOptions) -> None

      Sets the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` for overlay optimization.
      These options are used in overlay optimization of conformers.

   .. oe:method:: SetPerformPrep

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

         .. oe:api::

            bool SetPerformPrep(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerformPrep(value: bool) -> bool

      Sets the state of the perform prep flag.  This flag defines if the reference
      and fit molecules should be prepared (or used as is), before :ref:`OEROCS <OEShape_OEROCS>`
      calculations. Default: `True`.

   .. oe:method:: SetRankPredicate

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

         .. oe:api::

            void SetRankPredicate(const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>&)

      .. oe:language:: python

         .. oe:api:: python

            SetRankPredicate(argPred: OEBestOverlayScoreSorterPred) -> None

      Sets the binary predicate to be used for ranking the obtained hits.

   .. oe:method:: SetUseMaxHits

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

         .. oe:api::

            bool SetUseMaxHits(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseMaxHits(value: bool) -> bool

      Sets the state of the use max hits flag.  This flag defines if a
      :ref:`OEROCS <OEShape_OEROCS>` calculation should be terminated when the defined maximum hits
      is reached. Default: `False`.

