nipoppy.tabular.doughnut

Class for the doughnut file.

Classes

Doughnut	A dataset's doughnut, for tracking DICOM-to-BIDS conversion status.
DoughnutModel	An internally- or user-generated file to keep track of the BIDS conversion process.

Module Contents

nipoppy.tabular.doughnut.generate_doughnut(manifest, dicom_dir_map, dpath_downloaded=None, dpath_organized=None, dpath_bidsified=None, empty=False, logger=None)

Generate a doughnut object.

Parameters:

• manifest (nipoppy.tabular.manifest.Manifest)

• dicom_dir_map (nipoppy.tabular.dicom_dir_map.DicomDirMap)

• dpath_downloaded (Optional[nipoppy.env.StrOrPathLike])

• dpath_organized (Optional[nipoppy.env.StrOrPathLike])

• dpath_bidsified (Optional[nipoppy.env.StrOrPathLike])

• logger (Optional[logging.Logger])

Return type:

Doughnut

nipoppy.tabular.doughnut.update_doughnut(doughnut, manifest, dicom_dir_map, dpath_downloaded=None, dpath_organized=None, dpath_bidsified=None, empty=False, logger=None)

Update an existing doughnut file.

Parameters:

• doughnut (Doughnut)

• manifest (nipoppy.tabular.manifest.Manifest)

• dicom_dir_map (nipoppy.tabular.dicom_dir_map.DicomDirMap)

• dpath_downloaded (Optional[nipoppy.env.StrOrPathLike])

• dpath_organized (Optional[nipoppy.env.StrOrPathLike])

• dpath_bidsified (Optional[nipoppy.env.StrOrPathLike])

• logger (Optional[logging.Logger])

Return type:

Doughnut