dbdicom.studies#
- dbdicom.studies(entity: str | list, name: str | None = None, contains: str | None = None, isin: list | None = None) list [source]#
Return a list of studies in the DICOM folder.
- Parameters:
entity (str or list) – path to a DICOM folder (to search in the whole folder), or a two-element list identifying a patient (to search studies of a given patient).
name (str, optional) – value of StudyDescription, to search for studies with a given description. Defaults to None.
contains (str, optional) – substring of StudyDescription, to search for studies based on part of their description. Defaults to None.
isin (list, optional) – List of StudyDescription values, to search for studies whose description is in a list. Defaults to None.
- Returns:
list of studies fulfilling the criteria.
- Return type: