:orphan:

:py:mod:`traccuracy.matchers._ctc`
==================================

.. py:module:: traccuracy.matchers._ctc


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

Classes
~~~~~~~

.. autoapisummary::

   traccuracy.matchers._ctc.CTCMatcher




.. py:class:: CTCMatcher




   Match graph nodes based on measure used in cell tracking challenge benchmarking.

   A computed marker (segmentation) is matched to a reference marker if the computed
   marker covers a majority of the reference marker.

   Each reference marker can therefore only be matched to one computed marker, but
   multiple reference markers can be assigned to a single computed marker.

   See https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144959
   for complete details.

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

      Dictionary of Matcher name and any parameters

   .. py:method:: compute_mapping(gt_graph: traccuracy._tracking_graph.TrackingGraph, pred_graph: traccuracy._tracking_graph.TrackingGraph) -> traccuracy.matchers._matched.Matched

      Run the matching on a given set of gt and pred TrackingGraph and returns a Matched object
      with a new copy of each TrackingGraph

      :param gt_graph: Tracking graph object for the gt
      :type gt_graph: traccuracy.TrackingGraph
      :param pred_graph: Tracking graph object for the pred
      :type pred_graph: traccuracy.TrackingGraph

      :returns: Matched data object
      :rtype: matched (traccuracy.matchers.Matched)

      :raises ValueError: gt and pred must be a TrackingGraph object