----------
Dashboards
----------

OPM Data Quality dashboard
==========================

This dashboard monitors the quality of the empty-room data generated from the MEG-OPM system.
The dataset on NYU Box is BIDS valid, so each recording lives under ``sub-emptyroom/ses-YYYYMMDD/meg/``
and is identified by the BIDS ``acq-opm`` entity (a ``.fif`` file). For every recording the same noise
metrics used for the KIT system are computed per sensor and summarised across sensors. The results are
refreshed automatically by the empty-room dashboard GitHub Action.

The metric definitions and thresholds are listed in the Noise Metrics Table on the
:ref:`KIT data quality page <data_quality_metrics>`.

Latest recordings
-----------------

.. csv-table:: OPM empty-room metrics per recording (most recent first)
   :file: ../data/data-quality-dashboards/opm-empty-room-metrics-display.csv
   :header-rows: 1

Sensor noise topography
-----------------------

Per sensor RMS noise for the most recent sessions, projected onto the OPM sensor layout.
A localised bright spot points to a noisy or faulty sensor, while a whole map shifting to brighter
colours points to a noisy session.

.. image:: ../_static/2-data-quality-dashboards/opm_topomap_recent.png
   :width: 100%
   :alt: OPM per sensor RMS noise topography for recent sessions

Noise per sensor across sessions
--------------------------------

The heatmap below shows the RMS noise of every sensor (rows) across all sessions (columns).
A bright horizontal band identifies a sensor that is consistently noisy, while a bright vertical band
identifies a noisy session.

.. raw:: html

    <iframe src="../_static/2-data-quality-dashboards/opm_sensor_heatmap.html" width="100%" height="820px" frameborder="0"></iframe>

Amplitude spectrum
------------------

.. dropdown:: OPM amplitude spectrum (most recent session)

    .. raw:: html

        <iframe src="../_static/2-data-quality-dashboards/opm_fft_plot.html" width="100%" height="600px" frameborder="0"></iframe>

Metrics over time
-----------------

.. dropdown:: OPM median sensor RMS over time

    .. raw:: html

        <iframe src="../_static/2-data-quality-dashboards/opm_rms_plot.html" width="100%" height="600px" frameborder="0"></iframe>

.. dropdown:: OPM median noise floor over time

    .. raw:: html

        <iframe src="../_static/2-data-quality-dashboards/opm_noisefloor_plot.html" width="100%" height="600px" frameborder="0"></iframe>

.. dropdown:: OPM line noise (50 Hz) over time

    .. raw:: html

        <iframe src="../_static/2-data-quality-dashboards/opm_linenoise_plot.html" width="100%" height="600px" frameborder="0"></iframe>

.. dropdown:: OPM average, variance and maximum over time (legacy metrics)

    .. raw:: html

        <iframe src="../_static/2-data-quality-dashboards/opm_average_plot.html" width="100%" height="500px" frameborder="0"></iframe>
        <iframe src="../_static/2-data-quality-dashboards/opm_variance_plot.html" width="100%" height="500px" frameborder="0"></iframe>
        <iframe src="../_static/2-data-quality-dashboards/opm_max_plot.html" width="100%" height="500px" frameborder="0"></iframe>

.. note::

   The OPM figures populate on the first run of the empty-room dashboard GitHub Action. Until then this
   page shows placeholders.