Quick Reference Lists
=====================


Running Sequences
-----------------

.. autosummary::
    
    matipo.sequence.Sequence
    matipo.sequence.Sequence.setpar
    matipo.sequence.Sequence.loadpar
    matipo.sequence.Sequence.savepar
    matipo.sequence.Sequence.run
    matipo.sequence.Sequence.abort
    matipo.sequence.Sequence.data
    matipo.sequence.Sequence.par

System Control
--------------

.. autosummary::

    matipo.system_api.reset
    matipo.system_api.tempctrl_get_pars
    matipo.system_api.tempctrl_set_pars
    matipo.system_api.tempctrl_get_history
    matipo.system_api.tempctrl_amp_off
    matipo.system_api.tempctrl_amp_on
    matipo.system_api.gpo_write
    matipo.system_api.gpo_set
    matipo.system_api.gpo_clear
    matipo.system_api.pwm_set
    matipo.system_api.pwm_start
    matipo.system_api.pwm_stop

Utility Libraries
-----------------

.. autosummary::

    matipo.util.autophase
    matipo.util.decimation
    matipo.util.fft
    matipo.util.ilt
    matipo.util.dashboardapp
    matipo.util.plots
    matipo.util.stepper
    matipo.util.etl.deinterlace
    matipo.util.iomux

Experiment Library
------------------

.. autosummary::

    matipo.experiment.BaseExperiment
    matipo.experiment.plots
    matipo.experiment.models

Pulse Sequence Programming Libraries
------------------------------------

.. autosummary::

    matipo.hardware.sequence_inst
    matipo.datalayout
    matipo.util.pulseshape
    matipo.util.etl.sequence_format


Full Reference
==============

Sequence Class
--------------

.. autoclass:: matipo.sequence.Sequence
    :members: __init__, par, setpar, loadpar, savepar, fetch_data, data, run, abort

Sequence Parameter Definition Class
-----------------------------------

.. autoclass:: matipo.sequence_common.ParDef
    :members: __init__

Sequence Hardware Option Type
-----------------------------

.. autoclass:: matipo.sequence_common.Options

System Control Functions
------------------------

.. automodule:: matipo.system_api
    :members:
    :undoc-members:

IO Multiplex Control
--------------------

.. automodule:: matipo.util.iomux
    :members:
    :undoc-members:

Data Processing Utilities
-------------------------

.. automodule:: matipo.util.autophase
    :members:
    :undoc-members:

.. automodule:: matipo.util.decimation
    :members:
    :undoc-members:

.. automodule:: matipo.util.fft
    :members:
    :undoc-members:

.. automodule:: matipo.util.ilt
    :members:
    :undoc-members:

.. autofunction:: matipo.util.etl.deinterlace

Experiment Building Tools
-------------------------

.. autoclass:: matipo.experiment.BaseExperiment
    :members:

.. automodule:: matipo.experiment.plots
    :members: LinePlot, ScatterPlot, SignalPlot, SpectrumPlot, ComplexDataLinePlot, WobblePlot, ImagePlot, Image1DPlot
    :undoc-members:

.. automodule:: matipo.experiment.models
    :members:
    :undoc-members:

Dashboard App Utilities
-----------------------

.. automodule:: matipo.util.dashboardapp
    :members:
    :undoc-members:

.. automodule:: matipo.util.plots
    :members:
    :undoc-members:

Stepper Motor Control
---------------------

.. automodule:: matipo.util.stepper
    :members:
    :undoc-members:

Pulse Program Commands
----------------------

.. automodule:: matipo.hardware.sequence_inst
    :members:
    :undoc-members:

Pulse Program Data Layout Definition
------------------------------------

.. automodule:: matipo.datalayout
    :members: Acquisition, Repetitions, Scans, List
    :undoc-members:

Pulse Program Utilities
-----------------------

.. automodule:: matipo.util.pulseshape
    :members:
    :undoc-members:

.. autofunction:: matipo.util.etl.sequence_format