Enumeration: MetadataModules
Contains the names for the metadata modules. Recommendation is to add all module names here rather than having them just use string names. The naming convention is that the enum has the modules in it, so the enum key does not repeat the Modules, but the enum value does (to agree with existing naming conventions)
Enumeration Members
CALIBRATION
CALIBRATION:
"calibrationModule"
Defined in
packages/core/src/enums/MetadataModules.ts:10
CINE
CINE:
"cineModule"
Defined in
packages/core/src/enums/MetadataModules.ts:11
FRAME_MODULE
FRAME_MODULE:
"frameModule"
The frame module is used to get information on the number of frames in the sop instance, and the current frame number, independently of the registration method.
Defined in
packages/core/src/enums/MetadataModules.ts:35
GENERAL_IMAGE
GENERAL_IMAGE:
"generalImageModule"
Defined in
packages/core/src/enums/MetadataModules.ts:12
GENERAL_SERIES
GENERAL_SERIES:
"generalSeriesModule"
Defined in
packages/core/src/enums/MetadataModules.ts:13
GENERAL_STUDY
GENERAL_STUDY:
"generalStudyModule"
Defined in
packages/core/src/enums/MetadataModules.ts:14
IMAGE_DATA
IMAGE_DATA:
"ImageData"
The image data module has the image specific information associated with the image frame of interest.
This is used when modifying study structure such as creating a multiframe reference used internally for segmentation.
Defined in
packages/core/src/enums/MetadataModules.ts:109
IMAGE_PIXEL
IMAGE_PIXEL:
"imagePixelModule"
Defined in
packages/core/src/enums/MetadataModules.ts:15
IMAGE_PLANE
IMAGE_PLANE:
"imagePlaneModule"
Defined in
packages/core/src/enums/MetadataModules.ts:16
IMAGE_SOP_INSTANCE_REFERENCE
IMAGE_SOP_INSTANCE_REFERENCE:
"ImageSopInstanceReference"
Reference object for the frame of the imageId provided
Defined in
packages/core/src/enums/MetadataModules.ts:67
IMAGE_URL
IMAGE_URL:
"imageUrlModule"
Defined in
packages/core/src/enums/MetadataModules.ts:17
INSTANCE
INSTANCE:
"instance"
Some modules rely on an instance access to the full metadata. WARNING: This may not be available or may be expensive to create, use with caution. If you can use the existing modules, that is recommended instead.
Defined in
packages/core/src/enums/MetadataModules.ts:53
MODALITY_LUT
MODALITY_LUT:
"modalityLutModule"
Defined in
packages/core/src/enums/MetadataModules.ts:18
MULTIFRAME
MULTIFRAME:
"multiframeModule"
Defined in
packages/core/src/enums/MetadataModules.ts:19
NEW_INSTANCE_DATA
NEW_INSTANCE_DATA:
"NewInstanceData"
Generic new instance data, including study and new series instance data.
Defined in
packages/core/src/enums/MetadataModules.ts:123
NM_MULTIFRAME_GEOMETRY
NM_MULTIFRAME_GEOMETRY:
"nmMultiframeGeometryModule"
Defined in
packages/core/src/enums/MetadataModules.ts:20
OVERLAY_PLANE
OVERLAY_PLANE:
"overlayPlaneModule"
Defined in
packages/core/src/enums/MetadataModules.ts:21
PATIENT
PATIENT:
"patientModule"
Defined in
packages/core/src/enums/MetadataModules.ts:22
PATIENT_STUDY
PATIENT_STUDY:
"patientStudyModule"
Defined in
packages/core/src/enums/MetadataModules.ts:23
PET_IMAGE
PET_IMAGE:
"petImageModule"
Defined in
packages/core/src/enums/MetadataModules.ts:24
PET_ISOTOPE
PET_ISOTOPE:
"petIsotopeModule"
Defined in
packages/core/src/enums/MetadataModules.ts:25
PET_SERIES
PET_SERIES:
"petSeriesModule"
Defined in
packages/core/src/enums/MetadataModules.ts:26
PREDECESSOR_SEQUENCE
PREDECESSOR_SEQUENCE:
"PredecessorSequence"
Creates a predecessor sequence to indicate the new object replaces the old one.
Also includes the series level attributes that this object has in order to allow placing the new instance into the same series.
Defined in
packages/core/src/enums/MetadataModules.ts:83
REFERENCED_SERIES_REFERENCE
REFERENCED_SERIES_REFERENCE:
"ReferencedSeriesReference"
Reference object starting with the series to the sop instance provided.
This will likely need to be merged with other series references
Defined in
packages/core/src/enums/MetadataModules.ts:74
RTSS_CONTOUR
RTSS_CONTOUR:
"metaRTSSContour"
Metadata module for RTSS contour
Defined in
packages/core/src/enums/MetadataModules.ts:129
RTSS_INSTANCE_DATA
RTSS_INSTANCE_DATA:
"RtssInstanceData"
The basic header data for new RTSS instances
Defined in
packages/core/src/enums/MetadataModules.ts:119
SEG_BIT
SEG_BIT:
"metaSegBitmap"
Metadata module for single bit segmentation
Defined in
packages/core/src/enums/MetadataModules.ts:131
SERIES_DATA
SERIES_DATA:
"SeriesData"
The Series Data module contains the normalized values associated with the series object, PLUS the study instance uid.
This should be combined with the study data to add new instances to an existing series.
Defined in
packages/core/src/enums/MetadataModules.ts:100
SOP_COMMON
SOP_COMMON:
"sopCommonModule"
Defined in
packages/core/src/enums/MetadataModules.ts:27
SR_ANNOTATION
SR_ANNOTATION:
"metaSrAnnotation"
Metadata module for RTSS annotations
Defined in
packages/core/src/enums/MetadataModules.ts:133
STUDY_DATA
STUDY_DATA:
"StudyData"
The study data module contains the normalized values associated with the study header, including StudyInstanceUID, PatientID and the other cross- study information.
This should be used as a basis for adding a new series to an existing study.
Defined in
packages/core/src/enums/MetadataModules.ts:92
ULTRASOUND_ENHANCED_REGION
ULTRASOUND_ENHANCED_REGION:
"ultrasoundEnhancedRegionModule"
Defined in
packages/core/src/enums/MetadataModules.ts:28
VOI_LUT
VOI_LUT:
"voiLutModule"
Defined in
packages/core/src/enums/MetadataModules.ts:29
WADO_WEB_CLIENT
WADO_WEB_CLIENT:
"wadoWebClient"
Some modules need direct access to a data services (WADO) web client. This allows getting images and metadata as raw results for display. This is DICOMweb WADO, not base WADO, and should support:
- Series level metadata retrieve
- Bulkdata retrieve
- Image retrieve