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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonHitlistOptions, EonHitlistOptions


.. _OEEon_OEEonHitlistOptions:

.. oe:class:: OEEonHitlistOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonHitlistOptions : public OESystem::OEOptions

   This class sets up options required for generating
   a hit list in :ref:`OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>`
   from a set of **Eon** hits :ref:`OEEonHit <OEEon_OEEonHit>`.



The :ref:`OEEonHitlistOptions <OEEon_OEEonHitlistOptions>` class defines the following public methods:
    * :oe:meth:`GetMaxHits<OEEon::OEEonHitlistOptions::GetMaxHits>`
    * :oe:meth:`SetMaxHits<OEEon::OEEonHitlistOptions::SetMaxHits>`
    * :oe:meth:`GetBestHits<OEEon::OEEonHitlistOptions::GetBestHits>`
    * :oe:meth:`SetBestHits<OEEon::OEEonHitlistOptions::SetBestHits>`
    * :oe:meth:`GetCutoff<OEEon::OEEonHitlistOptions::GetCutoff>`
    * :oe:meth:`SetCutoff<OEEon::OEEonHitlistOptions::SetCutoff>`
    * :oe:meth:`CreateCopy<OEEon::OEEonHitlistOptions::CreateCopy>`

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEEonHitlistOptions()
            OEEonHitlistOptions(const OEEonHitlistOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEEonHitlistOptions() -> OEEonHitlistOptions
            OEEonHitlistOptions(arg2: OEEonHitlistOptions) -> OEEonHitlistOptions

      Default and copy constructors.

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

      .. oe:api::

         OEEonHitlistOptions &operator=(const OEEonHitlistOptions &)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEEonHitlistOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEonHitlistOptions

      Creates and returns a deep copy of this object.


   .. oe:method:: GetMaxHits

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

         .. oe:api::

            unsigned GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      Returns parameter for the maximum number of hits to be generated. See :oe:meth:`SetMaxHits<OEEon::OEEonHitlistOptions::SetMaxHits>` method.


   .. oe:method:: SetMaxHits

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

         .. oe:api::

            bool SetMaxHits(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Sets the maximum number of molecules to go over. When zero, all inputs to the hit list will be considered in the hit list.
      **Default: 0.**


   .. oe:method:: GetBestHits

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

         .. oe:api::

            unsigned GetBestHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetBestHits() -> int

      Returns parameter for the number of best hits to keep. See :oe:meth:`SetBestHits<OEEon::OEEonHitlistOptions::SetBestHits>` method.


   .. oe:method:: SetBestHits

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

         .. oe:api::

            bool SetBestHits(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetBestHits(value: int) -> bool

      Sets the number of maximum hits to keep at the output of the hit list.
      **Default: 1000.**


   .. oe:method:: GetCutoff

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

         .. oe:api::

            double GetCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      Returns the score cutoff parameter. See :oe:meth:`SetCutoff<OEEon::OEEonHitlistOptions::SetCutoff>` method.


   .. oe:method:: SetCutoff

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

         .. oe:api::

            bool SetCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(value: float) -> bool

      Sets the cutoff parameter. When the combo score is below this value, the hits are ignored.
      **Default: -1.0**