.. include:: <isonum.txt>

Experiments subpackage
======================

An experiment is what a user (*i.e.*, a scientist) wants to perform in order to record data. This requires as a minimum a :doc:`setup <setups>` to connect to. Usually, it involves as well a kind of :doc:`display <displays>` presenting the data during recording, and one or several :doc:`saver <saver>` to store the obtained data in a persistent manner. The base class for experiments is :class:`+eprcontrol.+experiments.Experiment`. Every experiment should inherit from this class.

To test the interplay with other classes, :class:`+eprcontrol.+experiments.DummyExperiment` can be used. This class creates a set of testdata that get copied row-wise into the :attr:`data` attribute, mimicking a real experiment.


General usage
-------------

The :class:`+eprcontrol.+experiments.Experiment` class is the heart of the eprcontrol toolbox. A general usage may look like the following:

.. code:: matlab

   experiment = eprcontrol.experiments.Experiment;
   experiment.run()

Of course, in a real setting one would like to connect an instance of :class:`eprcontrol.+displays.Display` to present the data during their recording, as well as a list of different saver as instances of class :class:`eprcontrol.+saver.Saver`.


Classes
-------

.. toctree::
   :maxdepth: 1


.. automodule:: +eprcontrol.+experiments
    :members:
    :private-members: