wonambi.ioeeg.blackrock module

class wonambi.ioeeg.blackrock.BlackRock(filename)[source]

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)[source]

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()[source]

Return the header for further use.

Returns:

  • subj_id (str) – subject identification code

  • start_time (datetime) – start time of the dataset (in UTC time, because that’s the way it was saved and there is no way to know the correct local time reliably)

  • 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

Notes

The implementation needs to be updated for NEURALSG

return_markers(trigger_bits=16, trigger_zero=True)[source]
Parameters:

  • trigger_bits (int, optional) – 8 or 16, read the triggers as one or two bytes

  • trigger_zero (bool, optional) – read the trigger zero or not