omidb¶

class omidb.DB(root_dir, ignore_missing_images=True, clients=None, exclude_clients=None, distinct_event_study_links=True)[source]¶

OMI-DB parser

Parameters

root_dir (Union[str, Path]) – Root directory of the OMI-DB. The data and images directories should sit somewhere below the root, and can be nested under sub-directories, e.g. data/sample/omi-db/(data|images) is fine.
ignore_missing_images (bool) – If True, the existence of dicom images belonging to a series will not be checked: parsing is based entirely on the JSON representations of the DICOM headers. Set to False to parse only those images for which you have both JSON and DICOM files for.
clients (Optional[Sequence[str]]) – Only parse these clients, if they exist
exclude_clients (Optional[Sequence[str]]) – Exclude these clients, even if they are in clients
distinct_event_study_links (bool) – Only match events to imaging studies when distinct (1 to 1 mapping)