sesameeg.io
.read_h5¶
- sesameeg.io.read_h5(fpath)[source]¶
Load SESAME result from an HDF5 file.
- Parameters:
- fpath
str
Path and filename of the .h5 file containing the result.
- fpath
- Returns:
- res
dict
A Python dictionary containing the result
- res
Notes
The keys of the returned dictionary are the following:
- ch_names
list
| ‘Not available.’ The channel names
- ch_names
- cov_path
str
| ‘Not available.’ Path and filename of the file containing the noise covariance.
- cov_path
- data_path
str
| ‘Not available.’ Path and filename of the file containing the data.
- data_path
- est_dip_moms
ndarray
, shape (est_n_dips[-1], n_ist, n_comp) | ‘Not available.’ The moment time courses of the dipoles estimated in the last iteration of SESAME. (n_comp = 1, if fixed orientation, 3, if free orientation)
- est_dip_moms
- exponents
ndarray
| ‘Not available.’ Array whose entries represent points in the space of artificial distributions. It is used to keep track of the path followed by SESAME.
- exponents
- fmax
float
| None The last frequency (in Hertz) of the frequency band in which data have been analyzed.
- fmax
- fmin
float
| None The first frequency (in Hertz) of the frequency band in which data have been analyzed.
- fmin
- fwd_path
str
| ‘Not available.’ Path and filename of the file containing the forward model.
- fwd_path
- lambda
float
The parameter of the Poisson prior pdf on the number of dipoles.
- lambda
- lf_path
str
| ‘Not available.’ Path and filename of the file containing the lead field.
- lf_path
- max_n_dips
int
The maximum number of dipoles allowed in each particle.
- max_n_dips
- noise_std
float
The standard deviation of the noise distribution.
- noise_std
- dip_mom_std
float
The standard deviation of the prior pdf on the dipole moment.
- dip_mom_std
- src_path
str
| ‘Not available.’ Path and filename of the file containing the source space grid.
- src_path
- subject
str
| ‘Not available.’ The subject name.
- subject
- subject_viz
str
| ‘Not available.’ The name of the subject’s FreeSurfer folder.
- subject_viz
- tmax
float
| None The last instant (in seconds) of the time window in which data have been analyzed.
- tmax
- tmin
float
| None The first instant (in seconds) of the time window in which data have been analyzed.
- tmin
Note
Depending on the value of the
estimate_all
parameter used in the call of theapply_sesame()
method, the list returned in the fieldsest_locs
,est_n_dips
andprob_map
may contain either the corresponding quantity estimated at each iteration or only those estimated at the last iteration.