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.par
    matipo.sequence.Sequence.data
    matipo.sequence.Sequence.data_map
    matipo.sequence.Sequence.data_count

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

.. autosummary::

    matipo.hardware.sequence_inst.SequencerTop
    matipo.hardware.sequence_inst.RFTX
    matipo.hardware.sequence_inst.ACQ
    matipo.hardware.sequence_inst.GRAD
    matipo.hardware.sequence_inst.SHIM
    matipo.hardware.sequence_inst.GPO
    matipo.util.pulseshape
    matipo.util.etl.sequence_format
    matipo.sequence.ParDef
    matipo.sequence.floatarray

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

.. autosummary::

    matipo.system_api.SystemAPI
    matipo.system_api.SystemAPI.reset
    matipo.system_api.SystemAPI.poweroff
    matipo.system_api.SystemAPI.get_input_calibration
    matipo.system_api.SystemAPI.set_input_calibration
    .. matipo.system_api.SystemAPI.tempctrl_get_config
    .. matipo.system_api.SystemAPI.tempctrl_get_temperature
    .. matipo.system_api.SystemAPI.tempctrl_get_pwm_duty
    .. matipo.system_api.SystemAPI.tempctrl_get_history
    .. matipo.system_api.SystemAPI.tempctrl_get_pwm_history
    .. matipo.system_api.SystemAPI.tempctrl_setpoint
    .. matipo.system_api.SystemAPI.tempctrl_set_pwm_period
    .. matipo.system_api.SystemAPI.tempctrl_set_pwm_override
    .. matipo.system_api.SystemAPI.tempctrl_set_PID
    .. matipo.system_api.SystemAPI.tempctrl_enable_PID

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

.. autosummary::

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

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

.. autosummary::

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

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

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

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

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

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

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

.. autoclass:: matipo.hardware.sequence_inst.SequencerTop
    :members: wait, join

.. automodule:: matipo.hardware.sequence_inst
    :members: RFTX, ACQ, GRAD, SHIM, GPO

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

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

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

.. autoclass:: matipo.sequence.ParDef

.. autofunction:: matipo.sequence.floatarray

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

.. autoclass:: matipo.system_api.SystemAPI
    :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: