monai.deploy.core.domain.SelectedSeries¶
- class monai.deploy.core.domain.SelectedSeries(selection_name, dicom_series, image=None, metadata=None)[source]¶
Bases:
monai.deploy.core.domain.domain.Domain
This class encapsulates a DICOM series that has been selected with a given selection name.
It references the DICOMSeries object with the name associated with selection, and a Image if applicable.
Creates an instance of this class
- Parameters
selection_name (str) – Name given to this selection, if None, then series instance UID is used.
dicom_series (DICOMSeries) – The referenced DICOMSeries object.
image (Optional[Image], optional) – Converted image of the series, if applicable. Defaults to None.
metadata (Optional[Dict], optional) – Metadata dictionary for the instance. Defaults to None.
- Raises
ValueError – If argument dicom_series is not a DICOMSeries object.
Methods
__init__
(selection_name, dicom_series[, …])Creates an instance of this class
metadata
()- rtype
Dict
Attributes
image
- rtype
Optional
[Image
]
selection_name
- rtype
str
series
- rtype
- __init__(selection_name, dicom_series, image=None, metadata=None)[source]¶
Creates an instance of this class
- Parameters
selection_name (str) – Name given to this selection, if None, then series instance UID is used.
dicom_series (DICOMSeries) – The referenced DICOMSeries object.
image (Optional[Image], optional) – Converted image of the series, if applicable. Defaults to None.
metadata (Optional[Dict], optional) – Metadata dictionary for the instance. Defaults to None.
- Raises
ValueError – If argument dicom_series is not a DICOMSeries object.