Skip to content

Commit 5a561c7

Browse files
committed
update API for updates here
1 parent 9e7fb55 commit 5a561c7

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

doc/api.rst

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ The SpectralGroupModel object allows for parameterizing groups of power spectra.
4040

4141
SpectralGroupModel
4242

43+
Time & Event Objects
44+
~~~~~~~~~~~~~~~~~~~~
45+
46+
The time & event objects allows for parameterizing power spectra organized across time and/or events.
47+
48+
.. autosummary::
49+
:toctree: generated/
50+
51+
SpectralTimeModel
52+
SpectralTimeEventModel
53+
4354
Object Utilities
4455
~~~~~~~~~~~~~~~~
4556

@@ -178,7 +189,7 @@ Code & utilities for simulating power spectra.
178189
Generate Power Spectra
179190
~~~~~~~~~~~~~~~~~~~~~~
180191

181-
Functions for simulating neural power spectra.
192+
Functions for simulating neural power spectra and spectrograms.
182193

183194
.. currentmodule:: specparam.sim
184195

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

188199
sim_power_spectrum
189200
sim_group_power_spectra
201+
sim_spectrogram
190202

191203
Manage Parameters
192204
~~~~~~~~~~~~~~~~~
@@ -242,14 +254,15 @@ Visualizations.
242254
Plot Power Spectra
243255
~~~~~~~~~~~~~~~~~~
244256

245-
Plots for visualizing power spectra.
257+
Plots for visualizing power spectra and spectrograms.
246258

247259
.. currentmodule:: specparam.plts
248260

249261
.. autosummary::
250262
:toctree: generated/
251263

252264
plot_spectra
265+
plot_spectrogram
253266

254267
Plots for plotting power spectra with shaded regions.
255268

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

314-
plot_group
327+
plot_group_model
328+
329+
.. currentmodule:: specparam.plts.time
330+
331+
.. autosummary::
332+
:toctree: generated/
333+
334+
plot_time_model
335+
336+
.. currentmodule:: specparam.plts.event
337+
338+
.. autosummary::
339+
:toctree: generated/
340+
341+
plot_event_model
315342

316343
Annotated Plots
317344
~~~~~~~~~~~~~~~
@@ -388,7 +415,9 @@ Input / Output (IO)
388415
:toctree: generated/
389416

390417
load_model
391-
load_group
418+
load_group_model
419+
load_time_model
420+
load_event_model
392421

393422
Methods Reports
394423
~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)