mne.report.
Report
(info_fname=None, subjects_dir=None, subject=None, title=None, cov_fname=None, baseline=None, image_format='png', 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[, section]) |
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. |
save ([fname, open_browser, overwrite]) |
Save html report and 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)[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)[source]¶Append custom user-defined figures.
Parameters: |
|
---|
add_htmls_to_section
(htmls, captions, section='custom')[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)[source]¶Append custom user-defined images.
Parameters: |
|
---|
add_slider_to_section
(figs, captions=None, section='custom', title='Slider', scale=None, image_format=None)[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: |
|
---|