sim_tools.plot_sim

sim_tools.plot_sim(fname, names='all', raw=True, bold=False, figname=None)[source]

Plot a simulation generated by run_model

Parameters:

fname : str

File-name (including path if not in working directory) of HDF5 container that was generated by run_model.

names : str or Python list/NumPy 1darray

Specify regions to plot. Either use the region’s name as found in the params group of the HDF5 container given by fname (e.g., names=’L_IFG’) or its index in the names list (e.g., names = 3). Use a list or NumPy 1darray to specify more than one region (e.g., names = [‘L_IFG’,’R_IFG’] or names = [3,15]). By default, all regions are plotted.

raw : bool

If True then the raw model output will be plotted. Depending on the setting of names (see above) the simulation length, and the model dimension (i.e., the number of modeled regions) this may result in a very ‘busy’ plot.

bold : bool

If True then the previously converted simulated BOLD signals will be plotted (if no BOLD signal is found in the input container specified by fname, an error is raised).

figname : str

String to be used as window title for generated figures.

Returns:

Nothing : None

See also

run_model
used to run a simulation
make_bold
convert raw simulation output to a BOLD signal

Notes

None