wonambi.ioeeg.bids module

class wonambi.ioeeg.bids.BIDS(filename)

Bases: object

Basic class to read the data.

Parameters:

filename (path to file) – the name of the filename or directory

return_dat(chan, begsam, endsam)

Return the data as 2D numpy.ndarray.

Parameters:

• chan (int or list) – index (indices) of the channels to read

• begsam (int) – index of the first sample

• endsam (int) – index of the last sample

Returns:

numpy.ndarray – A 2d matrix, with dimension chan X samples

return_hdr(sf_from_bids=False)

Return the header for further use.

Returns:

• subj_id (str) – subject identification code

• start_time (datetime) – start time of the dataset

• s_freq (float) – sampling frequency

• chan_name (list of str) – list of all the channels

• n_samples (int) – number of samples in the dataset

• orig (dict) – additional information taken directly from the header

return_markers()

Return all the markers (also called triggers or events).

Returns:

list of dict – where each dict contains ‘name’ as str, ‘start’ and ‘end’ as float in seconds from the start of the recordings, and ‘chan’ as list of str with the channels involved (if not of relevance, it’s None).

wonambi.ioeeg.bids.write_bids(data, filename, markers=[])

wonambi.ioeeg.bids.write_bids_channels(output_file, dataset)

Export BIDS channels TSV from Dataset.

Parameters:

• output_file (path to file) – file to export to (use ‘.tsv’ as extension)

• dataset (instance of wonambi.Dataset) – Dataset with record metadata