Evaluation API
==============

Evaluation processors for assessing correction quality.

.. currentmodule:: facet.evaluation

Utilities
---------

ReferenceDataMixin
~~~~~~~~~~~~~~~~~~

.. autoclass:: facet.evaluation.metrics.ReferenceDataMixin
   :members:
   :undoc-members:
   :show-inheritance:

Interactive Selectors
---------------------

ReferenceIntervalSelector
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: ReferenceIntervalSelector
   :members:
   :undoc-members:
   :show-inheritance:

SignalIntervalSelector
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: SignalIntervalSelector
   :members:
   :undoc-members:
   :show-inheritance:

Metrics Calculators
-------------------

SNRCalculator
~~~~~~~~~~~~~

.. autoclass:: SNRCalculator
   :members:
   :undoc-members:
   :show-inheritance:

LegacySNRCalculator
~~~~~~~~~~~~~~~~~~~

.. autoclass:: LegacySNRCalculator
   :members:
   :undoc-members:
   :show-inheritance:

RMSCalculator
~~~~~~~~~~~~~

.. autoclass:: RMSCalculator
   :members:
   :undoc-members:
   :show-inheritance:

RMSResidualCalculator
~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: RMSResidualCalculator
   :members:
   :undoc-members:
   :show-inheritance:

MedianArtifactCalculator
~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: MedianArtifactCalculator
   :members:
   :undoc-members:
   :show-inheritance:

FFTAllenCalculator
~~~~~~~~~~~~~~~~~~

.. autoclass:: FFTAllenCalculator
   :members:
   :undoc-members:
   :show-inheritance:

FFTNiazyCalculator
~~~~~~~~~~~~~~~~~~

.. autoclass:: FFTNiazyCalculator
   :members:
   :undoc-members:
   :show-inheritance:

Reports
-------

MetricsReport
~~~~~~~~~~~~~

.. autoclass:: MetricsReport
   :members:
   :undoc-members:
   :show-inheritance:

RawPlotter
~~~~~~~~~~

.. autoclass:: RawPlotter
   :members:
   :undoc-members:
   :show-inheritance: