sesameeg.io.read_h5

sesameeg.io.read_h5(fpath)[source]

Load SESAME result from an HDF5 file.

Parameters:
fpathstr

Path and filename of the .h5 file containing the result.

Returns:
resdict

A Python dictionary containing the result

Notes

The keys of the returned dictionary are the following:

  • ch_nameslist | ‘Not available.’

    The channel names

  • cov_pathstr | ‘Not available.’

    Path and filename of the file containing the noise covariance.

  • data_pathstr | ‘Not available.’

    Path and filename of the file containing the data.

  • est_locslist of ndarray of int | ‘Not available.’

    The source space grid points indices in which a source is estimated.

  • est_n_dipslist of int | ‘Not available.’

    The estimated number of dipoles.

  • est_dip_momsndarray , 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_mom_stdlist of ndarray, shape (n_iterations, ) | ‘Not available.’

    Estimated values of the parameter dip_mom_std. Each array in the list corresponds to a single particle. This only applies if hyper_q=True has been selected when instantiating Sesame.

  • exponentsndarray | ‘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.

  • final_dip_mom_stdfloat | ‘Not available.’

    The weighted average of the last estimated value of dip_mom_std in each particle. This only applies if hyper_q=True has been selected when instantiating Sesame.

  • fmaxfloat | None

    The last frequency (in Hertz) of the frequency band in which data have been analyzed.

  • fminfloat | None

    The first frequency (in Hertz) of the frequency band in which data have been analyzed.

  • fwd_pathstr | ‘Not available.’

    Path and filename of the file containing the forward model.

  • lambdafloat

    The parameter of the Poisson prior pdf on the number of dipoles.

  • lf_pathstr | ‘Not available.’

    Path and filename of the file containing the lead field.

  • max_n_dipsint

    The maximum number of dipoles allowed in each particle.

  • model_sellist of ndarray of float

    The model selection, i.e. the posterior distribution on the number of dipoles.

  • prob_maplist of ndarray of float, shape (est_n_dips, n_verts)

    Posterior probability map

  • noise_stdfloat

    The standard deviation of the noise distribution.

  • dip_mom_stdfloat

    The standard deviation of the prior pdf on the dipole moment.

  • src_pathstr | ‘Not available.’

    Path and filename of the file containing the source space grid.

  • subjectstr | ‘Not available.’

    The subject name.

  • subject_vizstr | ‘Not available.’

    The name of the subject’s FreeSurfer folder.

  • tmaxfloat | None

    The last instant (in seconds) of the time window in which data have been analyzed.

  • tminfloat | None

    The first instant (in seconds) of the time window in which data have been analyzed.

Note

Depending on the value of the estimate_all parameter used in the call of the apply_sesame() method, the list returned in the fields est_locs, est_n_dips and prob_map may contain either the corresponding quantity estimated at each iteration or only those estimated at the last iteration.