Datatypes and objects¶

Datatypes and objects.

Classes:

Name	Description
`ExportInfo`	The results of a download action.
`SeriesData`	Info for DICOM series.
`SeriesUidMap`	Map a SeriesInstanceUID to an index.
`Status`	Download status codes.
`StudyData`	Info for DICOM studies.

ExportInfo ¶

ExportInfo(
    series_uid: str = "NA",
    study_uid: str = "NA",
    status: Status = UNKNOWN,
    destination: Path = Path(),
    start: datetime | None = None,
    end: datetime | None = None,
)

The results of a download action.

Methods:

Name	Description
`column_names`	Get the column names.
`convert`	Convert a SeriesData to an ExportInfo.
`duration`	Get the duration of the export.
`to_dict`	Convert to dictionary.

Attributes:

Name	Type	Description
`destination`	`Path`	Download location.
`end`	`datetime \| None`	End of download action.
`series_uid`	`str`	SeriesInstanceUID downloaded.
`start`	`datetime \| None`	Start of download action.
`status`	`Status`	Download status.
`study_uid`	`str`	StudyInstanceUID downloaded.

destination ¶

destination: Path = Path()

Download location.

end ¶

end: datetime | None = None

End of download action.

series_uid ¶

series_uid: str = 'NA'

SeriesInstanceUID downloaded.

start ¶

start: datetime | None = None

Start of download action.

status ¶

status: Status = UNKNOWN

Download status.

study_uid ¶

study_uid: str = 'NA'

StudyInstanceUID downloaded.

column_names ¶

column_names() -> list[str]

Get the column names.

convert ¶

convert(data: SeriesData) -> ExportInfo

Convert a SeriesData to an ExportInfo.

duration ¶

duration() -> timedelta | None

Get the duration of the export.

to_dict ¶

to_dict() -> dict[str, Any]

Convert to dictionary.

SeriesData ¶

Bases: BaseModel

Info for DICOM series.

Attributes:

Name	Type	Description
`Modality`	`str`	Modality
`ProtocolName`	`str`	ProtocolName
`SeriesDescription`	`str`	SeriesDescription
`SeriesInstanceUID`	`str`	SeriesInstanceUID
`SeriesNumber`	`int \| None`	SeriesNumber
`StudyInstanceUID`	`str`	StudyInstanceUID

Modality ¶

Modality: str = 'NA'

Modality

ProtocolName ¶

ProtocolName: str = 'NA'

ProtocolName

SeriesDescription ¶

SeriesDescription: str = 'NA'

SeriesDescription

SeriesInstanceUID ¶

SeriesInstanceUID: str = 'NA'

SeriesInstanceUID

SeriesNumber ¶

SeriesNumber: int | None = None

SeriesNumber

StudyInstanceUID ¶

StudyInstanceUID: str = 'NA'

StudyInstanceUID

SeriesUidMap ¶

SeriesUidMap(series: list[SeriesData])

Map a SeriesInstanceUID to an index.

Methods:

Name	Description
`uid_map`	Get the index for an UID.

uid_map ¶

uid_map(series_uid: str) -> str

Get the index for an UID.

Parameters:

Name	Type	Description	Default
`series_uid` ¶	`str`	SeriesInstanceUID	required

Returns:

Type	Description
`str`	index

Status ¶

Bases: Enum

Download status codes.

Attributes:

Name	Type	Description
`ERROR`		An error occured.
`NO_DATA`		No data found.
`OK`		Everything went ok.
`UNKNOWN`		Unknown error.

ERROR ¶

ERROR = auto()

An error occured.

NO_DATA ¶

NO_DATA = auto()

No data found.

OK ¶

OK = auto()

Everything went ok.

UNKNOWN ¶

UNKNOWN = auto()

Unknown error.

StudyData ¶

Bases: BaseModel

Info for DICOM studies.

Methods:

Name	Description
`modalities_in_study_is_list`	Validator to make sure the ModalitiesInStudy is a list.
`set_patient_name`	Validator to decode the patient name from PersonName.

Attributes:

Name	Type	Description
`AccessionNumber`	`str`	AccessionNumber
`BodyPartExamined`	`str`	BodyPartExamined
`ModalitiesInStudy`	`list[str]`	ModalitiesInStudy
`PatientBirthDate`	`str`	PatientBirthDate
`PatientID`	`str`	PatientID
`PatientName`	`str`	PatientName
`PatientSex`	`str`	PatientSex
`StudyDate`	`str`	StudyDate
`StudyDescription`	`str`	StudyDescription
`StudyID`	`str`	StudyID
`StudyInstanceUID`	`str`	StudyInstanceUID
`StudyTime`	`str`	StudyTime
`series`	`list[SeriesData]`	series

AccessionNumber ¶

AccessionNumber: str = 'NA'

AccessionNumber

BodyPartExamined ¶

BodyPartExamined: str = 'NA'

BodyPartExamined

ModalitiesInStudy ¶

ModalitiesInStudy: list[str] = Field(default_factory=list)

ModalitiesInStudy

PatientBirthDate ¶

PatientBirthDate: str = 'NA'

PatientBirthDate

PatientID ¶

PatientID: str = 'NA'

PatientID

PatientName ¶

PatientName: str = 'NA'

PatientName

PatientSex ¶

PatientSex: str = 'NA'

PatientSex

StudyDate ¶

StudyDate: str = 'NA'

StudyDate

StudyDescription ¶

StudyDescription: str = 'NA'

StudyDescription

StudyID ¶

StudyID: str = 'NA'

StudyID

StudyInstanceUID ¶

StudyInstanceUID: str = 'NA'

StudyInstanceUID

StudyTime ¶

StudyTime: str = 'NA'

StudyTime

series ¶

series: list[SeriesData] = Field(default_factory=list)

series

modalities_in_study_is_list ¶

modalities_in_study_is_list(value: str | list) -> list[str]

Validator to make sure the ModalitiesInStudy is a list.

set_patient_name ¶

set_patient_name(value: PersonName | str) -> str

Validator to decode the patient name from PersonName.