OpenBci BrainFlow Python代码

创建一个参数实例Params，设置端口号，使用GANGLION的ID+Params的端口号创建一个BoardShim对象

三个模块：
BoardShim 数据读取
DataFilter 信号处理
MLModel 计算衍生指标

board_shim 成员
板子ID
class brainflow.board_shim.BoardIds(value) GANGLION_BOARD= 1
解释：不用创建对象实例，使用BoardIds.GANGLION_BOARD，作为枚举型

BoardShim方法的输入参数（Inputs params）（指定数据输入位置）
class brainflow.board_shim.BrainFlowInputParams
在ganglion中，只需要指定端口

板子实例
class
brainflow.board_shim.
BoardShim(board_id: int, input_params: brainflow.board_shim.BrainFlowInputParams)
ID通过BoardIds的枚举变量指定（或者输入INT）
input_params通过BrainFlowInputParams对象创建实例
可用方法：
1.日志相关
set_log_level(log_level: int)
enable_board_logger()
disable_board_logger()
enable_dev_board_logger()
log_message(log_level: int, message: str)向日志中手动添加信息
2.读取信息.
所有板数据都作为二维数组返回。该数组中的行可能包含时间戳、EEG 和 EMG 数据等。通过特定函数可以得到特定数据
得到xxxx通道（的number），参数：板子id，预设（BrainFlowPresets类中枚举的值）
get_xxxxxxx_channel(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → int

获得板子采样率
get_sampling_rate(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → int

返回数据的行数（采取的数据都是二维的）
get_num_rows(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → int

获取EEG脑电(exg、emg）通道列表（返回list）
get_eeg_channels(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → List[int]
get_exg_channels(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → List[int]
get_emg_channels(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → List[int]
get_ecg_channels(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → List[int]
get_eog_channels(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → List[int]
…
可选通道包括：
eeg、emg、exg、ecg、eog、eda、ppg、accel（加速通道）、analog（模拟通道）、gyro（陀螺仪通道）、other（其他通道）、temperature（温度通道）、resistance（阻力通道）、magnetometer（磁力计）

获取EEG通道名称
get_eeg_names(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → List[str]
获取可用预设
get_board_presets(board_id: int) → List[str]
获取brainflow库版本
get_version() → str
获取板描述（json）
get_board_descr(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>)
设备名
get_device_name(board_id: int, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → str

3.会话stream与数据传输
释放准备好的会话
release_all_sessions() → None
准备会话（初始化资源，在调用板子实例的方法前进行初始化）
prepare_session() → None
增加/删除steamer，参数介绍：
 preset
(int) – preset
 parameter to stream data from brainflow
, supported vals (streamer_params) – “file://%file_name%:w”, “file://%file_name%:a”, “streaming_board://%multicast_group_ip%:%port%”. Range for multicast addresses is from “224.0.0.0” to “239.255.255.255”
add_streamer(streamer_params: str, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → None
delete_streamer(streamer_params: str, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → None
开始数据流/停止数据流，数据存储在环形缓冲区ringbuffer，参数，num_samples：数据流缓冲区大小（环形）
start_stream(num_samples: int = 450000, streamer_params: str = None) → None
stop_stream() → None
取当前数据，但不删除缓冲区中的数据，可给出参数：num_samples（最大样本数）、present（预设），返回NDArray
get_current_board_data()
获取板子的数据并删除缓冲区数据，给出参数，num_saples(要获取的包个数，当为none时表示获取所有数据）、preset，返回NDArray
get_board_data()
检查会话是否就绪
is_prepared() → bool
像数据流中插入标记（数据）
insert_marker(value: float, preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → None
获得缓冲区元素数量
get_board_data_count(preset: int = <BrainFlowPresets.DEFAULT_PRESET: 0>) → int
释放所有资源
release_session() → None
获得实际的板id
get_board_id() → int

exit_codes 成员（异常）
exception brainflow.exit_codes.BrainFlowError(message: str, exit_code: int)
解释：退出代码非0时抛出异常，message为异常信息
class brainflow.exit_codes.BrainFlowExitCodes(value)
解释：枚举退出代码，当为0时表示状态正常
STATUS_OK=0
其余值为各种异常状态