NWB Builder API

class nsds_lab_to_nwb.nwb_builder.NWBBuilder(data_path: str, block_folder: str, save_path: str, block_metadata_path: Optional[str] = None, metadata_lib_path: Optional[str] = None, stim_lib_path: Optional[str] = None, metadata_save_path: Optional[str] = None, resample_data=False, use_htk=False)[source]

Bases: object

Unpack data from a specified block, and write those data into NWB file format.

Parameters

  • data_path (str) – Path to top level data folder.

  • block_folder (str) – Block specification.

  • save_path (str) – Path to save folder.

  • block_metadata_path (str) – Path to block metadata file.

  • metadata_lib_path (str) – Path to metadata library repo.

  • stim_lib_path (str) – Path to stimulus library.

  • metadata_save_path (str) – Path to (optionally) save metadata input as yaml files.

  • resample_data (bool) – Resample neural data to the nearest kHz. Passed to resample_flag kwarg in NeuralDataOriginator.

  • use_htk (bool) – Use data from HTK files.

build(process_stim=True)[source]

Build NWB file content.

Parameters

  • process_stim ((bool) default is True. optionally skip stimulus processing) – while developing/testing other features (temporary switch)

  • Returns –

  • -------- –

  • nwb_content (an NWBFile object.) –

write(content)[source]

Write collected NWB content into an actual file.