monai.deploy.core.domain.StudySelectedSeries¶

class monai.deploy.core.domain.StudySelectedSeries(study, metadata=None)[source]¶

This class encapsulates a DICOM study and a list of selected DICOM series within it.

It references the DICOMStudy object and a dictionary of SelectedSeries objects.

Creates a instance with a DICOMStudy object.

Parameters

study (DICOMStudy) – The DICOMStudy object referenced.
metadata (Optional[Dict], optional) – Metadata dictionary for the instance. Defaults to None.

Raises

ValueError – If argument study is not a DICOMStudy object.

Methods

__init__(study[, metadata])

Creates a instance with a DICOMStudy object.

Adds a SelectedSeries object in the referenced DICOMStudy.

metadata()

Attributes

`selected_series`	Returns a view of the list of all the SelectedSeries objects.
`series_by_selection_name`	Returns the list of SelectedSeries by selection names in a dictionary.
`study`	Returns the DICOMStudy object referenced.

__init__(study, metadata=None)[source]¶

Creates a instance with a DICOMStudy object.

Parameters

study (DICOMStudy) – The DICOMStudy object referenced.
metadata (Optional[Dict], optional) – Metadata dictionary for the instance. Defaults to None.

Raises

ValueError – If argument study is not a DICOMStudy object.

add_selected_series(selected_series)[source]¶

Adds a SelectedSeries object in the referenced DICOMStudy.

The SelectedSeries object is grouped by the selection name in a list, so there could be one or more objects for a given selection name.

Parameters: selected_series (SelectedSeries) – The reference of the SelectedSeries object.
Raises: ValueError – If argument selected_series is not a SelectedSeries object.
Return type: None

property selected_series: List[monai.deploy.core.domain.dicom_series_selection.SelectedSeries]¶

Returns a view of the list of all the SelectedSeries objects.

property series_by_selection_name: Dict¶

Returns the list of SelectedSeries by selection names in a dictionary.

Returns: Dictionary with selection name as key and list of SelectedSeries as value.
Return type: Dict

property study: monai.deploy.core.domain.dicom_study.DICOMStudy¶

Returns the DICOMStudy object referenced.