microcalorimetry.measurements
=============================

.. py:module:: microcalorimetry.measurements

.. autoapi-nested-parse::

   
   The measurements submodule contains functions for interacting with specific measurements.

   Each submodule within contains, at minimum, three functions for a particular measurment.

   * runners: Take in a configuration file and perform a measurement
   * parsers: Take in raw data and outputs data with uncertainties and measurement review charts for further processing.

   Additional methods may be provided depending on the measurement.















   ..
       !! processed by numpydoc !!


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/microcalorimetry/measurements/dcsweep/index
   /autoapi/microcalorimetry/measurements/rfsweep/index


Functions
---------

.. autoapisummary::

   microcalorimetry.measurements.view


Package Contents
----------------

.. py:function:: view(data_record: microcalorimetry._tkquick.gui_dtypes.Folder, include_columns: list[str] = ['*'], time_units: str = 'datetime', relative_time: bool = False) -> tuple[matplotlib.pyplot.Figure]

   
   Generic functio that plots columns in a data record.

   :param data_record: Path to the metadata file of an active experiment
   :type data_record: Folder
   :param include_columns: Columns to include with glob patterns. Leave as ['*']
                           to include all. The default is ['*']
   :type include_columns: list[str]
   :param time_units: Options Format
                      --------------
                      {
                      seconds
                          plot in seconds
                      hours
                          plot in hours
                      datetime
                          plot in datetime
                      }
   :type time_units: str, optional
   :param relative_time: Use time since start of record instead of
                         absolute time as the x axis.
   :type relative_time: bool, optional

   :returns: **figures** -- Tuple of output figures.
   :rtype: tuple[Figure]















   ..
       !! processed by numpydoc !!