Skip to content

Commit

Permalink
update API for updates here
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Mar 26, 2024
1 parent 9e7fb55 commit 5a561c7
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ The SpectralGroupModel object allows for parameterizing groups of power spectra.

SpectralGroupModel

Time & Event Objects
~~~~~~~~~~~~~~~~~~~~

The time & event objects allows for parameterizing power spectra organized across time and/or events.

.. autosummary::
:toctree: generated/

SpectralTimeModel
SpectralTimeEventModel

Object Utilities
~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -178,7 +189,7 @@ Code & utilities for simulating power spectra.
Generate Power Spectra
~~~~~~~~~~~~~~~~~~~~~~

Functions for simulating neural power spectra.
Functions for simulating neural power spectra and spectrograms.

.. currentmodule:: specparam.sim

Expand All @@ -187,6 +198,7 @@ Functions for simulating neural power spectra.

sim_power_spectrum
sim_group_power_spectra
sim_spectrogram

Manage Parameters
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -242,14 +254,15 @@ Visualizations.
Plot Power Spectra
~~~~~~~~~~~~~~~~~~

Plots for visualizing power spectra.
Plots for visualizing power spectra and spectrograms.

.. currentmodule:: specparam.plts

.. autosummary::
:toctree: generated/

plot_spectra
plot_spectrogram

Plots for plotting power spectra with shaded regions.

Expand Down Expand Up @@ -311,7 +324,21 @@ Note that these are the same plotting functions that can be called from the mode
.. autosummary::
:toctree: generated/

plot_group
plot_group_model

.. currentmodule:: specparam.plts.time

.. autosummary::
:toctree: generated/

plot_time_model

.. currentmodule:: specparam.plts.event

.. autosummary::
:toctree: generated/

plot_event_model

Annotated Plots
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -388,7 +415,9 @@ Input / Output (IO)
:toctree: generated/

load_model
load_group
load_group_model
load_time_model
load_event_model

Methods Reports
~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 5a561c7

Please sign in to comment.