:py:mod:`digger.compare.confusion`
==================================

.. py:module:: digger.compare.confusion

.. autodoc2-docstring:: digger.compare.confusion
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`calculate_metrics <digger.compare.confusion.calculate_metrics>`
     - .. autodoc2-docstring:: digger.compare.confusion.calculate_metrics
          :summary:
   * - :py:obj:`extract_shapes <digger.compare.confusion.extract_shapes>`
     - .. autodoc2-docstring:: digger.compare.confusion.extract_shapes
          :summary:

API
~~~

.. py:function:: calculate_metrics(true_positive: float, true_negative: float, false_positive: float, false_negative: float, yamlout: str = 'confusion_metrics.yaml') -> dict
   :canonical: digger.compare.confusion.calculate_metrics

   .. autodoc2-docstring:: digger.compare.confusion.calculate_metrics

.. py:function:: extract_shapes(truth_fn: str, simulation_fn: str, region_fn: str | None = None, make_plot: bool = True, topo_file: str = None, initial_source: str = None) -> dict
   :canonical: digger.compare.confusion.extract_shapes

   .. autodoc2-docstring:: digger.compare.confusion.extract_shapes