.. _diagnostics:

===========
Diagnostics
===========

The server creates ``.json`` files for each experiment to store its data (see :ref:`getting_started`).
These experiment files can be used for diagnostics by running ``ariane-tas-diagnostics``.

.. code-block:: shell-session

    ariane-tas-diagnostics [-h] [-f FILE] CMD [ARGS [ARGS ...]]

    Run ARIANE TAS diagnostics

    positional arguments:
        CMD                   command for diagnostics
        ARGS                  arguments for command

    optional arguments:
        -h, --help            show this help message and exit
        -f FILE, --file FILE  path to experiment file

If ``FILE`` is not specified, the last experiment file created from ``logs/`` is used.

Available commands
------------------

**Note:** Names of arguments do not need to be specified when calling ``ariane-tas-diagnostics``, just their values.

**Example:** ``ariane-tas-diagnostics compute_fwhm 1.5 2 2.5``

+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| Command                         | Arguments          | Description                                                                                                               |
+=================================+====================+===========================================================================================================================+
| ``compute_fwhm``                | * ``x1``           | Compute full width at half maximum (FWHM) along :math:`E` axes at specified locations on :math:`\mathbf{Q}` axes.         |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``x1: list of floats``                                                                                                  |
|                                 |                    | | Locations on :math:`\mathbf{Q}` axes at which to compute FWHM.                                                          |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``compute_heuris_experi_param`` | --                 | Heuristically compute experimental parameters (background level and intensity threshold) with initial measurement points. |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``create_video``                | * ``secs``         | Create a video of the experiment.                                                                                         |
|                                 | * ``with_path``    |                                                                                                                           |
|                                 |                    | | ``secs: float``                                                                                                         |
|                                 |                    | | Length of video in seconds                                                                                              |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``with_path: bool``, *optional*                                                                                         |
|                                 |                    | | Draw path of measurement points, default is ``False``                                                                   |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_counting_times``         | --                 | Plot counting times at measurement locations.                                                                             |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_ellipses``               | --                 | Plot ellipses around measurement and problem locations.                                                                   |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_evolution``              | * ``t``            | Plot the evolution of the experiment.                                                                                     |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``t: list of floats``                                                                                                   |
|                                 |                    | | Relative points in time from the unit interval at which to plot the corresponding measured intensity function,          |
|                                 |                    |   ``0.5`` and ``0.75`` correspond to half and, respectively, three quarters of the experimental time                      |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_gpr``                    | * ``num_meas_pts`` | Plot Gaussian Process Regression (GPR) of measurement points.                                                             |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``num_meas_pts: int``, *optional*                                                                                       |
|                                 |                    | | Number of measurement points used for GPR, default is the number of initial measurement points                          |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_initial_stats``          | * ``log``          | Plot initial statistics used for computing background level and intensity threshold.                                      |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``log: bool``, *optional*                                                                                               |
|                                 |                    | | Indicates whether intensites are to be scaled logarithmically, default is ``False``                                     |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_intens_dots``            | * ``vmax``         | Plot measured intensity function as colored dots.                                                                         |
|                                 | * ``log``          |                                                                                                                           |
|                                 |                    | | ``vmax: float``, *optional*                                                                                             |
|                                 |                    | | Maximum value for plotted intensities, default is ``thresh_intens``                                                     |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``log: bool``, *optional*                                                                                               |
|                                 |                    | | Indicates whether intensites are to be scaled logarithmically, default is ``False``                                     |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_intens_interp``          | * ``log``          | Plot measured intensity function as interpolation.                                                                        |
|                                 |                    |                                                                                                                           |
|                                 |                    | | ``log: bool``, *optional*                                                                                               |
|                                 |                    | | Indicates whether intensites are to be scaled logarithmically, default is ``False``                                     |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_locs``                   | --                 | Plot measurement locations.                                                                                               |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_monitor_cts``            | --                 | Plot monitor counts at measurement locations.                                                                             |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_travel_costs``           | --                 | Plot travel cost functions at locations stored.                                                                           |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``plot_travel_path``            | --                 | Plot travel path of measurement points.                                                                                   |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``print_metadata``              | --                 | Print metadata of the experiment.                                                                                         |
+---------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+