nipoppy.tabular.bagel.BagelModel¶

class nipoppy.tabular.bagel.BagelModel(/, **data)¶

A file generated by the trackers.

Contains processing statuses for image processing pipelines.

Note: This class is called “model” to be consistent with Pydantic nomenclature, but it can be thought of as a schema for each row in the bagel file.

Parameters:: data (Any)

classmethod check_status(value)¶

Check that a status field has a valid value.

Parameters:: value (str)

validate_after()¶: Check fields.

classmethod validate_before(data)¶

Set default values for BIDS participant and session IDs.

Parameters:: data (Any)

bids_participant_id: str¶

bids_session_id: str¶

participant_id: str¶

pipeline_name: str¶

pipeline_step: str¶

pipeline_version: str¶

session_id: str¶

status: str¶