Skip to content

Report generation

report_evoked_n_time_points module-attribute

Python
report_evoked_n_time_points: int | None = None

Specifies the number of time points to display for each evoked in the report. If None, it defaults to the current default in MNE-Python.

Example

Only display 5 time points per evoked

Python
report_evoked_n_time_points = 5

Pipeline steps using this setting

The following steps are directly affected by changes to report_evoked_n_time_points:

  • sensor/_01_make_evoked
  • sensor/_99_group_average

report_stc_n_time_points module-attribute

Python
report_stc_n_time_points: int | None = None

Specifies the number of time points to display for each source estimates in the report. If None, it defaults to the current default in MNE-Python.

Example

Only display 5 images per source estimate:

Python
report_stc_n_time_points = 5

Pipeline steps using this setting

The following steps are directly affected by changes to report_stc_n_time_points:

  • source/_05_make_inverse
  • source/_99_group_average

report_add_epochs_image_kwargs module-attribute

Python
report_add_epochs_image_kwargs: dict | None = None

Specifies the limits for the color scales of the epochs_image in the report. If None, it defaults to the current default in MNE-Python.

Example

Set vmin and vmax to the epochs rejection thresholds (with unit conversion):

Python
report_add_epochs_image_kwargs = {
    "grad": {"vmin": 0, "vmax": 1e13 * reject["grad"]},  # fT/cm
    "mag": {"vmin": 0, "vmax": 1e15 * reject["mag"]},  # fT
}
Pipeline steps using this setting

The following steps are directly affected by changes to report_add_epochs_image_kwargs:

  • preprocessing/_07_make_epochs
  • preprocessing/_09_ptp_reject