:orphan:

:py:mod:`traccuracy.track_errors._divisions`
============================================

.. py:module:: traccuracy.track_errors._divisions


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


Functions
~~~~~~~~~

.. autoapisummary::

   traccuracy.track_errors._divisions.evaluate_division_events



Attributes
~~~~~~~~~~

.. autoapisummary::

   traccuracy.track_errors._divisions.VALID_MATCHING_TYPES


.. py:data:: VALID_MATCHING_TYPES
   :value: ['one-to-one']

   

.. py:function:: evaluate_division_events(matched_data: traccuracy.matchers._matched.Matched, max_frame_buffer: int = 0, relax_skips_gt: bool = False, relax_skips_pred: bool = False) -> traccuracy.matchers._matched.Matched

   Classify division errors and correct shifted divisions according to frame_buffer

   Note: A copy of matched_data will be created for each frame_buffer other than 0.
   For large graphs, creating copies may introduce memory problems.

   :param matched_data: Matched data object containing
                        gt and pred graphs with their associated mapping
   :type matched_data: traccuracy.matchers.Matched
   :param max_frame_buffer: Maximum value of frame buffer to use in correcting
                            shifted divisions. Divisions will be evaluated for all integer values of frame
                            buffer between 0 and max_frame_buffer
   :type max_frame_buffer: int, optional
   :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:

             Matched data object with annotated FP, FN and TP
                 divisions, with a `min_buffer_correct` attribute indicating the minimum frame
                 buffer value that corrects this division, if applicable.
   :rtype: matched_data (traccuracy.matchers.Matched)