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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEScoreHitlist, ScoreHitlist


.. _OEBioisostere_OEScoreHitlist:

.. oe:class:: OEScoreHitlist

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEScoreHitlist: public OEHitlistBase

   This class collects and manages scores from overlay operations, filtering
   duplicates and creating a hit list of unique, high-scoring fragment matches.

   The :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>` class defines the following public methods:

    * :oe:meth:`AddScores<OEBioisostere::OEScoreHitlist::AddScores>`
    * :oe:meth:`Build<OEBioisostere::OEScoreHitlist::Build>`
    * :oe:meth:`GetHits<OEBioisostere::OEScoreHitlist::GetHits>`
    * :oe:meth:`GetMatchCount<OEBioisostere::OEScoreHitlist::GetMatchCount>`



   .. _OEBioisostere_OEScoreHitlist_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEScoreHitlist(const unsigned maxHits = 1000)

      .. oe:language:: python

         .. oe:api:: python

            OEScoreHitlist(maxHits: int = 1000) -> OEScoreHitlist

      This method constructs an :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>` with
      a specified maximum number of hits to retain.


   .. _OEBioisostere_OEScoreHitlist_AddScores:

   .. oe:method:: AddScores

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

         .. oe:api::

            bool AddScores(const std::vector<OEBroodScore>&)

      .. oe:language:: python

         .. oe:api:: python

            AddScores(arg2: OEBroodScoreVector) -> bool

      This method adds a batch of :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` objects
      for score-stage hit list curation.


   .. _OEBioisostere_OEScoreHitlist_Build:

   .. oe:method:: Build

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

         .. oe:api::

            bool Build(const bool final = true) override

      .. oe:language:: python

         .. oe:api:: python

            Build(final: bool = True) -> bool

      This method builds the final hit list from all added scores, filtering duplicates
      and retaining the top-scoring unique fragments.


   .. _OEBioisostere_OEScoreHitlist_GetHits:

   .. oe:method:: GetHits

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

         .. oe:api::

            const std::vector<OEBroodScore>& GetHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEBroodScoreVector

      This method returns curated score-level hits as
      :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` objects.


   .. _OEBioisostere_OEScoreHitlist_GetMatchCount:

   .. oe:method:: GetMatchCount

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

         .. oe:api::

            unsigned GetMatchCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchCount() -> int

      This method returns the number of unique score matches retained in the hit list.

