:orphan:

:py:mod:`traccuracy.metrics._track_overlap`
===========================================

.. py:module:: traccuracy.metrics._track_overlap

.. autoapi-nested-parse::

   This submodule implements routines for Track Purity (TP) and Target Effectiveness (TE) scores.

   Definitions (Bise et al., 2011; Chen, 2021; Fukai et al., 2022):

   - TE for a single ground truth track T^g_j is calculated by finding the predicted track T^p_k
     that overlaps with T^g_j in the largest number of the frames and then dividing
     the overlap frame counts by the total frame counts for T^g_j.
     The TE for the total dataset is calculated as the mean of TEs for all ground truth tracks,
     weighted by the length of the tracks.

   - TP is defined analogously, with T^g_j and T^p_j being swapped in the definition.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   traccuracy.metrics._track_overlap.TrackOverlapMetrics




.. py:class:: TrackOverlapMetrics(include_division_edges: bool = True)




   Calculate metrics for longest track overlaps.

   - Target Effectiveness: fraction of longest overlapping prediction
                           tracklets on each GT tracklet
   - Track Purity : fraction of longest overlapping GT
                    tracklets on each prediction tracklet

   :param matched_data: Matched object for set of GT and Pred data
   :type matched_data: traccuracy.matchers.Matched
   :param include_division_edges: If True, include edges at division.
   :type include_division_edges: bool, optional

   .. py:property:: info
      :type: dict[str, Any]

      Dictionary with Metric name and any parameters

   .. py:method:: compute(matched: traccuracy.matchers._matched.Matched, override_matcher: bool = False, relax_skips_gt: bool = False, relax_skips_pred: bool = False) -> traccuracy.metrics._results.Results

      The compute methods of Metric objects return a Results object populated with results
      and associated metadata

      :param matched: Matched data object to compute metrics on
      :type matched: traccuracy.matchers.Matched
      :param override_matcher: If True, the metric will not validate the matcher type
      :type override_matcher: bool
      :param relax_skips_gt: If True, the metric will check if skips in the ground truth
                             graph have an equivalent multi-edge path in predicted graph
      :type relax_skips_gt: bool
      :param relax_skips_pred: If True, the metric will check if skips in the predicted
                               graph have an equivalent multi-edge path in ground truth graph
      :type relax_skips_pred: bool

      :returns:

                Object containing metric results
                    and associated pipeline metadata
      :rtype: traccuracy.metrics._results.Results