glmdenoise.report module

class glmdenoise.report.Report[source]

Bases: object

Html report and figures

add_image(figure, title)[source]

Add html for a figure

Parameters:name (str) – Name of figure
add_toc()[source]

Add table of contents (list with links) to top of report

plot_gif(titles, title)[source]
plot_hrf(hrf1, hrf2, tr=2.0, title='Hemodynamic Reponse Function')[source]

Line plot of initial and estimated HRF

Parameters:
  • hrf1 (ndarray) – hrf vector (1D)
  • hrf2 (ndarray) – another hrf vector (1D)
  • tr (float, optional) – Repetition time. Defaults to 2.0
  • title (str, optional) – Defaults to ‘Hemodynamic Reponse Function’.
plot_image(imgvector, title='no title', dtype='mask', drange=None)[source]

Plot slices of a 3D image in a grid.

Uses the spatial dimensions set on the report instance. (Report.spatialdims)

Parameters:
  • imgvector (ndarray) – Voxel values in a vector (1D)
  • title (str, optional) – Name of the plot. Defaults to ‘no title’.
  • dtype (str, optional) – How to scale the data. Defaults to ‘mask’.
plot_noise_regressors_cutoff(r2, n_noise_regressors, title)[source]

Line plot of model fit by number of noise regressors used

Parameters:
  • r2 (ndarray) – r-squared value for model fit for each number of regressors included(1D)
  • n_noise_regressors (int) – The number of regressors chosen
  • title (str) – Name of plot
plot_scatter_sparse(data, xlabel, ylabel, title, crosshairs=False)[source]

Scatter plot using max 1000 points for each series

Parameters:
  • data (list) – List of (x, y) tuple data series
  • xlabel (str) – Label on x-axis
  • ylabel (str) – Label on y-axis
  • title (str) – Name of plot
  • crosshairs (bool, optional) – Display horizontal and vertical lines through 0. Defaults to False.
save()[source]

Add title etc then save html to file

use_output(output)[source]