convnwb.paths.paths.Paths

class convnwb.paths.paths.Paths(project_path, subject=None, experiment=None, session=None, project_folders=['docs', 'info', 'nwb', 'recordings'], recordings_name='recordings', subject_folders=['anatomy', 'electrodes', 'notes'], session_folders={'01_raw': ['behavior', 'neural'], '02_processing': ['alignment', 'metadata', 'sorting', 'task'], '03_extracted': ['spikes', 'lfp']})

Paths object for a session of single-unit data.

__init__(project_path, subject=None, experiment=None, session=None, project_folders=['docs', 'info', 'nwb', 'recordings'], recordings_name='recordings', subject_folders=['anatomy', 'electrodes', 'notes'], session_folders={'01_raw': ['behavior', 'neural'], '02_processing': ['alignment', 'metadata', 'sorting', 'task'], '03_extracted': ['spikes', 'lfp']})

Defines a paths object for a project.

Parameters:

project_pathstr or Path

The path to the project folder.

subjectstr, optional

Subject label.

experimentstr, optional

Experiment name.

sessionstr or int, optional

The session label. Can be an integer index, or a string, for example session_0.

project_folderslist, optional

Defines the sub-folders that are part of the subject folder.

recordings_namestr, optional

The name of the subfolder (within project_path) to store recordings.

subject_folderslist, optional

Defines the sub-folders that are part of the project folder.

session_foldersdict, optional

Defines the folder names to that are part of the session folder. Each key defines a sub-directory within the session folder. Each set of values is a list of folder names within each sub-directory.

Methods

__init__(project_path[, subject, ...])	Defines a paths object for a project.
get_files(folder, **kwargs)	Get a list of files available in a specified folder.
get_subfolders(folder, **kwargs)	Get a list of sub-folder available in a specified folder.
print_structure()	Print directory structure.

Attributes

all_folders	List of all folders.
all_paths	List of all path names (all labels that can be used to access a path).
experiment	"Path of the experiment folder.
recordings	"Path of the recordings folder.
session	Path of the session folder.
session_name	Name of the session this object reflects.
subject	Path of the subject folder.

property all_folders

List of all folders.

property all_paths

List of all path names (all labels that can be used to access a path).

property experiment

“Path of the experiment folder.

get_files(folder, **kwargs)

Get a list of files available in a specified folder.

get_subfolders(folder, **kwargs)

Get a list of sub-folder available in a specified folder.

print_structure()

Print directory structure.

property recordings

“Path of the recordings folder.

property session

Path of the session folder.

property session_name

Name of the session this object reflects.

property subject

Path of the subject folder.