Skip to content

Commit

Permalink
Docstrings utils.plotting
Browse files Browse the repository at this point in the history
  • Loading branch information
JorisVincent committed Mar 23, 2023
1 parent 550a22e commit 24ea263
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions stimupy/utils/plotting.py
Expand Up @@ -7,15 +7,14 @@
from stimupy.utils import resolution

__all__ = [
"compare_plots",
"plot_stim",
"plot_stimuli",
"compare_plots",
]


def compare_plots(plots):
"""
Plot multiple plots in one plot for comparing.
"""Plot multiple plots in one plot for comparing.
Parameters
----------
Expand All @@ -41,8 +40,10 @@ def plot_stim(
save=None,
units="deg",
):
"""
Utility function to plot stimulus array (key: "img") from stim dict and mask (optional)
"""Plot a stimulus
Plots the stimulus-array (key: "img") directly from stim dict.
Optionally also plots mask.
Parameters
----------
Expand Down Expand Up @@ -164,8 +165,11 @@ def plot_stimuli(
save=None,
units="deg",
):
"""
Utility function to plot multuple stimuli (key: "img") from stim dicts and mask (optional)
"""Plot multiple stimuli
Plots the stimulus-arrays (keys: "img") directly from stim dicts.
Arranges stimuli in a grid.
Optionally also plots masks.
Parameters
----------
Expand Down

0 comments on commit 24ea263

Please sign in to comment.