bci.reader package

Subpackages

• bci.reader.drivers package
  • Submodules
  • bci.reader.drivers.binary module
  • bci.reader.drivers.find_driver module
  • bci.reader.drivers.protobuf module
  • Module contents

Submodules

bci.reader.reader module

class bci.reader.reader.Reader(path, format=None)

Bases: object

Represents a sample’s reader.

path

Path of the sample file.

Type

str

format

Format of the sample file.

Type

str

Parameters

• path (str) – Path of the sample file.

• format (str, optional) – Format of the sample file. Default to DEFAULT_FORMAT

Raises

• ValueError – If format is not supported.

• OSError – If a failure occurs while reading the sample file.

bci.reader.reader.read(path, format=None)

Reads the sample file from path and prints its content in a human-readable form.

Parameters

• path (str) – Path of the sample file.

• format (str, optional) – Format of the sample file. Default to DEFAULT_FORMAT.

Raises

• ValueError – If format is not a supported sample format.

• OSError – If a failure occurs while reading the sample file.

Module contents

class bci.reader.Reader(path, format=None)

Bases: object

Represents a sample’s reader.

path

Path of the sample file.

Type

str

format

Format of the sample file.

Type

str

Parameters

• path (str) – Path of the sample file.

• format (str, optional) – Format of the sample file. Default to DEFAULT_FORMAT

Raises

• ValueError – If format is not supported.

• OSError – If a failure occurs while reading the sample file.

bci.reader.read(path, format=None)

Reads the sample file from path and prints its content in a human-readable form.

Parameters

• path (str) – Path of the sample file.

• format (str, optional) – Format of the sample file. Default to DEFAULT_FORMAT.

Raises

• ValueError – If format is not a supported sample format.

• OSError – If a failure occurs while reading the sample file.