mne.
Report
(info_fname=None, subjects_dir=None, subject=None, title=None, cov_fname=None, baseline=None, image_format='png', raw_psd=False, verbose=None)[source]¶Object for rendering HTML.
Parameters: |
|
---|
Notes
To toggle the show/hide state of all sections in the html report, press ‘t’
New in version 0.8.0.
Methods
__hash__ ($self, /) |
Return hash(self). |
__len__ () |
Return the number of items in report. |
add_bem_to_section (subject[, caption, …]) |
Render a bem slider html str. |
add_figs_to_section (figs, captions[, …]) |
Append custom user-defined figures. |
add_htmls_to_section (htmls, captions[, …]) |
Append htmls to the report. |
add_images_to_section (fnames, captions[, …]) |
Append custom user-defined images. |
add_slider_to_section (figs[, captions, …]) |
Render a slider of figs to the report. |
parse_folder (data_path[, pattern, n_jobs, …]) |
Render all the files in the folder. |
remove (caption[, section]) |
Remove a figure from the report. |
save ([fname, open_browser, overwrite]) |
Save the report and optionally open it in browser. |
__hash__
($self, /)¶Return hash(self).
add_bem_to_section
(subject, caption='BEM', section='bem', decim=2, n_jobs=1, subjects_dir=None, replace=False)[source]¶Render a bem slider html str.
Parameters: |
|
---|
Notes
New in version 0.9.0.
add_figs_to_section
(figs, captions, section='custom', scale=None, image_format=None, comments=None, replace=False)[source]¶Append custom user-defined figures.
Parameters: |
|
---|
add_htmls_to_section
(htmls, captions, section='custom', replace=False)[source]¶Append htmls to the report.
Parameters: |
|
---|
Notes
New in version 0.9.0.
add_images_to_section
(fnames, captions, scale=None, section='custom', comments=None, replace=False)[source]¶Append custom user-defined images.
Parameters: |
|
---|
add_slider_to_section
(figs, captions=None, section='custom', title='Slider', scale=None, image_format=None, replace=False)[source]¶Render a slider of figs to the report.
Parameters: |
|
---|
Notes
New in version 0.10.0.
parse_folder
(data_path, pattern='*.fif', n_jobs=1, mri_decim=2, sort_sections=True, on_error='warn', image_format=None, render_bem=True, verbose=None)[source]¶Render all the files in the folder.
Parameters: |
|
---|
remove
(caption, section=None)[source]¶Remove a figure from the report.
The figure to remove is searched for by its caption. When searching by caption, the section label can be specified as well to narrow down the search. If multiple figures match the search criteria, the last one will be removed.
Any empty sections will be removed as well.
Parameters: |
|
---|---|
Returns: |
|
save
(fname=None, open_browser=True, overwrite=False)[source]¶Save the report and optionally open it in browser.
Parameters: |
|
---|---|
Returns: |
|