U f{j@srdZddlZddlZddlmZddlmZmZddlmZddl Z ddlm Z m Z ddl Z ddl Z ddlmZddlmZddlZddlZddlmZddlZddlZddlZddlZd d lmZd d lm Z d d lm!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+d d l,m-Z-d dl.m/Z/d dlm0Z0m1Z1m2Z2d dl3m4Z5d dl6m7Z7d dl8m9Z9d dl:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJmKZKd dlLmMZMmNZNmOZOmPZPmQZQmRZRmSZSmTZTmUZUd dlVmWZWmXZXd dlYmZZZm[Z[d dl\m]Z]d dl^m_Z_m`Z`d dlambZbmcZcd dldmeZed dlmfZfd dlgmhZhmiZid dljmkZkdZleme5nZogZpeoD]`Zqeprd eqeqd!kreprd"eqeprd#eqeprd$eqeprd%eqqhd&emepZs[pd'Zteeujvd(Zweeujvd)Zxewd*jyd+d,Zzewd-jyd+d,Z{d.Z|d/Z}d0d1Z~d2d3Zd4d5Zd6d7Zd8d9Zd:d;Zdd?Zd@dAZdBdCZdDdEZdFdGZdHdIZeGdJdKdKZeedLdMdNZdOdPZdQdRdSdTdUZdVdWZdXdYZdZd[Zd\d]Zd^d_Zd`daZdbdcZeeujdddedfZe edgZdhdiZdjdkZeCGdldmdmZdndoZdpdqZdrZdsZGdtdudueZdS)vz6Generate self-contained HTML reports from MNE objects.N) dataclass)TupleOptional)Sequence)BytesIOStringIO)Path)copyfile __version__)_compare_version) read_evokeds read_eventsread_covread_source_estimate read_transsys_infoEvokedSourceEstimate CovarianceInfo Transform) _get_ch_type)_handle_default)read_raw read_infoBaseRaw) supported_DATA_CH_TYPES_SPLIT) read_proj)_reorient_image_mri_orientation)loggerverboseget_subjects_dirwarn _ensure_intfill_doc _check_option_validate_type _safe_input _path_like use_log_level _check_fname_check_ch_locs_import_h5io_funcs) plot_eventsplot_alignmentplot_covplot_projs_topomapplot_compare_evokeds set_3d_viewget_3d_backendFigure3Duse_browser_backend)_plot_mri_contours_get_bem_plotting_surfaces)_ndarray_to_fig tight_layout)_mne_qt_browser_screenshot)read_forward_solutionForward) read_epochs BaseEpochs)read_ica)dig_mri_distances)read_inverse_operatorInverseOperator) parallel_func)axialsagittalcoronalraw)z.bdfz.edfz.setz.vhdrmegeegZieegnirs)zsss.fifz sss.fif.gzzeve.fifz eve.fif.gzzcov.fifz cov.fif.gzzproj.fifz prof.fif.gzz trans.fifz trans.fif.gzzfwd.fifz fwd.fif.gzzepo.fifz epo.fif.gzzinv.fifz inv.fif.gzzave.fifz ave.fif.gzT1.mgz) rLeventsepochszssp-projectorsevoked covariancecoregistrationbemforward-solutioninverse-operatorsource-estimateZ js_and_cssZ templatesz report.jsutf-8encodingz report.sassdiRcsfddtDS)Ncsg|]}|kr|qSr^).0ch_typeinstr^P/var/www/html/bwave/python/venv/lib/python3.8/site-packages/mne/report/report.py nsz!_get_ch_types..rrar^rarc _get_ch_typesmsrec Cs2ddlm}|d}|j|||||||d} | S)Nr report_templates_envzheader.html.jinja)langincludejscsstitletags mne_logo_imghtml_templatesrg get_templaterender) rhrirjrkrlrmrnrgt t_renderedr^r^rc_html_header_elementts  rucCs(ddlm}|d}|j||d}|S)Nr rfzfooter.html.jinja mne_versiondatero)rwrxrgrsrtr^r^rc_html_footer_element~s  rycCs*ddlm}|d}|j|||d}|S)Nr rfztoc.html.jinjatitlesdom_idsrmro)r{r|rmrgrsrtr^r^rc_html_toc_elements  r}cCs.ddlm}|d}|j|||||d}|S)Nr rfzforward.html.jinja)idreprsensitivity_mapsrmrlro)r~rrrlrmrgrsrtr^r^rc_html_forward_sol_elements  rcCs.ddlm}|d}|j|||||d}|S)Nr rfzinverse.html.jinja)r~r source_spacermrlro)r~rrrlrmrgrsrtr^r^rc_html_inverse_operator_elements  r)klassc CsZddlm}g} |D]} | dkr$d} | | q~|d} | j||| |||||d} | S)Nr rfrzslider.html.jinja)r~imagescaptionsrmrl start_idx image_formatr)rprgappendrqrr) r~rrrrrlrmrrgZ captions_captionrsrtr^r^rc_html_slider_elements&   rc Cs6ddlm} | d} | j|||||||||d } | S)Nr rfzimage.html.jinja) r~imgrrmrlr div_klass img_klassshowro) r~rrrrrrrlrmrgrsrtr^r^rc_html_image_elements  rcCs.ddlm}|d}|j|||||d}|S)Nr rfzcode.html.jinja)r~codelanguagerlrmro)r~rrrlrmrgrsrtr^r^rc_html_code_elements  rcCs.ddlm}|d}|j|||||d}|S)Nr rfzsection.html.jinja)r~rhtmlsrlrmro)r~rrrlrmrgrsrtr^r^rc_html_section_elements  rc Cs2ddlm}|d}|j|||||||d} | S)Nr rfzbem.html.jinja)r~rhtml_slider_axialhtml_slider_sagittalhtml_slider_coronalrlrmro) r~rrrrrlrmrgrsrtr^r^rc_html_bem_elements  rcCs.ddlm}|d}|j|||||d}|S)Nr rfzhtml.html.jinja)r~rhtmlrlrmro)r~rrrlrmrgrsrtr^r^rc _html_elements  rc@s>eZdZUeed<eeed<eed<eeed<eed<dS)_ContentElementnamesectiondom_idrmrN)__name__ __module__ __qualname__str__annotations__rrr^r^r^rcrs   r)returncCst|tr|f}n2t|ttjfr,t|}ntdt|d|dd|D}|rttdddd|Dd}g}|D]$}|D]}||kr| |qqq|rt d dd d |D|S) Nzntags must be a string (without spaces or special characters) or an array-like object of such strings, but got z instead: cSsg|]}t|ts|qSr^) isinstancerr_tagr^r^rcrds z_check_tags..z^All tags must be strings without spaces or special characters, but got the following instead: z, cSsg|] }t|qSr^)rrr^r^rcrds) " z1The following tags contained invalid characters: css|]}t|VqdSN)rrr^r^rc sz_check_tags..) rrrnpndarraytuple TypeErrortypejoinr ValueError)rmZbad_tagsZ invalid_charsrZ invalid_charr^r^rc _check_tagss0   rcCs$t|||d}||dS)acLimit the resolution (DPI) of a figure. Parameters ---------- fig : matplotlib.figure.Figure The figure whose DPI to adjust. max_width : int The max. allowed width, in pixels. max_res : int The max. allowed resolution, in DPI. Returns ------- Nothing, alters the figure's properties in-place. rN)minget_size_inchesset_dpi)fig max_widthmax_resdpir^r^rc_constrain_fig_resolutionsrpngTr own_figurec Csddlm}ddlm}t|tjrDt|}|r>t|t t dd}nt||rPn|j j dkrt |dd}t|j|||nft|trd d lm}m}|j|d |s|j|d }n td }|r|j|d ntd t|t|}|rt|t t dd}t}td| d|!dt"#*t"j$ddt%d|j&|||!dW5QRX|rz|'||(}|dkr|)dSt*+|)dS)z&Plot figure and create a binary image.rN)FigurerrT)Z MNEQtBrowserZPyQtGraphBrowserr) return_typer )backendMNE_3D_BACKEND_TESTINGfigurer r zzfigure must be an instance of np.ndarray, matplotlib Figure, mne_qt_browser.figure.MNEQtBrowser, or mne.viz.Figure3D, got zSaving figure with dimension z inches with z dpiignorez2.*Axes that are not compatible with tight_layout.*actionmessagecategory)formatrsvgrZascii),matplotlib.pyplotpyplotZmatplotlib.figurerrrrr=r MAX_IMG_WIDTH MAX_IMG_RES __class__rr?printshapemaxrmeanr9viz.backends.rendererrr_check_3d_figure_take_3d_screenshotzeros_close_3d_figurerrrr$debugrget_dpiwarningscatch_warningsfilterwarnings UserWarningsavefigclosegetvaluedecodebase64 b64encode) rrrpltrrrroutputr^r^rc _fig_to_img0sh            rcCst|}||||||ddl}|dkrF|d}nd|d }||jjD].}| }||}|dkrt d| |qb|j dS)zMagic scaling helper. Keeps font size and artist sizes constant 0.5 : current font - 4pt 2.0 : current font + 4pt This is a heuristic but it seems to work for most cases. rNr g?z?could not rescale matplotlib fonts, consider increasing "scale")floatset_size_inchesrrr matplotlibZfindobjtextTextZ get_fontsizerZ set_fontsizeZcanvasZdraw)rscaleZmplZsfactorrfsnew_sizer^r^rc_scale_mpl_figureqs   rc  sddlm} t} t| ddr&d| d<tt|fdt|i| \} }| fdd t||D} t } | D]}| |q|| S) zRender BEM surface contours on MRI slices. Returns ------- list of array A list of NumPy arrays that represent the generated Matplotlib figures. rr .) rr dictr rHr;lenr array_splitlistextend)sln_jobsrrrrrrrZ MPL_VERSIONkwargsparalleloutsoutor^rrc_get_bem_contour_figs_as_arrayss&      rc Ksddlm}ddlm}|r dnd}||dd}ddlm}zXz t||fd d |ii|WW8Stk rt||fd d |ii|YWSXW5||Xd S) z6Auxiliary function to iterate over views in trans fig.r )create_3d_figure)r)Pr) r)?rr)bgcolor)rrz head-denseheadN)vizrrrrr_itvIOError)functionalphar rrsizerrr^r^rc_iterate_trans_viewss$      (rc KsRddlm}m}ddlm}|fd|i|d}g}|D]H}|snt|f|d||||j|d} n t d} | | q:tj tj |dd d d tj |d dd d gd d }zHt |d |d|d|ddd} dt | ddt| dd} Wn:tk r<} zd} t| d| W5d} ~ XYnXt|dd} | | fS)Nr )rr) views_dictsr)ZfrontalZlateralZmedialrIZrostralrKZbothrrrr)axisrinfotranssubject subjects_dirr)r"r#r$r%Z on_defectszAverage distance from z digitized points to head: g@@z.2fz mmz7Distances could not be calculated from digitized points: r)r)rrrZviz._brain.viewr r7rrrrrZ concatenaterErr BaseExceptionr'r)rrr rrr viewsrviewZimdistsrerr^r^rcrs>    &$ rcsdddlm|dkr"ttj}fdd}t||t|d\}}|fdd|D}|S)zParallelize ICA component properties plotting, and return arrays. Returns ------- outs : list of array The properties plots as NumPy arrays. rNc s|j||dd}t|dks t|d}t|ttdt.}|j|ddd| dj |dd}W5QRX ||S) NF)rbpicksrrrrrrZ pad_inchesr) Zplot_propertiesrAssertionErrorrrriorrseekimreadr)icarbpickfigsrbuff fig_array)rr^rc_plot_one_ica_propertys$   z>_plot_ica_properties_as_arrays.._plot_one_ica_propertyfuncr rc3s|]}|dVqdS))r3rbr4Nr^)r_r4)r3rbrr^rcrs z1_plot_ica_properties_as_arrays..)rrr rangeZ n_components_rHr)r3rbr,r r8rrr^)r3rbrrrc_plot_ica_properties_as_arrayss   r<c Csjt|tr|g}|D]P}tD]F}|d||d||d||d||frdSqqdS)zBAux function to test if file name includes the specified suffixes.-_TF)rrSUPPORTED_READ_RAW_EXTENSIONSendswith)fnamesuffixessuffixextr^r^rc _endswiths   rEcKst|ddd}t|r~t\}}||dd}|D]4}||krNtd|||||kr6td|q6t}||n tf|}||_|S)aJRead a saved report or, if it doesn't exist yet, create a new one. The returned report can be used as a context manager, in which case any changes to the report are saved when exiting the context block. Parameters ---------- fname : str The file containing the report, stored in the HDF5 format. If the file does not exist yet, a new report is created that will be saved to the specified file. **params : kwargs When creating a new report, any named parameters other than ``fname`` are passed to the ``__init__`` function of the `Report` object. When reading an existing report, the parameters are checked with the loaded report and an exception is raised when they don't match. Returns ------- report : instance of Report The report. readF)rA overwrite must_exist mnepython)rlz%The loaded report has no attribute %szCAttribute '%s' of loaded report does not match the given parameter.) r/opexistsr1keysrReport __setstate__rA)rAparamsZ read_hdf5r>stateparamreportr^r^rc open_report's$      rSrZiconszmne_icon-cropped.pngrcCs"t|r|dkrtd|dS)z#Ensure valid scale value is passed.rzscale must be positive, not %sN)rZisscalarr)rr^r^rc _check_scale[srTcCs*|dks|dk r td|ddn|j}|S)zEnsure fmt is valid.Nr)rrgif)allowed_values)r*r)reprr^r^rc_check_image_formatas rXc @seZdZdZedddddZdd Zd d Zed d Z dddZ ddZ dddZ ddZ eddZeddZddZddZeddddd dd!d"d#Zeddddd$dddd%d&d'Zeddddd(ddd)d*d+Zedddd,ddd-d.d/Zeddd0dd1d2d3Zedddd4dd5d6d7Zedddd8dd9d:d;Zedd?Zedd@dAddBdCdDZedddEddFdGdHZdIdJZdKdLZdMdNZ dOdPZ!dQdRZ"dSdTZ#edddddddUddVdWdXZ$ddddYdZd[Z%edd\d]d^Z&d_d`Z'edadbddcdddeZ(edfdd=dgdhZ)didjZ*dkdlZ+edddmdddndodpZ,eddqdddrdsdtZ-edudd=dvdwZ.eddxdyddzdd{d|d}Z/d~dZ0dddddZ1edddZ2ddZ3eddddddddddd ddZ4ddZ5ddZ6edddddZ7ddZ8ddZ9eddZ:dxddydddZ;ddZddZ?ddZ@ddZAddZBddZCddZDddZEddZFddZGddZHddZIddZJddZKddZLddZMddZNddZOdd„ZPdydÜddńZQdS)rMa Object for rendering HTML. Parameters ---------- info_fname : None | str Name of the file containing the info dictionary. %(subjects_dir)s subject : str | None Subject name. title : str Title of the report. cov_fname : None | str Name of the file containing the noise covariance. %(baseline_report)s Defaults to ``None``, i.e. no baseline correction. image_format : 'png' | 'svg' | 'gif' Default image format to use (default is ``'png'``). ``'svg'`` uses vector graphics, so fidelity is higher but can increase file size and browser image rendering time as well. .. versionadded:: 0.15 raw_psd : bool | dict If True, include PSD plots for raw files. Can be False (default) to omit, True to plot, or a dict to pass as ``kwargs`` to :meth:`mne.io.Raw.plot_psd`. .. versionadded:: 0.17 projs : bool Whether to include topographic plots of SSP projectors, if present in the data. Defaults to ``False``. .. versionadded:: 0.21 %(verbose)s Attributes ---------- info_fname : None | str Name of the file containing the info dictionary. %(subjects_dir)s subject : str | None Subject name. title : str Title of the report. cov_fname : None | str Name of the file containing the noise covariance. %(baseline_report)s Defaults to ``None``, i.e. no baseline correction. image_format : str Default image format to use. .. versionadded:: 0.15 raw_psd : bool | dict If True, include PSD plots for raw files. Can be False (default) to omit, True to plot, or a dict to pass as ``kwargs`` to :meth:`mne.io.Raw.plot_psd`. .. versionadded:: 0.17 projs : bool Whether to include topographic plots of SSP projectors, if present in the data. Defaults to ``False``. .. versionadded:: 0.21 %(verbose)s html : list of str Contains items of html-page. include : list of str Dictionary containing elements included in head. fnames : list of str List of file names rendered. sections : list of str List of sections. lang : str language setting for the HTML file. Notes ----- See :ref:`tut-report` for an introduction to using ``mne.Report``. .. versionadded:: 0.8.0 NrFr%c  Cs|dk rt|nd|_|dk r&t|nd|_||_|dk rBt|}||_||_||_td||_ | |_ d|_ g|_ g|_ d|_t|tst|tstdt|f||_|d|_d|_dS)Nrzen-usz$raw_psd must be bool or dict, got %s)r info_fname cov_fnamebaseliner&r%r$rlrXrprojs_dom_id_contentrirhrboolrrrraw_psd _init_renderrA data_path) selfrZr%r$rlr[r\rrar]r%r^r^rc__init__s, zReport.__init__cCsdt|jd}|jdk r,|d|j7}dd|jD}t|dkrd|dd }d|d d}|d|7}|d 7}||7}n$t|d krd|}|d|7}|d 7}|S)zPrint useful info about report.z .rr z ... rz >)rr_rlr)rdrZcontent_element_namesZ first_entriesZ last_entriesentriesr^r^rc__repr__s     zReport.__repr__cCs t|jS)zReturn the number of files processed by the report. Returns ------- n_files : int The number of files processed. )rr_rdr^r^rc__len__szReport.__len__cCsdS)N)r\r[rir_rrZr^rar]r%r$rlrcrhrAr^r^r^r^rc_get_state_paramsszReport._get_state_paramsTcCs|r|jd7_d|jS)zGet unique ID for content to append to the DOM. This method is just a counter. increment : bool Whether to increment the counter. If ``False``, simply returns the latest DOM ID used. rzglobal-)r^)rd incrementr^r^rc _get_dom_ids zReport._get_dom_idcCs&t|tdfd|dkrtn|}|S)Ntopomap_kwargs)r+r)rdrrr^r^rc_validate_topomap_kwargsszReport._validate_topomap_kwargscCst|ttfs|g}t|ttfs(|g}t|ttfsD|dk rD|g}|dk rzt|t|krztdt|dt|n4|dk rt|t|krtdt|dt||||fS)zValidate input.NzUNumber of "comments" and report items must be equal, or comments should be None; got z and z9Number of "captions" and report items must be equal; got )rr rrr)rditemsrrcommentsr^r^rc_validate_inputszReport._validate_inputcsLg}g}g}g}g}|j}t|D]\}jrj|krDq&fdd||dD}dd|D} tttdd|D} |r|d} n |jdd} | d \} } | d t | d } | | t | | | jd d }| || | | j| | q&| j | j | j| jq&||||fS) aGenerate HTML representations based on the added content & sections. Returns ------- htmls : list of str The HTML representations of the content. dom_ids : list of str The DOM IDs corresponding to the HTML representations. titles : list of str The titles corresponding to the HTML representations. tags : list of tuple of str The tags corresponding to the HTML representations. csg|]}|jjkr|qSr^)rr_elcontent_elementr^rcrdLs z+Report._content_as_html..NcSsg|] }|jqSr^)rrwr^r^rcrdPscSsg|]}|jD]}|qqSr^rm)r_rxrsr^r^rcrdRsF)rpr=rr)r~rrmrlr)r_copy enumeraterrsortedsetrqsplitintrrrrrrm)rdZsection_dom_idsrr|r{rmZcontent_elementsidxZsection_elementsZ section_htmlsZ section_tagsZsection_dom_idlabelcounterZ section_htmlr^ryrc_content_as_html+sR               zReport._content_as_htmlcCs|\}}}}|S)z8A list of HTML representations for all content elements.)r)rdrr>r^r^rcrvsz Report.htmlcCs0g}|jD]}||jq ttt|}|S)z&All tags currently used in the report.)r_r rmrrr)rdrmcr^r^rcrm|s  z Report.tagscCsd|d}|j|7_dS)a7Add custom CSS to the report. Parameters ---------- css : str Style definitions to add to the report. The content of this string will be embedded between HTML ```` tags. Notes ----- .. versionadded:: 0.23 z Nri)rdrkstyler^r^rcadd_custom_csss zReport.add_custom_csscCsd|d}|j|7_dS)a=Add custom JavaScript to the report. Parameters ---------- js : str JavaScript code to add to the report. The content of this string will be embedded between HTML ```` tags. Notes ----- .. versionadded:: 0.23 z! Nr)rdrjscriptr^r^rc add_custom_jss zReport.add_custom_js)ZIGNORED)rR)psdr]rrdrop_log_ignorermreplacec Cs<t|}|dkr|jn|} |j||| |||||j|d dS)atAdd `~mne.Epochs` to the report. Parameters ---------- epochs : path-like | instance of Epochs The epochs to add to the report. title : str The title to add. psd : bool | float If a float, the duration of data to use for creation of PSD plots, in seconds. PSD will be calculated on as many epochs as required to cover at least this duration. Epochs will be picked across the entire time range in equally-spaced distance. .. note:: In rare edge cases, we may not be able to create a grid of equally-spaced epochs that cover the entire requested time range. In these situations, a warning will be emitted, informing you about the duration that's actually being used. If ``True``, add PSD plots based on all ``epochs``. If ``False``, do not add PSD plots. %(projs_report)s %(topomap_kwargs)s drop_log_ignore : array-like of str The drop reasons to ignore when creating the drop log bar plot. All epochs for which a drop reason listed here appears in ``epochs.drop_log`` will be excluded from the drop log plot. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 N) rRr add_projsrrrrrmrr)rr] _add_epochsr) rdrRrlrr]rrrrmrrr^r^rc add_epochss(zReport.add_epochs)rS)r{ noise_covr] n_time_pointsrmrrrr c s,t|tr|g}n,t|trn |} td| t| dd}jdk rZfdd|D}|dkrrdd|D}nt|tr|g}t|t|krt dt|d t|d |dkrj }|dk rt|t st |d }t |}|dkrjn|} t||D](\} } j| |j| ||| || |d qdS) uAdd `~mne.Evoked` objects to the report. Parameters ---------- evokeds : path-like | instance of Evoked | list of Evoked The evoked data to add to the report. Multiple `~mne.Evoked` objects – as returned from `mne.read_evokeds` – can be passed as a list. titles : str | list of str | None The titles corresponding to the evoked data. If ``None``, the content of ``evoked.comment`` from each evoked will be used as title. noise_cov : path-like | instance of Covariance | None A noise covariance matrix. If provided, will be used to whiten the ``evokeds``. If ``None``, will fall back to the ``cov_fname`` provided upon report creation. %(projs_report)s n_time_points : int | None The number of equidistant time points to render. If ``None``, will render each `~mne.Evoked` at 21 time points, unless the data contains fewer time points, in which case all will be rendered. %(tags_report)s %(replace_report)s %(topomap_kwargs)s %(n_jobs)s Notes ----- .. versionadded:: 0.24.0 zEvoked: Reading FrYNcsg|]}|jqSr^)r}Zapply_baseliner\r_r+rmr^rcrd sz&Report.add_evokeds..cSsg|] }|jqSr^)commentrr^r^rcrdszNumber of evoked objects (z!) must match number of captions ()rA) rSrrrrrmrrrr r)rrr r$rrr\rrrr[rrrr]zip _add_evokedr)rdevokedsr{rr]rrmrrrr Z evoked_fnamerrSrlr^rmrc add_evokedssL$       zReport.add_evokedsrL)rr] butterflyscalingsrmrrrc Csrt|}|dkr(|jdkr tn|j} n|dkr8t} nd} |dkrJ|jn|} |j|| | |||j|| ||d dS)auAdd `~mne.io.Raw` objects to the report. Parameters ---------- raw : path-like | instance of Raw The data to add to the report. title : str The title corresponding to the ``raw`` object. psd : bool | None Whether to add PSD plots. Overrides the ``raw_psd`` parameter passed when initializing the `~mne.Report`. If ``None``, use ``raw_psd`` from `~mne.Report` creation. %(projs_report)s butterfly : bool | int Whether to add butterfly plots of the data. Can be useful to spot problematic channels. If ``True``, 10 equally-spaced 1-second segments will be plotted. If an integer, specifies the number of 1-second segments to plot. Larger numbers may take a considerable amount of time if the data contains many sensors. You can disable butterfly plots altogether by passing ``False``. %(scalings)s %(tags_report)s %(replace_report)s %(topomap_kwargs)s Notes ----- .. versionadded:: 0.24.0 NTF) rLadd_psdrrbutterfly_scalingsrrmrrrr)rrarr]_add_rawr) rdrLrlrr]rrrmrrrrrr^r^rcadd_raw.s&"zReport.add_raw)rY)r$r%rrmrstc_plot_kwargsc Cs,t|}|j||||j||||d|d dS)aAdd a `~mne.SourceEstimate` (STC) to the report. Parameters ---------- stc : path-like | instance of SourceEstimate The `~mne.SourceEstimate` to add to the report. title : str The title to add. subject : str | None The name of the FreeSurfer subject the STC belongs to. The name is not stored with the STC data and therefore needs to be specified. If ``None``, will use the value of ``subject`` passed on report creation. subjects_dir : path-like | None The FreeSurfer ``SUBJECTS_DIR``. n_time_points : int | None The number of equidistant time points to render. If ``None``, will render ``stc`` at 51 time points, unless the data contains fewer time points, in which case all will be rendered. %(tags_report)s %(replace_report)s %(stc_plot_kwargs_report)s Notes ----- .. versionadded:: 0.24.0 N) stcrlrmrr$r%rrrr)r_add_stcr) rdrrlr$r%rrmrrr^r^rcadd_stchs!zReport.add_stc)rW)r$r%rmrc Cs(t|}|j|||||jd||ddS)a Add a forward solution. Parameters ---------- forward : instance of Forward | path-like The forward solution to add to the report. title : str The title corresponding to forward solution. subject : str | None The name of the FreeSurfer subject ``forward`` belongs to. If provided, the sensitivity maps of the forward solution will be visualized. If ``None``, will use the value of ``subject`` passed on report creation. If supplied, also pass ``subjects_dir``. subjects_dir : path-like | None The FreeSurfer ``SUBJECTS_DIR``. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 N)forwardr$r%rlrrrmr)r _add_forwardr)rdrrlr$r%rmrr^r^rc add_forwardszReport.add_forward)rX)r$r%r#rmrc CsRt|}|dk r|dks(|dk r0|dkr0td|j||||||jd||d dS)aAdd an inverse operator. Parameters ---------- inverse_operator : instance of InverseOperator | path-like The inverse operator to add to the report. title : str The title corresponding to the inverse operator object. subject : str | None The name of the FreeSurfer subject ``inverse_op`` belongs to. If provided, the source space the inverse solution is based on will be visualized. If ``None``, will use the value of ``subject`` passed on report creation. If supplied, also pass ``subjects_dir`` and ``trans``. subjects_dir : path-like | None The FreeSurfer ``SUBJECTS_DIR``. trans : path-like | instance of Transform | None The ``head -> MRI`` transformation for ``subject``. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 Nz*Please pass subject AND trans, or neither.) inverse_operatorr$r%r#rlrrrmr)rr_add_inverse_operatorr)rdrrlr$r%r#rmrr^r^rcadd_inverse_operators$zReport.add_inverse_operator)rU)r$r%rrmrc Cs(t|}|j||||||d||d dS)aBAdd a coregistration visualization to the report. Parameters ---------- trans : path-like | instance of Transform The ``head -> MRI`` transformation to render. info : path-like | instance of Info The `~mne.Info` corresponding to ``trans``. title : str The title to add. subject : str | None The name of the FreeSurfer subject the ``trans```` belong to. The name is not stored with the ``trans`` and therefore needs to be specified. If ``None``, will use the value of ``subject`` passed on report creation. subjects_dir : path-like | None The FreeSurfer ``SUBJECTS_DIR``. alpha : float | None The level of opacity to apply to the head surface. If a float, must be between 0 and 1 (inclusive), where 1 means fully opaque. If ``None``, will use the MNE-Python default value. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 N) r#r"r$r%rrlrrmr)r _add_trans) rdr#r"rlr$r%rrmrr^r^rc add_transs!zReport.add_trans)rT)rmrcCs$t|}|j|||j|||ddS)aAdd covariance to the report. Parameters ---------- cov : path-like | instance of Covariance The `~mne.Covariance` to add to the report. info : path-like | instance of Info The `~mne.Info` corresponding to ``cov``. title : str The title corresponding to the `~mne.Covariance` object. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 )covr"rrrmrN)r_add_covr)rdrr"rlrmrr^r^rcadd_covarianceszReport.add_covariancer)rQ)event_id first_samprmrc Cs*t|}|j|||||d|j||d dS)aAdd events to the report. Parameters ---------- events : path-like | array, shape (n_events, 3) An MNE-Python events array. title : str The title corresponding to the events. event_id : dict A dictionary mapping event names (keys) to event codes (values). sfreq : float The sampling frequency used while recording. first_samp : int The first sample point in the recording. This corresponds to ``raw.first_samp`` on files created with Elekta/Neuromag systems. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 N) rQrsfreqrrlrrrmr)r _add_eventsr)rdrQrlrrrrmrr^r^rc add_events3szReport.add_events)ssp)r]rrrmrc Cs(t|}|j||||jd|||ddS)aRender (SSP) projection vectors. Parameters ---------- info : instance of Info | path-like An `~mne.Info` structure or the path of a file containing one. This is required to create the topographic plots. projs : iterable of mne.Projection | path-like | None The projection vectors to add to the report. Can be the path to a file that will be loaded via `mne.read_proj`. If ``None``, the projectors are taken from ``info['projs']``. title : str The title corresponding to the `~mne.Projection` object. %(topomap_kwargs)s %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 Nr"r]rlrrrmrrr)r _add_projsr)rdr"r]rlrrrmrr^r^rcr[szReport.add_projsc Cs^t|tr|}n|}|j|dd}~t|dt|ttd|j|dd||||dddS)NFrbrrrzOriginal and cleaned signalTrrlrrrrmrr) rrZaverageZ plot_overlayr>rrr _add_figure) rdr3rbrrrmrZinst_rr^r^rc_add_ica_overlayzs*  zReport._add_ica_overlayc CsHt|jdd} t|j| dsrrrrrr) rdr3r,rrrmrr`rr5rrlr^r^rc_add_ica_componentssX      zReport._add_ica_componentsc  Cst|rt|}|jdkr"td|dkr,nt|rt|}t|dd}|drZd|d<ztf|}Wqtk rz t |}Wn$tk rtd|d YnXYqXn|j std t|rt |d d }t|rt |d d }|j |d | | | dd|r|j ||| | | | d|dk r<|j||d| | | | d|rZ|j||d| | | | d|dk r||j||d| | | | d|r|j||d| | | | d|j||| | | | d|r|j|||| | | | | ddS)NZunfittedz8ICA must be fitted before it can be added to the report.FrApreloadz.fifz.fif.gzyesallow_maxshieldzThe specified file, z-, does not seem to contain Raw data or EpochszYou passed an object to Report.add_ica() via the "inst" parameter that was not preloaded. Please preload the data via the load_data() methodr)rA conditionrr3rbrlrmrrr)r3rbrrrmrZECG)r3rrrrrmr)r3rbrrrrmrZEOG)r3r,rrrmr)r3r,rbr rrrmr)r-rDZ current_fit RuntimeErrorrrr@rrrBrr_add_html_reprrrrrr)rdr3rbr, ecg_evoked eog_evoked ecg_scores eog_scoresrlrrrmr rrAZ raw_kwargsr^r^rc_add_ica%s          zReport._add_ica)r3)r,rrrrr rmrc Cs2t| } |j|||||||||j| || | d dS)aAdd (a fitted) `~mne.preprocessing.ICA` to the report. Parameters ---------- ica : path-like | instance of mne.preprocessing.ICA The fitted ICA to add. title : str The title to add. inst : path-like | mne.io.Raw | mne.Epochs | None The data to use for visualization of the effects of ICA cleaning. To only plot the ICA component topographies, explicitly pass ``None``. %(picks_ica)s If ``None``, plot all components. This only affects the behavior of the component topography and properties plots. ecg_evoked, eog_evoked : path-line | mne.Evoked | None Evoked signal based on ECG and EOG epochs, respectively. If passed, will be used to visualize the effects of artifact rejection. ecg_scores, eog_scores : array of float | list of array of float | None The scores produced by :meth:`mne.preprocessing.ICA.find_bads_ecg` and :meth:`mne.preprocessing.ICA.find_bads_eog`, respectively. If passed, will be used to visualize the scoring for each ICA component. %(n_jobs)s %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 ) r3rbr,rrrrrlrrmrr rN)rrr) rdr3rlrbr,rrrrr rmrr^r^rcadd_icas $zReport.add_ica)rlrm remove_allcsgt|jD]<\}j|kr|dk r@tfdd|Ds@q|qsVdn8|sld|j=n"tfddt|jD|_S)a Remove elements from the report. The element to remove is searched for by its title. Optionally, tags may be specified as well to narrow down the search to elements that have the supplied tags. Parameters ---------- title : str The title of the element(s) to remove. .. versionadded:: 0.24.0 tags : array-like of str | str | None If supplied, restrict the operation to elements with the supplied tags. .. versionadded:: 0.24.0 remove_all : bool Controls the behavior if multiple elements match the search criteria. If ``False`` (default) only the element last added to the report will be removed. If ``True``, all matches will be removed. .. versionadded:: 0.24.0 Returns ------- removed_index : int | tuple of int | None The indices of the elements that were removed, or ``None`` if no element matched the search criteria. A tuple will always be returned if ``remove_all`` was set to ``True`` and at least one element was removed. .. versionchanged:: 0.24.0 Returns tuple if ``remove_all`` is ``True``. Nc3s|]}|jkVqdSrr{r_rs)rhr^rcrsz Report.remove..r|csg|]\}}|kr|qSr^r^)r_rr+) remove_idxr^rcrdsz!Report.remove..)r~r_rallrr)rdrlrmrrr^)rhrrcremoves $   z Report.remove)rc Cst|tstt|||||d}dd|jD}||kr~|r~t|jdddD]"\} } | j|krP||j| <dSqPtdn |j|dS)aeAppend HTML content report, or replace it if it already exists. Parameters ---------- name : str The entry under which the content shall be listed in the table of contents. If it already exists, the content will be replaced if ``replace`` is ``True`` %(section_report)s dom_id : str A unique element ``id`` in the DOM. tags : tuple of str The tags associated with the added element. html : str The HTML. replace : bool Whether to replace existing content. )rrrrmrcSsg|] }|jqSr^rfrgr^r^rcrdsz*Report._add_or_replace..Nr|zThis should never happen) rrr/rr_r~rrr) rdrrrrmrrZ new_contentZexisting_namesrrzr^r^rc_add_or_replaces     zReport._add_or_replacec CsJt|trt|}|}t|||||d}|j||||||ddS)N)rmrlr~rrrrrrmrr)rr read_textrqrr) rdrrlrrrmrrrr^r^rc _add_codes$  zReport._add_codepython)r)rrmrcCs*t|}|}|j|||d||ddS)aAdd a code snippet (e.g., an analysis script) to the report. Parameters ---------- code : str | pathlib.Path The code to add to the report as a string, or the path to a file as a `pathlib.Path` object. .. note:: Paths must be passed as `pathlib.Path` object, since strings will be treated as literal code. title : str The title corresponding to the code. language : str The programming language of ``code``. This will be used for syntax highlighting. Can be ``'auto'`` to try to auto-detect the language. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 N)rrlrrrmr)rlowerr)rdrrlrrmrr^r^rcadd_code4szReport.add_code)z mne-sysinfoc CsFt|}tt }tW5QRX|}|j||d||ddS)a|Add a MNE-Python system information to the report. This is a convenience method that captures the output of `mne.sys_info` and adds it to the report. Parameters ---------- title : str The title to assign. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 shell)rrlrrmrN)r contextlibredirect_stdoutrrrr)rdrlrmrfr"r^r^rc add_sys_infoVszReport.add_sys_infoc Cs<|}t|dd||d|||d } |j||||| |ddS)N custom-imageT) rrrrlrrrr~rmr)rqrr) rdrrlrrrmrrrrr^r^rc _add_imagess(zReport._add_imagec Cs*t|||d} |j| ||||||ddS)Nrrrrrlrrrmrr)rr) rdrrlrrrmrrrrr^r^rcrszReport._add_figure)z custom-figure)rrrmrrc Cst|}|dkr|j}t|dr6t|tjs6t|}n|f}|D]}t|r@td|q@~t|t rp|f} nP|dkrt |dkrdg} n4|dkrt |dkrddt t |D} nt|} ~|st t |dkr|j ||d| d||||dd n|j|d|| d|||d|d dS) aAdd figures to the report. Parameters ---------- fig : matplotlib.figure.Figure | Figure3D | array | array-like of matplotlib.figure.Figure | array-like of Figure3D | array-like of array One or more figures to add to the report. All figures must be an instance of :class:`matplotlib.figure.Figure`, :class:`mne.viz.Figure3D`, or :class:`numpy.ndarray`. If multiple figures are passed, they will be added as "slides" that can be navigated using buttons and a slider element. title : str The title corresponding to the figure(s). caption : str | array-like of str | None The caption(s) to add to the figure(s). %(image_format_report)s %(tags_report)s %(section_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 NrnzIt seems you passed a path to `add_figure`. However, only Matplotlib figures, PyVista scenes, and NumPy arrays are accepted. You may want to try `add_image` instead. The provided path was: rcSsg|]}d|dqS)zFigure rr^r_ir^r^rcrdsz%Report.add_figure..rF)rlrrrrrmrr) r5rrlrrrrrmrr)rrhasattrrrrrr-rrrr;r/rr) rdrrlrrrmrrr5rr^r^rc add_figuresX   zReport.add_figure)r)rrmrrc Csjt|}t|}t|d}~t|jdd} t d| dd|j |||| |||ddS)aAdd an image (e.g., PNG or JPEG pictures) to the report. Parameters ---------- image : path-like The image to add. title : str Title corresponding to the images. caption : str | None If not ``None``, the caption to add to the image. %(tags_report)s %(section_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 rrNz Image format)rrUr)valuerVr) rr expanduser read_bytesrrrrCrr*r) rdimagerlrrmrrZ img_bytesZ img_base64Z img_formatr^r^rc add_images"zReport.add_image) custom-htmlcCs<t|}|}t||||dd}|j||d|||ddS)a=Add HTML content to the report. Parameters ---------- html : str The HTML content to add. title : str The title corresponding to ``html``. %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 r)r~rrlrmrNr)rrqrr)rdrrlrmrrZ html_elementr^r^rcadd_htmls"zReport.add_htmlr i)rV)r%decimrr rmrc Cs4t|}t|d}|j||||||j|||d dS)aXRender a visualization of the boundary element model (BEM) surfaces. Parameters ---------- subject : str The FreeSurfer subject name. title : str The title corresponding to the BEM image. %(subjects_dir)s decim : int Use this decimation factor for generating MRI/BEM images (since it can be time consuming). width : int The width of the MRI images (in pixels). Larger values will have clearer surface lines, but will create larger HTML files. Typically a factor of 2 more than the number of MRI voxels along each dimension (typically 512, default) is reasonable. %(n_jobs)s %(tags_report)s %(replace_report)s Notes ----- .. versionadded:: 0.24.0 r) r$r%rr rrrrmrN)rr(_add_bemr) rdr$rlr%rrr rmrr^r^rcadd_bem%s zReport.add_bemc s|dk r|dk rtd|dk rPt|t|krPtdt|dt|dnP|dk rt|t|krtdt|dt|dn|rfdd|D}|} t| ||||||d} | | fS) Nz%Must only provide either figs or imgszNumber of captions (z*) must be equal to the number of figures (rz)) must be equal to the number of images (csg|]}t|dqS)r)r)r_rrr^rcrd_sz)Report._render_slider..)r~rlrrmrrrr)rrrqr) rdr5rrlrrrrmrrrrr^rrc_render_sliderLs4  zReport._render_sliderr)rrc  Cs:|j|||||||| | d \} } |j||| || | ddS)N) r5rrlrrrrmrrrrrrmrr)rr)rdr5rrlrrrrmrrrrrrr^r^rcros& zReport._add_sliderc Csddddddddd d d g }t}|D]b}td |t|}|jd d}|drj|d|dq$|dr$|d|dq$d||_dS)zInitialize the renderer.zjquery-3.6.0.min.jszbootstrap.bundle.min.jszbootstrap.min.cssz&bootstrap-table/bootstrap-table.min.jsz'bootstrap-table/bootstrap-table.min.cssz0bootstrap-table/bootstrap-table-copy-rows.min.jsz-bootstrap-table/bootstrap-table-export.min.jsz"bootstrap-table/tableExport.min.jsz+bootstrap-icons/bootstrap-icons.mne.min.csszhighlightjs/highlight.min.jsz,highlightjs/atom-one-dark-reasonable.min.cssz Embedding : rZr[z.jsz