:orphan:

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

.. py:module:: traccuracy.metrics._results


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

Classes
~~~~~~~

.. autoapisummary::

   traccuracy.metrics._results.Results




.. py:class:: Results(results: dict, matcher_info: dict | None, metric_info: dict, gt_name: str | None = None, pred_name: str | None = None)


   The Results object collects information about the pipeline used
   to generate the metric results

   :param results: Dictionary with metric output
   :type results: dict
   :param matcher_info: Dictionary with matcher name and parameters
   :type matcher_info: dict
   :param metric_info: Dictionary with metric name and parameters
   :type metric_info: dict
   :param gt_name: Name of the ground truth data
   :type gt_name: optional, str
   :param pred_name: Name of the predicted data
   :type pred_name: optional, str

   .. py:property:: version
      :type: str

      Return current traccuracy version

   .. py:method:: to_dict() -> dict[str, Any]

      Returns all attributes that are not None as a dictionary

      :returns: Dictionary of Results attributes
      :rtype: dict