nipoppy.layout.LayoutConfig¶

class nipoppy.layout.LayoutConfig(/, **data)¶

Relative paths for the dataset layout.

Parameters:: data (Any)

get_path_info(path_label)¶

Return the PathInfo object associated with the given path label.

Parameters:: path_label (str)
Return type:: PathInfo

dpath_assessments: DpathInfo¶

dpath_bids: DpathInfo¶

dpath_bids_db: DpathInfo¶

dpath_bids_ignore_patterns: DpathInfo¶

dpath_containers: DpathInfo¶

dpath_demographics: DpathInfo¶

dpath_derivatives: DpathInfo¶

dpath_descriptors: DpathInfo¶

dpath_downloads: DpathInfo¶

dpath_invocations: DpathInfo¶

dpath_logs: DpathInfo¶

dpath_proc: DpathInfo¶

dpath_pybids: DpathInfo¶

dpath_raw_imaging: DpathInfo¶

dpath_releases: DpathInfo¶

dpath_scratch: DpathInfo¶

dpath_sourcedata: DpathInfo¶

dpath_tabular: DpathInfo¶

dpath_tracker_configs: DpathInfo¶

fpath_config: FpathInfo¶

fpath_doughnut: OptionalFpathInfo¶

fpath_imaging_bagel: OptionalFpathInfo¶

fpath_manifest: FpathInfo¶

model_config¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property path_infos: list[PathInfo]¶

Return a list of all PathInfo objects defined in the layout.

Return type:: list[PathInfo]

property path_labels: list[str]¶

Return a list of all path labels defined in the layout.

Return type:: list[str]