Buffalo-lab-data-to-nwb

将Buffalo实验室数据转换为NWB格式的脚本。目前我们只支持处理数据的转换。

作者：Luiz Tauffer, Maija Honig, Ryan Ly, Ben Dichter

安装

pip install git+https://github.com/ben-dichter-consulting/buffalo-lab-data-to-nwb.git

使用

转换函数可以以不同的形式使用

1. 从Python脚本导入并运行
以下是一个示例：我们将抓取原始数据（.ncs文件）和处理数据（.mat和.nex5文件）并将它们转换为.nwb文件。

from buffalonwb.conversion_module import conversion_function
from pathlib import Path
import yaml

base_path = Path(BASE_PATH_TO_FILES)

# Source files
source_paths = dict()
source_paths['raw Nlx'] = {'type': 'dir', 'path': base_path.joinpath("RawNlxCSCs")}
source_paths['processed Nlx'] = {'type': 'dir', 'path': str(base_path.joinpath('ProcessedNlxData'))}
source_paths['processed behavior'] = {'type': 'file', 'path': str(base_path.joinpath('ProcessedBehavior/MatFile_2017-04-27_11-41-21.mat'))}
source_paths['sorted spikes'] = {'type': 'file', 'path': str(base_path.joinpath('SortedSpikes/2017-04-27_11-41-21_sorted.nex5'))}

# Output .nwb file
f_nwb = 'buffalo.nwb'

# Load metadata from YAML file
metafile = 'metafile.yml'
with open(metafile) as f:
    metadata = yaml.safe_load(f)

kwargs_fields = {
    'skip_raw': True,
    'skip_processed': False,
    'no_lfp_iterator': False,
}

conversion_function(source_paths=source_paths,
                    f_nwb=f_nwb,
                    metadata=metadata,
                    **kwargs_fields)

2. 命令行
同样，可以从终端的命令行调用转换函数

$ python conversion_module.py [raw_nlx_dir] [lfp_mat_dir]
  [sorted_spikes_nex5_file] [behavior_file] [output_file] [metadata_file]
  [-skipraw] [-skipprocessed] [-lfpiterator]

重要
[raw_nlx_dir]和[lfp_mat_dir]应该是目录路径
[sorted_spikes_nex5_file] [behavior_file] [output_file] [metadata_file]应该是文件路径

可选输入，在位置参数之后添加这些选项以使用附加选项
"-skipraw"（将跳过将原始数据添加到nwb文件）
"-skipprocessed"（将跳过将处理数据添加到nwb文件）
"-lfpiterator"（将lfp数据方法更改为dataChunkIterator（适用于大型数据））

3. 图形用户界面
要使用图形用户界面，只需从终端运行辅助函数 nwb_gui.py

$ python nwb_gui.py

图形用户界面简化了编辑结果 .nwb 文件元数据的工作，它与转换模块集成（点击转换）并允许使用 nwb-jupyter-widgets 可视化探索最终文件中的数据。