U f{js@sdZddlmZddlmZddlmZddlZddlZddl m Z ddl m Z ddlZddlZddlZddlZddlZddlmZmZd d lmZmZmZdd dddZdddZddddddZddZdddZddZ d d!Z!d"d#Z"d$d%Z#d&d'Z$eddd)d*d+Z%dd,d-d.d/d0Z&d1d2Z'dd4d5Z(dd6d7Z)dd8d9Z*dd:d;Z+ddd?Z-dd@dAZ.dBdCZ/ddDdEZ0ddFdGZ1dHdIZ2GdJdKdKe3Z4e4Z5e6e ej7fZ8GdLdMdMe3Z9e6fej:e;e5fe8e5fe9fdNZ
ddTdUZ?ddVdWZ@dXdYZAdZd[ZBd\d]ZCdd^d_ZDddadbZEdcddZFddedfZGdgdhZHddjdkZIdldmZJddodpZKddqdrdsZLddudvZMdwdxZNddzd{ZOdd}d~ZPdddZQdddddZRddZSdddddZTdS)zThe check functions.)input)get_close_matches) import_moduleN)Path)_median_complex_compare_version)warnloggerverboseunknownan int)extrac Csn|rd|n|}z"t|tr$ttt|}Wn4tk rht|d||dt|YnX|S)z Ensure a variable is an integer. z must be , got ) isinstancebool TypeErrorintoperatorindextype)xnameZmust_berrN/var/www/html/bwave/python/venv/lib/python3.8/site-packages/mne/utils/check.py _ensure_ints &rrcCst|ddt|}t|dkr\||s\dd|dd|dg}td|||fdd|dd|dg}||std |||fdS) a>Enforce MNE filename conventions. Parameters ---------- fname : str Name of the file. filetype : str Type of file. e.g., ICA, Epochs etc. endings : tuple Acceptable endings for the filename. endings_err : tuple Obligatory possible endings for the filename. path-likefnamer or , Nz3The filename (%s) for file type %s must end with %sz^This filename (%s) does not conform to MNE naming conventions. All %s files should end with %s)_validate_typestrlenendswithjoinIOErrorr )r ZfiletypeZendingsZ endings_errZ print_endingsrrr check_fname)s   r*0.0TF)stripreturn_versionc Csd}d}z t|}Wntk r,d}Yn@X|o8|dk}|p@|}|rX|j}|rXt|}|rlt|d|rld}|rx||fn|}|S)aCheck minimum library version required. Parameters ---------- library : str The library name to import. Must have a ``__version__`` property. min_version : str The minimum version string. Anything that matches ``'(\d+ | [a-z]+ | \.)'``. Can also be empty to skip version check (just check for library presence). strip : bool If True (default), then PEP440 development markers like ``.devN`` will be stripped from the version. This makes it so that ``check_version('mne', '1.1')`` will be ``True`` even when on version ``'1.1.dev0'`` (prerelease/dev version). This option is provided for backward compatibility with the behavior of ``LooseVersion``, and diverges from how modern parsing in ``packaging.version.parse`` works. .. versionadded:: 1.0 return_version : bool If True (default False), also return the version (can be None if the library is missing). .. versionadded:: 1.0 Returns ------- ok : bool True if the library exists with at least the specified version. version : str | None The version. Only returned when ``return_version=True``. TNFr+<)r ImportError __version__ _strip_devr) Zlibrary min_versionr,r-okversion check_version get_versionoutrrrr5Es""    r5cCs(d}t||}|dk r$|dS|S)Nz5^([0-9]+(?:\.[0-9]+)*)\.?(?:dev|rc|\+)[0-9+a-g\.\-]+$r)rematchgroups)r4expr9rrrr1{s r1c Cslt||dd\}}|sh|dkr*d|dnd}|dkr:dn d t|}td |d |d |d |dS)zRequire library for a purpose.T)r-r+z (version >= )rNzpackage was not foundzgot zThe z packagez is required to r")r5reprr/)libwhatr4r3gotrwhyrrr_require_versions rBcCstddddl}|S)Nh5pyzread MATLAB files >= v7.3r)rBrC)rCrrr _import_h5pys rDcCstdd}|j|jfS)Nh5iozHDF5-based I/O) _soft_importZ read_hdf5Z write_hdf5)rErrr_import_h5io_funcss rGcCstd|}|jS)N pymatreader)rFZread_mat)purposerHrrr_import_pymatreader_funcss rJcCs|dks|tjkrtjjjSt|ttjfr:tjj|St|tjjjrN|Szt|tjjrd|WSWnt k rzYnXt d|dS)a5Turn seed into a numpy.random.mtrand.RandomState instance. If seed is None, return the RandomState singleton used by np.random.mtrand. If seed is an int, return a new RandomState instance seeded with seed. If seed is already a RandomState instance, return it. Otherwise raise ValueError. NzD%r cannot be used to seed a numpy.random.mtrand.RandomState instance) nprandomZmtrandZ_randrrintegerZ RandomState GeneratorAttributeError ValueError)seedrrrcheck_random_states  rRcCs|dkr"tt|dddf}t|trZ|D]}t|tdq4dd|D}nLt|trddt |D}tt dd |D|}nt |d }t||i}|S) z-Check event_id and convert to default format.Nrz Event namescSs i|]\}}|t|d|qSz event_id[%s]r).0keyvalrrr sz#_check_event_id..cSsg|]\}}t|d|qSrSrT)rUvivrrr sz#_check_event_id..css|]}t|VqdSN)r%)rUirrr sz"_check_event_id..event_id) listrKuniquerdictkeysr$r%items enumeratezipr)r_eventsrVrrr_check_event_ids      rhFiler cCst|d|tt|}t|r|s8tdn|dkrJt d|r|rrt |st d|d|nt |st d|d|t |t jst|d |n|rt|d ||S) zACheck for file existence, and return string of its absolute path.rzQDestination file exists. Please use option "overwrite=True" to force overwriting.readzOverwriting existing file.zNeed a directory for z but found a file at zNeed a file for z but found a directory at z! does not have read permissions: z does not exist: )r$r%r expanduserabsoluteopexistsFileExistsErrorr infoisdirr)isfileosaccessR_OKPermissionErrorFileNotFoundError)r overwriteZ must_existrneed_dirr rrr _check_fnames4       r{zclass subject attributez input subject) raise_error first_kind second_kindc Cs|dk rLt|dd|dk rH||krHt|dt|d|d|d|S|dk rpt|dd|d||S|d krtd |d |d dS) zGet subject name from class.Nr%z subject inputz (z) did not match r<zEither z subject or TzNeither z subject nor z was a string)r$rPr=)firstsecondr|r}r~rrr_check_subjects" rcCshddlm}ddlm}ddlm}t|||fr4n0t||rBdnd}|jsdtd|d||fd S) zEnsure data are preloaded.r) BaseEpochs)Evoked)_BaseTFRepochsrawzKBy default, MNE does not load data into main memory to conserve resources. zb requires %s data to be loaded. Use preload=True (or string) in the constructor or %s.load_data().N) rrZevokedrZtime_frequencyrrZpreload RuntimeError)instmsgrrrrrrr_check_preloads    rdatac Csddlm}ddlm}m}ddlm}||fD]$} | dkrBdSt| |s0t| q0|dk r| }| }||fD]D} | dr| g| d<W5QRX|| d|} || | dd qv||pd } ||pd } | | krt d || || fdS) z1Ensure that objects have same compensation_grade.rInfo) pick_channels pick_info)get_current_compNcompsch_namesF)copyrz6Compensation grade of %s (%s) and %s (%s) do not match) iorio.pickrrZio.compensatorrrAssertionErrorrZ_unlockr) Zinfo1Zinfo2Zname1Zname2rrrrrZt_infopicksZgrade1Zgrade2rrr_check_compensation_grade!s0        rc Csdd}tddddddd d d ||}zt|}|WSttfk r|rtd |d |ddd|d|d|d|d|dfnYdSYnXdS)aImport soft dependencies, providing informative errors on failure. Parameters ---------- name : str Name of the module to be imported. For example, 'pandas'. purpose : str A very brief statement (formulated as a noun phrase) explaining what functionality the package provides to MNE-Python. strict : bool Whether to raise an error if module import fails. cSs|t|dS)N)rjustr&)rrrrindentPsz_soft_import..indentz scikit-learnz EDFlib-Pythonzmne-bidszmne-nirsz mne-featureszmne-qt-browserzmne-connectivityZ pyvistaqt)ZsklearnEDFlibZmne_bidsZmne_nirsZ mne_featuresZmne_qt_browserZmne_connectivityZpyvistazFor z to work, the z module is needed, zbut it could not be imported.  zGuse the following installation method appropriate for your environment:z 'pip install 'z'conda install -c conda-forge FN)rbgetrr/ModuleNotFoundErrorrr()rrIstrictrZpip_namemodrrrrFBs<   rFcCstdd|dS) Aux function.Zpandaszdataframe integrationrrFrrrr_check_pandas_installedosrcCstdd|dS)rZeeglabiozexporting to EEGLabrrrrrr_check_eeglabio_installedtsrcCstdd|dS)rrzexporting to EDFrrrrrr_check_edflib_installedysrcCstdd|dS)rZpybvzexporting to BrainVisionrrrrrr_check_pybv_installed~srcCstdd|dS)rrHzloading v7.3 (HDF5) .MAT filesrrrrrr_check_pymatreader_installeds rcCs|dkr dSt|tr|g}t|ts8tdt|t|t|}|r~dtt|dk}t dd ||d ||S)zCheck pandas index arguments.NzAindex must be `None` or a string or list of strings, got type {}.)zis not a valid optionzare not valid optionsr z."{}" {}. Valid index options are `None`, "{}".", ") rr%r`rformatrsetrr&rPr()rvalidinvalidpluralrrr_check_pandas_index_argumentss&  rcCsJ||kr*|dk r*d|}td|||dkrF|dkrFtdd}|S)zCheck time_format argument.NrzA"{}" is not a valid time format. Valid options are "{}" and None.datetimezYCannot convert to Datetime when raw.info['meas_date'] is None. Falling back to Timedelta. timedelta)r(rPrr ) time_formatrZ meas_dateZ valid_strrrr_check_time_formats rcCsddlm}m}|dk r(|dk r(td|dk r>|||d}n"|dk r`||||d}|||d}|d}tdd |D}|d kpt|pt|d  S) aCheck if channel locations exist. Parameters ---------- info : Info | None `~mne.Info` instance. picks : list of int Channel indices to consider. If provided, ``ch_type`` must be ``None``. ch_type : str | None The channel type to restrict the check to. If ``None``, check all channel types. If provided, ``picks`` must be ``None``. r) _picks_to_idxrNz1Either picks or ch_type may be provided, not both)rqsel)rqrnonechscSsg|]}|dddqS)locNrrUchrrrr[sz"_check_ch_locs..r) rrrrPrKarrayallisfiniteZallclose)rqrZch_typerrrZlocs3drrr_check_ch_locss    rcCs t|tjSr\)rnumbersNumber)nrrr _is_numericsrc@seZdZeddZdS)_IntLikecCs,z t|Wntk r"YdSXdSdS)NFT)rrclsotherrrr__instancecheck__s  z_IntLike.__instancecheck__N__name__ __module__ __qualname__ classmethodrrrrrrsrc@seZdZeddZdS) _CallablecCst|Sr\)callablerrrrrsz_Callable.__instancecheck__Nrrrrrrsr)r%numericrzint-likercCs|dkrt|||ddS|dkr.ddlm}t|ttfsB|g}tdd|Dd }|rdd |n|}t||s|dkrd d |D}t|d kr|d}n2t|dkrd|}nd|d|d<d|}|dkrdn|}t |d||dt |ddS)aValidate that `item` is an instance of `types`. Parameters ---------- item : object The thing to be checked. types : type | str | tuple of types | tuple of str The types to be checked against. If str, must be one of {'int', 'int-like', 'str', 'numeric', 'info', 'path-like', 'callable'}. If a tuple of str is passed, use 'int-like' and not 'int' for integers. item_name : str | None Name of the item to show inside the error message. type_name : str | None Possible types to show inside the error message that the checked item can be. extra : str Extra text to append to the warning. r)rrNrqrrcss8|]0}|dkrtdfnt|ts(|fnt|VqdSr\)rrr%_multi)rUtype_rrrr^ s z!_validate_type..rrcSs,g|]$}|dkrdnt|ts$|jn|qS)NNone)rr%r)rUZcls_rrrr[s  z"_validate_type..r rr!zor r#r"ZItemz must be an instance of rz instead.) rZmne.iorrr`tuplesumr&r(rr)itemtypesZ item_name type_namerZ check_typesZ _item_namerrrr$s8       r$cCs.zt|ddWdStk r(YdSXdS)zValidate that `item` is `path-like`. Parameters ---------- item : object The thing to be checked. Returns ------- bool ``True`` if `item` is a `path-like` object; ``False`` otherwise. r)rTFN)r$r)rrrr _path_like#s  r to be plottedcCs t|std|dS)z#Raise if any of the values are NaN.zSome of the values {} are NaN.N)rKrrrPr)rrrrr _check_if_nan7srcs4ddlm}|dd}td|d}|dddfd d Dfd d |D}|d k rtdt|dkrtt||dd krtd|d k rtdt|dkrtt||dd krtd|d k rt||j|d}|d k rt||j|d}fdd |D}|S)zEReturn good channels common to forward model and covariance matrices.r) pick_typesrqrbadsFT)ZmegZref_megcsg|]}d|qSrrrrqrrr[Hsz#_check_info_inv..csg|]}|kr|qSrrr)ref_chsrrr[IsNrzQinfo["bads"] and data_cov["bads"] do not match, excluding bad channels from both.zRinfo["bads"] and noise_cov["bads"] do not match, excluding bad channels from both.cs&g|]}|dkrd|qSr)r)rUkrrrr[as ) rr_compare_ch_namesrr& intersectionr rqr)rqforwarddata_cov noise_covrZ fwd_ch_namesrrr)rqrr_check_info_inv=s4       rcsfdd|D}|S)z1Return channel names of common and good channels.cs g|]}|kr|kr|qSrrrrnames2rrr[hsz%_compare_ch_names..r)Znames1rrrrrrrfsrcs@g}dD]}||kr td|q fddt|D}|S)zReturn data channel indices to be used with spatial filter. Unlike ``pick_channels``, this respects the order of ch_names. rzThe spatial filter was computed with channel %s which is not present in the data. You should compute a new spatial filter restricted to the good data channels.cs g|]\}}|dkr|qSrr)rUiich_namefiltersrrr[zs z2_check_channels_spatial_filter..)rPre)rrrrrrr_check_channels_spatial_filterls rcCs6t|dttfdt|tr2|dkr2td|f|S)zCheck rank parameter.Nrank)fullrqz.rank, if str, must be "full" or "info", got %s)r$rbr%rrP)rrrr _check_ranks rc sddlm}m}ddlm}ddlm}ddlmt ||rft |d|gdt t t |j} |n*t |d|gdt||||d} ||| fd d d D} t| d kr|dkrtd |dkr|dd}d} n$|}t ||rd|kr|d=d} t |||fd|| | fS)zECheck number of sensor types and presence of noise covariance matrix.r)make_ad_hoc_cov Covariance)CrossSpectralDensity)r)_contains_ch_typeNr)rrcsg|]}|qSrr)rUttrZ info_pickrrr[sz&_check_one_ch_type..)magZgradZeegr zqSource reconstruction with several sensor types requires a noise covariance matrix to be able to apply whitening.g?)stdTZ estimatorF)ZcovrrZtime_frequency.csdrrrZchannels.channelsrrr$r`ranger&rrrrPr) methodrqrrrrrrrrZch_typesZallow_mismatchrrr_check_one_ch_types6       r depth_mnecCs:ddlm}t|ts0t|dkr$dnt|d}|||S)zCheck depth options.r)_handle_defaultN)r;)defaultsrrrbfloat)depthkindrrrr _check_depths  rcCsTt|t|}t|rPt|dkr(dnd}d|d|d|d|}t||S)aCheck that the keys in dictionary are valid against a set list. Return the input dictionary if it is valid, otherwise raise a ValueError with a readable error message. Parameters ---------- mapping : dict The user-provided dict whose keys we want to check. valid_keys : iterable The valid keys. key_description : str Description of the keys in ``mapping``, e.g., "channel name(s)" or "annotation(s)". valid_key_source : str Description of the ``valid_keys`` source, e.g., "info dict" or "annotations in the data". Returns ------- mapping If all keys are valid the input dict is returned unmodified. r ZareiszInvalid rz not present in )rr&rP)mappingZ valid_keysZkey_descriptionZvalid_key_sourcemissingZ_isrrrr_check_dict_keyss r cCs||kr |S|rd|n|}d}t|}t|dkrJdt|d}n`d}t|dkrt|dd d |D7}n6|d d d |d dD7}|dt|d7}t|j||||dd S)aCheck the value of a parameter against a list of valid options. Return the value if it is valid, otherwise raise a ValueError with a readable error message. Parameters ---------- parameter : str The name of the parameter to check. This is used in the error message. value : any type The value of the parameter to check. allowed_values : list The list of allowed values for the parameter. extra : str Extra string to append to the invalid value sentence, e.g. "when using ico mode". Raises ------ ValueError When the value of the parameter is not one of the valid options. Returns ------- value : any type The value if it is valid. rz[Invalid value for the '{parameter}' parameter{extra}. {options}, but got {value!r} instead.r zThe only allowed value is rzAllowed values are rz and css|]}t|VqdSr\r=rUrZrrrr^sz _check_option..r"css|]}t|VqdSr\r r rrrr^sNr#z, and ) parameteroptionsvaluer)r`r&r=r(rPr)r rZallowed_valuesrrrrrr _check_options     rcCs0|djd}|D]}||jdkrdSqdS)z>Check if a collection of instances all have the same channels.rrFTr)Z instancesrrrrr_check_all_same_channel_namess rmeanmedianrcs|dkrfdd}nf|dkr,fdd}nP|dks>|tjkrLfdd}n0t|rZ|}n"tdd |d |t|f|S) Nrcstj|dSNaxis)rKrrrrrfunsz_check_combine..funrcstj|dSr)rKrrrrrrsrcs t|dSr)rrrrrrszCombine option must be r"z or callable, got %s (type %s).)rKrrrPr(r)moderrrrrr_check_combines rcCs>ddlm}t||d|dkr:|jdkr:td|jfdS)Nr) SourceSpacessrcnormal)ZsurfaceZdiscretez]Normal source orientation is supported only for surface or discrete SourceSpaces, got type %s)Z source_spacerr$rr)Zpick_orirrrrr_check_src_normal$s   rHz>cCs.tt|j}||kr*tdd|dS)NzThe maximum current magnitude is %0.1f nAm, which is very large. Are you trying to apply the forward model to noise-normalized (dSPM, sLORETA, or eLORETA) values? The result will only be correct if currents (in units of Am) are used.geA)rKmaxabsrr )Zstc thresholdZmax_currrr_check_stc_units-s r$) return_apicCszddlm}m}Wntk r0d}}YnbXz |j}Wntk rV|j}YnXtjdkr|dkrt |ddst d|d |d |d |r||fS|SdS) zCheck if Qt is installed.r)QtCoreAPI_NAMENdarwin)ZPyQt5ZPySide2z>=z5.10zmacOS users should use z >= 5.10 for GUIs, got z.. Please upgrade e.g. with: pip install "z>=5.10" ) Zqtpyr&r' Exceptionr0rOZQT_VERSION_STRsysplatformrr )r%r&apir4rrr_check_qt_version7s   r-mc Cs ddlm}ddlm}m}m}|dkrd|}|dk rdz||dddWnttfk r^YnXd}t|t r:|dkrtd ||dk st |dkr||d d d \}}} t ||f}d }q|d kr| } | dkrtd| d} d} d| kr| d| d<| d=n4d| krHd| krHtd| ddddg| d<| D]@} | | krLdd| d| }| dkr|d7}t|qLt| dd| dd| dd| ddg}t}tdD]@\}}t| d|| d|| d|| d|g||<q|d|d |d!|f}d }~~~ ~ nXt||r|d"rbt|d#dkrptd$|ft |d%|d#dd&f}d }tj|td'}|jd(krtd)gd*|gg}|jd+krtd,|jftd-|d.|d/kr|d0}t|t}|S)1Nr)HEAD_SIZE_DEFAULT)fit_sphere_to_headshapeConductorModelget_fitting_digrerrorrjauto)r4eeglabz0sphere, if str, must be "auto" or "eeglab", got Fr.)r Zunitsr5zNo montage was set on your data, but sphere="eeglab" can only work if digitization points for the EEG channels are available. Consider calling set_montage() to apply a montage.ch_pos)FpzOzT7T8ZFPzr7r8zBApproximating Fpz location by mirroring Oz along the X and Y axes.r#r z_sphere="eeglab" requires digitization points of the following electrode locations in the data: r"z, but could not find: z4, and was unable to approximate its location from Ozr9rr:)XYZr;r<r=Z is_sphereZlayersznsphere, if a ConductorModel, must be spherical with multiple layers, not a BEM or single-layer sphere (got %s)r0Zrad)dtyperrr)zJsphere must be float or 1D array of shape (4,), got array-like of shape %s sphere_units)r.mmrBg@@)rr/Zbemr0r1r2rrPrr%rrZ get_montageZ get_positionsr rqr(rKr"rrbrer&rrshapeZ concatenater)ZsphererqrAr/r0r1r2Rr>_Zmontager6Zhorizon_ch_namesrrZradiusZ sphere_locsidxrrrr _check_sphereMs                         rGcCs(ddlm}|d}|dkr$td|S)Nr ) get_configZFREESURFER_HOMEz4The FREESURFER_HOME environment variable is not set.)configrHr)rHZfs_homerrr_check_freesurfer_homes rJQ?cCsFt|||d}t|dkrdSt|dkr8d|dfSd|fSdS)N)cutoffrrr z Did you mean %r?z Did you mean one of %r?)rr&)rWrrLrrr_suggests   rM on_missingcCs"t|t|t||dddgdS)Nraiser ignore)r$r%r)rNrrrr_check_on_missings rQcCsnt|||dkrtn|}|dkr&dn|}|dkr6dn|}|dkrL||n|dkr^t|n |dksjtdS)Nr3rOwarningr rP)rQrPr r)rNrrZ error_klassrrr _on_missings   rS)altusec CsJz t|WStk rD|dk r*|YStd|d|dYnXdS)Nz,Could not use input() to get a response to: z You can z to avoid this error.)rEOFErrorr)rrTrUrrr _safe_inputs rWc Csdt|}tddrfzt|}Wqtk rb}zt|drPt|nW5d}~XYqXn,tj ddt dt|}W5QRXt |j tj st||jdks|jd d krtd |j|S) Nz0events should be a NumPy array of integers, got numpyz1.24zXsetting an array element with a sequence. The requested array has an inhomogeneous shapeT)recordrPrr rz$events must be of shape (N, 3), got )rr5rKZasarrayrPr% startswithrwarningscatch_warnings simplefilterZ issubdtyper?rMndimrC)rgerr_msgZnp_errrrr_ensure_eventss(    r`color)ralphac Gsddlm}|r|jn|j}z ||WStk rzt|dkrJ|dn|}td|rZdndd|dt|dYnXdS) Nr)colorConverterr z Invalid RGBArz argument(s) for z: )Zmatplotlib.colorsrcZto_rgbaZto_rgbrPr&r=)rrbargsrcfuncrrr_to_rgb s   rg)r r)r)r+)r+)FFriF)rN)T)T)T)T)T)T)N)NN)NNN)r)NN)NN)r)r)rr)r )Nr.)rK)rN)rNN)U__doc__builtinsrdifflibr importlibrrrtos.pathpathrnpathlibrr8r*r[rrXrKfixesrrZ_loggingr r r rr*r5r1rBrDrGrJrRrhr{rrrrFrrrrrrrrrobjectrZint_liker%PathLikeZ path_likerZfloatingrrr$rrrrrrrrr rrrrr$r-rGrJrMrQrSrWr`rgrrrrs       6 $  ! -            5  ) # # 1   r