Common API

class nsds_lab_to_nwb.common.data_scanners.AuditoryDataScanner(block_folder, data_path: str = '', stim_lib_path=None, use_htk=False)[source]

Bases: nsds_lab_to_nwb.common.data_scanners.DataScanner

add_block_subdir(path)[source]

extract_dataset()[source]: returns a Dataset object

class nsds_lab_to_nwb.common.data_scanners.BehaviorDataScanner(animal_name, block, data_path: str = '', video_path=None)[source]

Bases: nsds_lab_to_nwb.common.data_scanners.DataScanner

extract_dataset()[source]: returns a Dataset object

class nsds_lab_to_nwb.common.data_scanners.DataScanner(block_folder, data_path: str = '', use_htk=False)[source]

Bases: object

Defines input path structure and stores relevant paths in a Dataset object. This is a base class for AuditoryDataScanner and BehaviorDataScanner classes.

extract_dataset()[source]: returns a Dataset object

class nsds_lab_to_nwb.common.data_scanners.Dataset(block_folder, data_path, **path_kwargs)[source]

Bases: object

The Dataset class is just a convenient namespace for all the relevant paths where the input data can be found. See the DataScanner classes for how the Dataset is constructed.

class nsds_lab_to_nwb.common.io.MyDumper(stream, default_style=None, default_flow_style=False, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None, sort_keys=True)[source]

Bases: yaml.dumper.Dumper

increase_indent(flow=False, indentless=False)[source]

nsds_lab_to_nwb.common.io.csv_to_dict(csv_file)[source]

nsds_lab_to_nwb.common.io.read_mat_file(file_path)[source]

nsds_lab_to_nwb.common.io.read_yaml(file_path)[source]

nsds_lab_to_nwb.common.io.write_yaml(yml_path, data, access_mode='w', default_flow_style=False, sort_keys=False)[source]

class nsds_lab_to_nwb.common.rec_manager.RecManager(dataset)[source]

Bases: object

read_info()[source]

read_mark_events()[source]

read_marks()[source]

read_neural_data(stream, dev_conf)[source]

nsds_lab_to_nwb.common.time.get_current_time(timezone=<DstTzInfo 'US/Pacific' LMT-1 day, 16:07:00 STD>)[source]

nsds_lab_to_nwb.common.time.get_date_string_only(datetime_string)[source]

nsds_lab_to_nwb.common.time.get_default_time(timestamp=0, timezone=<DstTzInfo 'US/Pacific' LMT-1 day, 16:07:00 STD>)[source]

nsds_lab_to_nwb.common.time.validate_time(time_object, timezone=<DstTzInfo 'US/Pacific' LMT-1 day, 16:07:00 STD>)[source]