U f{j[2@sddZddlZddlmZddlmZmZedd d Zd d Z dd dZ ddZ ddZ ddZ dS)zCompute resolution metrics from resolution matrix. Resolution metrics: localisation error, spatial extent, relative amplitude. Metrics can be computed for point-spread and cross-talk functions (PSFs/CTFs). N)SourceEstimate)loggerverbosepsfpeak_err?c Csd}||krtd||dkr,td||dkrFt||||d}n4|dkrbt|||||d}n|d krzt||||d}|d d }|d d } || g} t|| d dd}|S)aCompute spatial resolution metrics for linear solvers. Parameters ---------- resmat : array, shape (n_orient * n_vertices, n_vertices) The resolution matrix. If not a square matrix and if the number of rows is a multiple of number of columns (e.g. free or loose orientations), then the Euclidean length per source location is computed (e.g. if inverse operator with free orientations was applied to forward solution with fixed orientations). src : instance of SourceSpaces Source space object from forward or inverse operator. function : 'psf' | 'ctf' Whether to compute metrics for columns (point-spread functions, PSFs) or rows (cross-talk functions, CTFs) of the resolution matrix. metric : str The resolution metric to compute. Allowed options are: Localization-based metrics: - ``'peak_err'`` Peak localization error (PLE), Euclidean distance between peak and true source location. - ``'cog_err'`` Centre-of-gravity localisation error (CoG), Euclidean distance between CoG and true source location. Spatial-extent-based metrics: - ``'sd_ext'`` Spatial deviation (e.g. :footcite:`MolinsEtAl2008,HaukEtAl2019`). - ``'maxrad_ext'`` Maximum radius to 50%% of max amplitude. Amplitude-based metrics: - ``'peak_amp'`` Ratio between absolute maximum amplitudes of peaks per location and maximum peak across locations. - ``'sum_amp'`` Ratio between sums of absolute amplitudes. threshold : float Amplitude fraction threshold for spatial extent metric 'maxrad_ext'. Defaults to 0.5. %(verbose)s Returns ------- resolution_metric : instance of SourceEstimate The resolution metric. Notes ----- For details, see :footcite:`MolinsEtAl2008,HaukEtAl2019`. .. versionadded:: 0.20 References ---------- .. footbibliography:: )rcog_errsd_ext maxrad_extpeak_ampsum_ampz "%s" is not a recognized metric.)rctfz)Not a recognised resolution function: %s.)rr )functionmetric)r r )rr threshold)r r rvertnogg?)ZtminZtstep) ValueError_localisation_error_spatial_extent_relative_amplituder) resmatsrcrrrrZmetricsZresolution_metric vertno_lh vertno_rhrrb/var/www/html/bwave/python/venv/lib/python3.8/site-packages/mne/minimum_norm/spatial_resolution.pyresolution_metricss6>   rc Cst|}t|}d|}|dkr&|j}|dkrhdd|jD}||ddf}||}tjj|dd}np|d krt|jd }t|D]N\} } t |dd| fj} | |t | } t t | | d || <q|S) aCompute localisation error metrics for resolution matrix. Parameters ---------- resmat : array, shape (n_orient * n_locations, n_locations) The resolution matrix. If not a square matrix and if the number of rows is a multiple of number of columns (i.e. n_orient>1), then the Euclidean length per source location is computed (e.g. if inverse operator with free orientations was applied to forward solution with fixed orientations). src : Source Space Source space object from forward or inverse operator. function : 'psf' | 'ctf' Whether to compute metrics for columns (point-spread functions, PSFs) or rows (cross-talk functions, CTFs). metric : str What type of localisation error to compute. - 'peak_err': Peak localisation error (PLE), Euclidean distance between peak and true source location, in centimeters. - 'cog_err': Centre-of-gravity localisation error (CoG), Euclidean distance between CoG and true source location, in centimeters. Returns ------- locerr : array, shape (n_locations,) Localisation error per location (in cm). Y@rrcSsg|]}t|qSr)absZargmax.0colrrr sz'_localisation_error..NrZaxisr rr) _rectify_resolution_matrix_get_src_locationsTnpZlinalgZnormemptyshape enumerater dotsumsqrt) rrrr locationsZresmaxZmaxlocdiffloclocerriirrresvecZcogrrrros"rc Cs0t|}d|}|dkr|j}t|jd}|dkrt|jdD]f}|||ddf}t|dd} t|dd|fd} ttt | | t| ||<qDn~|dkr,t |jD]h\}} t| } | } t | || k} || ddf||ddf} tt| dd ||<q|S) aXCompute spatial width metrics for resolution matrix. Parameters ---------- resmat : array, shape (n_orient * n_dipoles, n_dipoles) The resolution matrix. If not a square matrix and if the number of rows is a multiple of number of columns (i.e. n_orient>1), then the Euclidean length per source location is computed (e.g. if inverse operator with free orientations was applied to forward solution with fixed orientations). src : Source Space Source space object from forward or inverse operator. function : 'psf' | 'ctf' Whether to compute metrics for columns (PSFs) or rows (CTFs). metric : str What type of width metric to compute. - 'sd_ext': spatial deviation (e.g. Molins et al.), in centimeters. - 'maxrad_ext': maximum radius to fraction threshold of max amplitude, in centimeters. threshold : float Amplitude fraction threshold for metric 'maxrad'. Defaults to 0.5. Returns ------- width : array, shape (n_dipoles,) Spatial width metric per location. rrrr rNrr ) r'r(r)r*r+ranger.r r/multiplyr,maxwhere)rrrrrr0widthr3r1r2r5ZampsZ thresh_idxZ locs_threshrrrrs*   rc Csp|dkr|j}|dkr>tdd|jD}|}||}n.|dkrltdd|jD}|}||}|S)aCompute relative amplitude metrics for resolution matrix. Parameters ---------- resmat : array, shape (n_orient * n_dipoles, n_dipoles) The resolution matrix. If not a square matrix and if the number of rows is a multiple of number of columns (i.e. n_orient>1), then the Euclidean length per source location is computed (e.g. if inverse operator with free orientations was applied to forward solution with fixed orientations). src : Source Space Source space object from forward or inverse operator. function : 'psf' | 'ctf' Whether to compute metrics for columns (PSFs) or rows (CTFs). metric : str Which amplitudes to use. - 'peak_amp': Ratio between absolute maximum amplitudes of peaks per location and maximum peak across locations. - 'sum_amp': Ratio between sums of absolute amplitudes. Returns ------- relamp : array, shape (n_dipoles,) Relative amplitude metric per location. rr cSsg|]}t|qSr)r r8r!rrrr$sz'_relative_amplitude..r cSsg|]}t|qSr)r r.r!rrrr$s)r(r)arrayr8) rrrrZmaxampsZ maxmaxampsZrelampZsumampsZ sumampsmaxrrrrs rcCsZ|dd}|dd}|dd|ddf}|dd|ddf}t||g}|S)z%Get source positions from src object.rrrr4N)r)Zvstack)rrrZ locations_lhZ locations_rhr0rrrr's   r'csj}|d|dks|d|dkrg|]6}t||dddfdjddqS)rNrrr%)r)r/r.)r"insrrrr$Bsz._rectify_resolution_matrix..)Zdtypez6Rectified resolution matrix from (%d, %d) to (%d, %d).) r+rr)modZarangeintr;rinfo)rr+Zresmatlrr=rr&*s.   r&)rrrN)r)__doc__numpyr)rutilsrrrrrrr'r&rrrrs  ^; B0