:orphan:

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

.. py:module:: traccuracy.matchers._base


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

Classes
~~~~~~~

.. autoapisummary::

   traccuracy.matchers._base.Matcher




Attributes
~~~~~~~~~~

.. autoapisummary::

   traccuracy.matchers._base.logger


.. py:data:: logger

   

.. py:class:: Matcher




   The Matcher base class provides a wrapper around the compute_mapping method

   Each Matcher subclass will implement its own kwargs as needed.
   In use, the Matcher object will be initialized with kwargs prior to running compute_mapping
   on a particular dataset

   .. 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