DicomModifyMLToRTDosePlugin¶
- MLModule¶
author
package
dll
definition
see also
RTDoseToML,RTDoseInfo,ModifyDicomTree,CreateEmptyRTObjectkeywords
Purpose¶
DicomModifyMLToRTDosePlugin converts inCSOList, inRTPlan, input0 and input1 to Structure Set ROI Sequence (3006,0020), RT Dose ROI Sequence (3004,0010), ROI Contour Sequence (3006,0039), Referenced Frame of Reference Sequence (3006,0010) and Referenced RT Plan Sequence (300c,0002). The sequences can be added to a DICOM tree via ModifyDicomTree along with other tag modifications. For all modifications performed by this module see Details section.
Usage¶
See example network to see how to use DicomModifyMLToRTDosePlugin.
Details¶
The module performs the following:
- Frame Of Reference Module:
Frame Of Reference UID (0020,0052) is set to
input0’s Frame Of Reference UID.
- Multi-Frame Module:
Frame Increment Pointer (0028,0009) is set to “(3004,000c)”.
- RT Dose Module:
Dose Units (3004,0002) is set to
Dose Units.Dose Type (3004,0004) is set to
Dose Type.Dose Summation Type (3004,000a) is set to
Dose Summation Type.- Referenced RT Plan Sequence (300c,0002) is added. If
Dose Summation Typeequals PLAN, FRACTION, BEAM, FRACTION_SESSION, BEAM_SESSION, one item item0 is added: item0’s Referenced SOP Class UID (0008,1150) is set to 1.2.840.10008.5.1.4.1.1.481.5.
item0’s Referenced SOP Instance UID (0008,1155) is set to
inRTPlan’s SOP Instance UID (0008,0018).- Referenced Fraction Group Sequence (300c,0020) is added to the item0. Sequence contains one item item1:
item1’s Referenced Fraction Group Number is set to
Referenced Fraction Group Number.- If
Dose Summation Typeequals BEAM or BEAM_SESSION, Referenced Beam Sequence (300c,0004) is added to the item1. For each entry in theReferenced Beam Numbers(1..i..n, n - number of entries) an item item2 is added to the sequence: item2’s Referenced Beam Number (300c,0006) is set to
Referenced Beam Numbersi th entry.
- If
- Referenced RT Plan Sequence (300c,0002) is added. If
- Structure Set Module:
- Referenced Frame of Reference Sequence (3006,0010) is added. Sequence contains one item item0:
item0’s Frame of Reference UID (0020,0052) is set to
input0’s Frame Of Reference UID.- RT Referenced Study Sequence (3006,0012) is added to the item0. Sequence contains one item item1:
item1’s Referenced SOP Class UID (0008,1150) is set to 1.2.840.10008.3.1.2.3.2 (Study Component Management SOP Class (Retired)).
item1’s Referenced SOP Instance UID (0008,1155) is set to
input0’s Study Instance UID (0020, 000d).- RT Referenced Series Sequence (3006,0014) is added to the item1. Sequence contains one item item2:
item2’s Series Instance UID (0020,000e) is set to
input0’s Series Instance UID.- Contour Image Sequence (3006,0016) is added to the item2. For each
input0’s slice with at least one CSO an item item3 is added: item3’s Referenced Frame Number (0008,1160) is set to 1.
item3’s Referenced SOP Class UID (0008,1150) is set to
input0’s SOP Class UID (0008,0016).item3’s Referenced SOP Instance UID (0008,1155) is set to slice’s SOP Instance UID (0008,0018).
- Contour Image Sequence (3006,0016) is added to the item2. For each
- Structure Set ROI Sequence (3006,0020) is added. For each
inCSOList’s CSOGroup (1..i..n, n - number of CSOGroups) an item item is added: item’s ROI Number (3006,0022) is set to i.
item’s Referenced Frame Of Referenced UID (3006,0024) is set to
input0’s Frame of Reference UID (0020,0052).item’s ROI Name (3006,0026) is set to CSOGroup’s label.
item’s ROI Description (3006,0028) is set to CSOGroup’s description.
- Structure Set ROI Sequence (3006,0020) is added. For each
- ROI Contour Module:
- ROI Contour Sequence (3006,0039) is added. For each
inCSOList’s CSOGroup (1..i..n, n - number of CSOGroups) an item item0 is added: item0’s Referenced ROI Number (3006,0084) is set to i.
item0’s ROI Display Color (3006,002a) is set to CSOGroup’s path point color.
- Contour Sequence (3006,0040) is added to the item0. For each CSOGroup’s CSO (1..j..m, m - number of CSOs) an item item1 is added:
item1’s Contour Number (3006,0048) is set to j.
- item1’s Contour Geometric Type (3006,0042) is set to:
“POINT” if CSO is of “SUB_TYPE_POINT” sub type.
“CLOSED_PLANAR” if CSO is of “SUB_TYPE_CLOSED_POLYLINE” sub type and is closed.
“OPEN_PLANAR” if CSO is of “SUB_TYPE_OPEN_POLYLINE” sub type, is not closed and is in plane.
“OPEN_NONPLANAR” if CSO is of “SUB_TYPE_OPEN_POLYLINE” sub type, is not closed and is not in plane.
item1’s Contour Slab Thickness (3006,0044) is set to
input0’s Slice Thickness (0018,0050).item1’s Number Of Contour Points (3006,0046) is set to CSO’s total number of unique path points.
item1’s Contour Data (3006,0050) is set to coordinates of CSO’s path points.
- ROI Contour Sequence (3006,0039) is added. For each
- RT ROI Observations Module:
- RT ROI Observations Sequence (3006,0080) is added. For each
inCSOList’s CSOGroup (1..i..n, n - number of CSOGroups) an item item is added: item’s Observation Number (3006,0082) is set to i.
item’s Referenced ROI Number (3006,0084) is set to i.
item’s RT ROI Interpreted Type (3006,00a4) is set to CSOGroup’s user data found under key “RTROIInterpretedType”.
- RT ROI Observations Sequence (3006,0080) is added. For each
Windows¶
Default Panel¶
Input Fields¶
input0¶
- name: input0, type: Image¶
Input CT image.
input1¶
- name: input1, type: Image¶
Input dose image.
inCSOList¶
- name: inCSOList, type: MLBase¶
Input CSO List.
inputModifierList¶
- name: inputModifierList, type: MLBase¶
Here other DicomModifyPlugin module can be connected in order to apply further modification to a DICOM tree.
inRTPlan¶
- name: inRTPlan, type: MLBase¶
Input RTPlan.
Output Fields¶
outputModifierList¶
- name: outputModifierList, type: MLBase¶
The
outputModifierListfields provides a reference-counted Base object to be connected to other DicomModifyPlugin modules or toModifyDicomTreeto apply modifications to a DICOM tree.
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
Visible Fields¶
Precision¶
- name: precision, type: Integer, default: 2, minimum: 0¶
Contour data numerical precision.
Dose Summation Type¶
- name: doseSummationType, type: Enum, default: PLAN¶
Values:
Title |
Name |
|---|---|
Multi Plan |
MULTI_PLAN |
Plan |
PLAN |
Fraction |
FRACTION |
Beam |
BEAM |
Brachy |
BRACHY |
Fraction Session |
FRACTION_SESSION |
Beam Session |
BEAM_SESSION |
Brachy Session |
BRACHY_SESSION |
Control Point |
CONTROL_POINT |
Record |
RECORD |
Dose Units¶
- name: doseUnits, type: Enum, default: GY¶
Values:
Title |
Name |
|---|---|
Gy |
GY |
Relative |
RELATIVE |
Dose Type¶
- name: doseType, type: Enum, default: PHYSICAL¶
Values:
Title |
Name |
|---|---|
Physical |
PHYSICAL |
Effective |
EFFECTIVE |
Error |
ERROR |
Referenced Fraction Group Number¶
- name: referencedFractionGroupNumber, type: Integer, default: 0¶
Referenced Beam Numbers¶
- name: referencedBeamNumbers, type: String¶