rtp-connect 1.5 → 1.6

data/CHANGELOG.rdoc

@@ -1,3 +1,22 @@
+= 1.6
+
+=== 12th December, 2013
+
+* Plan#to_dcm improvements:
+  * Added support for VMAT by improving the handling of control point conversion.
+  * Made dose reference sequences optional.
+  * Order beam limiting device items alphabetically.
+  * Added rudimentary support for scale conversion (scale convention = 1 in control point records).
+  * More robust extraction of jaw position.
+  * More robust handling of cases with missing structure set in the RTP file.
+  * Add support for tolerance table sequence.
+  * Fixed a bug with missing leaf boundary value for 80 and 160 leaf MLCs.
+  * Switched to using fractional cumulative meterset weight, which seems to be more commonly used in commercial systems.
+  * Don't create an SSD DICOM element if the SSD attribute in the RTP file is undefined.
+  * Only write control point attributes which have changed since the previous/initial control point of each beam.
+  * Make sure that the last cumulative meterset weight exactly equals the final cumulative meterset weight.
+
+
 = 1.5
 
 === 24th October, 2013

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rtp-connect (1.5)
+    rtp-connect (1.6)
 
 GEM
   remote: http://www.rubygems.org/

data/lib/rtp-connect/control_point.rb

@@ -143,6 +143,57 @@ module RTP
       return Array.new
     end
 
+    # Converts the collimator_x1 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_x1 attribute
+    #
+    def dcm_collimator_x1
+      attribute = (scale_convertion? ? :collimator_y1 : :collimator_x1)
+      target = (@field_x_mode && !@field_x_mode.empty? ? self : @parent)
+      target.send(attribute).to_f * 10 * scale_factor
+    end
+
+    # Converts the collimator_x2 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_x2 attribute
+    #
+    def dcm_collimator_x2
+      attribute = (scale_convertion? ? :collimator_y2 : :collimator_x2)
+      target = (@field_x_mode && !@field_x_mode.empty? ? self : @parent)
+      target.send(attribute).to_f * 10
+    end
+
+    # Converts the collimator_y1 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_y1 attribute
+    #
+    def dcm_collimator_y1
+      attribute = (scale_convertion? ? :collimator_x1 : :collimator_y1)
+      target = (@field_y_mode && !@field_y_mode.empty? ? self : @parent)
+      target.send(attribute).to_f * 10 * scale_factor
+    end
+
+    # Converts the collimator_y2 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_y2 attribute
+    #
+    def dcm_collimator_y2
+      attribute = (scale_convertion? ? :collimator_x2 : :collimator_y2)
+      target = (@field_y_mode && !@field_y_mode.empty? ? self : @parent)
+      target.send(attribute).to_f * 10
+    end
+
+    # Converts the mlc_lp_a & mlc_lp_b attributes to a proper DICOM formatted string.
+    #
+    # @return [String] the DICOM-formatted leaf pair positions
+    #
+    def dcm_mlc_positions
+      # As with the collimators, the first side (1/a) may need scale invertion:
+      pos_a = @mlc_lp_a.collect{|p| (p.to_f * 10 * scale_factor).round(1) unless p.empty?}.compact
+      pos_b = @mlc_lp_b.collect{|p| (p.to_f * 10).round(1) unless p.empty?}.compact
+      (pos_a + pos_b).join("\\")
+    end
+
     # Computes a hash code for this object.
     #
     # @note Two objects with the same attributes will have the same hash code.
@@ -526,6 +577,33 @@ module RTP
     #
     alias_method :state, :values
 
+    # Checks whether the contents of the this record indicates that scale
+    # convertion is to be applied. This convertion entails converting a value
+    # from IEC1217 format to the target machine's native readout format.
+    # Note that the scope of this scale conversion is not precisely known (the
+    # current implementation is based on a few observations made from a single
+    # RTP file).
+    #
+    # @return [Boolean] true if the scale convention attribute indicates scale convertion
+    #
+    def scale_convertion?
+      # A scale convention of 1 means that geometric parameters are represented
+      # in the target machine's native readout format, as opposed to the IEC 1217
+      # convention. The consequences of this is not totally clear, but at least for
+      # an Elekta device, there are a number of convertions which seems to be indicated.
+      @scale_convention.to_i == 1 ? true : false
+    end
+
+    # Gives a factor used for scale convertion, which depends on the
+    # 'scale_convention' attribute.
+    #
+    # @param [Numerical] value the value to process
+    # @return [Numerical] the scale converted value
+    #
+    def scale_factor
+      scale_convertion? ? -1 : 1
+    end
+
   end
 
 end

data/lib/rtp-connect/methods.rb

@@ -20,7 +20,7 @@ module RTP
           -15, -5, 5, 15, 25, 35, 45, 55, 65, 75, 85, 95, 105, 115, 125, 135, 200
         ]
       when 40
-        Array.new(nr_leaves) {|i| (i * 400 / nr_leaves.to_f - 200).to_i}
+        Array.new(nr_leaves+1) {|i| (i * 400 / nr_leaves.to_f - 200).to_i}
       when 41
         [-200, -195, -185, -175, -165, -155, -145, -135, -125, -115,
           -105, -95, -85, -75, -65, -55, -45, -35, -25, -15, -5, 5, 15, 25, 35, 45,
@@ -33,7 +33,7 @@ module RTP
           70, 75, 80, 85, 90, 95, 100, 110, 120, 130, 140, 150, 160, 170, 180, 190, 200
         ]
       when 80
-        Array.new(nr_leaves) {|i| (i * 400 / nr_leaves.to_f - 200).to_i}
+        Array.new(nr_leaves+1) {|i| (i * 400 / nr_leaves.to_f - 200).to_i}
       else
         raise ArgumentError, "Unsupported number of leaves: #{nr_leaves}"
       end

data/lib/rtp-connect/plan_to_dcm.rb

@@ -5,11 +5,12 @@ module RTP
     # Converts the Plan (and child) records to a
     # DICOM::DObject of modality RTPLAN.
     #
-    # @note Only static photon plans have been tested.
-    #   Electron beams or dynamic photon beams may give an invalid DICOM file.
+    # @note Only photon plans have been tested.
+    #   Electron beams beams may give an invalid DICOM file.
     #   Also note that, due to limitations in the RTP file format, some original
     #   values can not be recreated, like e.g. Study UID or Series UID.
     # @param [Hash] options the options to use for creating the DICOM object
+    # @option options [Boolean] :dose_ref if set, Dose Reference & Referenced Dose Reference sequences will be included in the generated DICOM file
     # @option options [String] :manufacturer the value used for the manufacturer tag (0008,0070) in the beam sequence
     # @option options [String] :model the value used for the manufacturer's model name tag (0008,1090) in the beam sequence
     # @option options [String] :serial_number the value used for the device serial number tag (0018,1000) in the beam sequence
@@ -103,27 +104,34 @@ module RTP
       # RT Plan Time:
       plan_time = @plan_time.empty? ? Time.now.strftime("%H%M%S") : @plan_time
       DICOM::Element.new('300A,0007', plan_time, :parent => dcm)
-      # RT Plan Geometry:
-      DICOM::Element.new('300A,000C', 'PATIENT', :parent => dcm)
       # Approval Status:
       DICOM::Element.new('300E,0002', 'UNAPPROVED', :parent => dcm)
       #
       # SEQUENCES:
       #
-      #
-      # Referenced Structure Set Sequence:
-      #
-      ss_seq = DICOM::Sequence.new('300C,0060', :parent => dcm)
-      ss_item = DICOM::Item.new(:parent => ss_seq)
-      # Referenced SOP Class UID:
-      DICOM::Element.new('0008,1150', '1.2.840.10008.5.1.4.1.1.481.3', :parent => ss_item)
-      # Referenced SOP Instance UID (if an original UID is not present, we make up a UID):
-      begin
-        ref_ss_uid = p.site_setup.structure_set_uid.empty? ? DICOM.generate_uid : p.site_setup.structure_set_uid
-      rescue
-        ref_ss_uid = DICOM.generate_uid
+      # Tolerance Table Sequence:
+      if p && p.fields.first && !p.fields.first.tolerance_table.empty?
+        tt_seq = DICOM::Sequence.new('300A,0040', :parent => dcm)
+        tt_item = DICOM::Item.new(:parent => tt_seq)
+        # Tolerance Table Number:
+        DICOM::Element.new('300A,0042', p.fields.first.tolerance_table, :parent => tt_item)
+      end
+      # Structure set information:
+      if p && p.site_setup && !p.site_setup.structure_set_uid.empty?
+        #
+        # Referenced Structure Set Sequence:
+        #
+        ss_seq = DICOM::Sequence.new('300C,0060', :parent => dcm)
+        ss_item = DICOM::Item.new(:parent => ss_seq)
+        # Referenced SOP Class UID:
+        DICOM::Element.new('0008,1150', '1.2.840.10008.5.1.4.1.1.481.3', :parent => ss_item)
+        DICOM::Element.new('0008,1155', p.site_setup.structure_set_uid, :parent => ss_item)
+        # RT Plan Geometry:
+        DICOM::Element.new('300A,000C', 'PATIENT', :parent => dcm)
+      else
+        # RT Plan Geometry:
+        DICOM::Element.new('300A,000C', 'TREATMENT_DEVICE', :parent => dcm)
       end
-      DICOM::Element.new('0008,1155', ref_ss_uid, :parent => ss_item)
       #
       # Patient Setup Sequence:
       #
@@ -143,16 +151,7 @@ module RTP
       #
       # Dose Reference Sequence:
       #
-      dr_seq = DICOM::Sequence.new('300A,0010', :parent => dcm)
-      dr_item = DICOM::Item.new(:parent => dr_seq)
-      # Dose Reference Number:
-      DICOM::Element.new('300A,0012', '1', :parent => dr_item)
-      # Dose Reference Structure Type:
-      DICOM::Element.new('300A,0014', 'SITE', :parent => dr_item)
-      # Dose Reference Description:
-      DICOM::Element.new('300A,0016', plan_name, :parent => dr_item)
-      # Dose Reference Type:
-      DICOM::Element.new('300A,0020', 'TARGET', :parent => dr_item)
+      create_dose_reference(dcm, plan_name) if options[:dose_ref]
       #
       # Fraction Group Sequence:
       #
@@ -183,6 +182,8 @@ module RTP
           unless field.modality == 'Unspecified'
             # If this is an electron beam, a warning should be printed, as these are less reliably converted:
             logger.warn("This is not a photon beam (#{field.modality}). Beware that DICOM conversion of Electron beams are experimental, and other modalities are unsupported.") if field.modality != 'Xrays'
+            # Reset control point 'current value' attributes:
+            reset_cp_current_attributes
             # Beam number and name:
             beam_number = field.extended_field ? field.extended_field.original_beam_number : (i + 1).to_s
             beam_name = field.extended_field ? field.extended_field.original_beam_name : field.field_name
@@ -220,6 +221,7 @@ module RTP
             beam_type = case field.treatment_type
               when 'Static' then 'STATIC'
               when 'StepNShoot' then 'STATIC'
+              when 'VMAT' then 'DYNAMIC'
               else logger.error("The beam type (treatment type) #{field.treatment_type} is not yet supported.")
             end
             DICOM::Element.new('300A,00C4', beam_type, :parent => b_item)
@@ -241,36 +243,13 @@ module RTP
             # Number of Blocks:
             DICOM::Element.new('300A,00F0', (field.block.empty? ? '0' : '1'), :parent => b_item)
             # Final Cumulative Meterset Weight:
-            DICOM::Element.new('300A,010E', field.field_monitor_units, :parent => b_item)
+            DICOM::Element.new('300A,010E', 1, :parent => b_item)
             # Referenced Patient Setup Number:
             DICOM::Element.new('300C,006A', '1', :parent => b_item)
             #
             # Beam Limiting Device Sequence:
             #
-            bl_seq = DICOM::Sequence.new('300A,00B6', :parent => b_item)
-            # Always create one ASYMY item:
-            bl_item_y = DICOM::Item.new(:parent => bl_seq)
-            # RT Beam Limiting Device Type:
-            DICOM::Element.new('300A,00B8', "ASYMY", :parent => bl_item_y)
-            # Number of Leaf/Jaw Pairs:
-            DICOM::Element.new('300A,00BC', "1", :parent => bl_item_y)
-            # The ASYMX item ('backup jaws') only exsists on some models:
-            if ['SYM', 'ASY'].include?(field.field_x_mode.upcase)
-              bl_item_x = DICOM::Item.new(:parent => bl_seq)
-              DICOM::Element.new('300A,00B8', "ASYMX", :parent => bl_item_x)
-              DICOM::Element.new('300A,00BC', "1", :parent => bl_item_x)
-            end
-            # MLCX item is only created if leaves are defined:
-            # (NB: The RTP file doesn't specify leaf position boundaries, so we
-            # have to set these based on a set of known MLC types, their number
-            # of leaves, and their leaf boundary positions.)
-            if field.control_points.length > 0
-              bl_item_mlcx = DICOM::Item.new(:parent => bl_seq)
-              DICOM::Element.new('300A,00B8', "MLCX", :parent => bl_item_mlcx)
-              num_leaves = field.control_points.first.mlc_leaves.to_i
-              DICOM::Element.new('300A,00BC', num_leaves.to_s, :parent => bl_item_mlcx)
-              DICOM::Element.new('300A,00BE', "#{RTP.leaf_boundaries(num_leaves).join("\\")}", :parent => bl_item_mlcx)
-            end
+            create_beam_limiting_devices(b_item, field)
             #
             # Block Sequence (if any):
             # FIXME: It seems that the Block Sequence (300A,00F4) may be
@@ -340,189 +319,25 @@ module RTP
                 DICOM::Element.new('300A,012C', '', :parent => cp_item)
               end
               # Source to Surface Distance:
-              DICOM::Element.new('300A,0130', "#{field.ssd.to_f * 10}", :parent => cp_item)
+              add_ssd(field.ssd, cp_item)
               # Cumulative Meterset Weight:
-              DICOM::Element.new('300A,0134', "0.0", :parent => cp_item)
+              DICOM::Element.new('300A,0134', '0', :parent => cp_item)
               # Beam Limiting Device Position Sequence:
-              dp_seq = DICOM::Sequence.new('300A,011A', :parent => cp_item)
-              # Always create one ASYMY item:
-              dp_item_y = DICOM::Item.new(:parent => dp_seq)
-              # RT Beam Limiting Device Type:
-              DICOM::Element.new('300A,00B8', "ASYMY", :parent => dp_item_y)
-              # Leaf/Jaw Positions:
-              DICOM::Element.new('300A,011C', "#{field.collimator_y1.to_f * 10}\\#{field.collimator_y2.to_f * 10}", :parent => dp_item_y)
-              # The ASYMX item ('backup jaws') only exsists on some models:
-              if ['SYM', 'ASY'].include?(field.field_x_mode.upcase)
-                dp_item_x = DICOM::Item.new(:parent => dp_seq)
-                DICOM::Element.new('300A,00B8', "ASYMX", :parent => dp_item_x)
-                DICOM::Element.new('300A,011C', "#{field.collimator_x1.to_f * 10}\\#{field.collimator_x2.to_f * 10}", :parent => dp_item_x)
-              end
-              # MLCX:
-              if field.control_points.length > 0
-                dp_item_mlcx = DICOM::Item.new(:parent => dp_seq)
-                # RT Beam Limiting Device Type:
-                DICOM::Element.new('300A,00B8', "MLCX", :parent => dp_item_mlcx)
-                # Leaf/Jaw Positions:
-                pos_a = field.control_points.first.mlc_lp_a.collect{|p| (p.to_f * 10).round(2) unless p.empty?}.compact
-                pos_b = field.control_points.first.mlc_lp_b.collect{|p| (p.to_f * 10).round(2) unless p.empty?}.compact
-                leaf_pos = "#{pos_a.join("\\")}\\#{pos_b.join("\\")}"
-                DICOM::Element.new('300A,011C', leaf_pos, :parent => dp_item_mlcx)
-              end
+              create_beam_limiting_device_positions(cp_item, field.control_points.first)
               # Referenced Dose Reference Sequence:
-              rd_seq = DICOM::Sequence.new('300C,0050', :parent => cp_item)
-              rd_item = DICOM::Item.new(:parent => rd_seq)
-              # Cumulative Dose Reference Coeffecient:
-              DICOM::Element.new('300A,010C', '', :parent => rd_item)
-              # Referenced Dose Reference Number:
-              DICOM::Element.new('300C,0051', '1', :parent => rd_item)
+              create_referenced_dose_reference(cp_item) if options[:dose_ref]
               # Second CP:
               cp_item = DICOM::Item.new(:parent => cp_seq)
               # Control Point Index:
               DICOM::Element.new('300A,0112', "1", :parent => cp_item)
               # Cumulative Meterset Weight:
-              DICOM::Element.new('300A,0134', field.field_monitor_units, :parent => cp_item)
+              DICOM::Element.new('300A,0134', '1', :parent => cp_item)
             else
-              # When we have multiple (2n) control points, iterate and pick settings from the CPs:
-              field.control_points.each_slice(2) do |cp1, cp2|
-                cp_item1 = DICOM::Item.new(:parent => cp_seq)
-                cp_item2 = DICOM::Item.new(:parent => cp_seq)
-                # First control point:
-                # Control Point Index:
-                DICOM::Element.new('300A,0112', "#{cp1.index}", :parent => cp_item1)
-                # Nominal Beam Energy:
-                DICOM::Element.new('300A,0114', "#{cp1.energy.to_f}", :parent => cp_item1)
-                # Dose Rate Set:
-                DICOM::Element.new('300A,0115', cp1.doserate, :parent => cp_item1)
-                # Gantry Angle:
-                DICOM::Element.new('300A,011E', cp1.gantry_angle, :parent => cp_item1)
-                # Gantry Rotation Direction:
-                DICOM::Element.new('300A,011F', (cp1.gantry_dir.empty? ? 'NONE' : cp1.gantry_dir), :parent => cp_item1)
-                # Beam Limiting Device Angle:
-                DICOM::Element.new('300A,0120', cp1.collimator_angle, :parent => cp_item1)
-                # Beam Limiting Device Rotation Direction:
-                DICOM::Element.new('300A,0121', (cp1.collimator_dir.empty? ? 'NONE' : cp1.collimator_dir), :parent => cp_item1)
-                # Patient Support Angle:
-                DICOM::Element.new('300A,0122', cp1.couch_pedestal, :parent => cp_item1)
-                # Patient Support Rotation Direction:
-                DICOM::Element.new('300A,0123', (cp1.couch_ped_dir.empty? ? 'NONE' : cp1.couch_ped_dir), :parent => cp_item1)
-                # Table Top Eccentric Angle:
-                DICOM::Element.new('300A,0125', cp1.couch_angle, :parent => cp_item1)
-                # Table Top Eccentric Rotation Direction:
-                DICOM::Element.new('300A,0126', (cp1.couch_dir.empty? ? 'NONE' : cp1.couch_dir), :parent => cp_item1)
-                # Table Top Vertical Position:
-                couch_vert = cp1.couch_vertical.empty? ? '' : (cp1.couch_vertical.to_f * 10).to_s
-                DICOM::Element.new('300A,0128', couch_vert, :parent => cp_item1)
-                # Table Top Longitudinal Position:
-                couch_long = cp1.couch_longitudinal.empty? ? '' : (cp1.couch_longitudinal.to_f * 10).to_s
-                DICOM::Element.new('300A,0129', couch_long, :parent => cp_item1)
-                # Table Top Lateral Position:
-                couch_lat = cp1.couch_lateral.empty? ? '' : (cp1.couch_lateral.to_f * 10).to_s
-                DICOM::Element.new('300A,012A', couch_lat, :parent => cp_item1)
-                # Isocenter Position (x\y\z):
-                if p.site_setup
-                  DICOM::Element.new('300A,012C', "#{(p.site_setup.iso_pos_x.to_f * 10).round(2)}\\#{(p.site_setup.iso_pos_y.to_f * 10).round(2)}\\#{(p.site_setup.iso_pos_z.to_f * 10).round(2)}", :parent => cp_item1)
-                else
-                  logger.warn("No Site Setup record exists for this plan. Unable to provide an isosenter position.")
-                  DICOM::Element.new('300A,012C', '', :parent => cp_item1)
-                end
-                # Source to Surface Distance:
-                DICOM::Element.new('300A,0130', "#{cp1.ssd.to_f * 10}", :parent => cp_item1)
-                # Cumulative Meterset Weight:
-                mu_weight = (cp1.monitor_units.to_f * field.field_monitor_units.to_f).round(4)
-                DICOM::Element.new('300A,0134', "#{mu_weight}", :parent => cp_item1)
-                # Beam Limiting Device Position Sequence:
-                dp_seq = DICOM::Sequence.new('300A,011A', :parent => cp_item1)
-                # Always create one ASYMY item:
-                dp_item_y = DICOM::Item.new(:parent => dp_seq)
-                # RT Beam Limiting Device Type:
-                DICOM::Element.new('300A,00B8', "ASYMY", :parent => dp_item_y)
-                # Leaf/Jaw Positions:
-                DICOM::Element.new('300A,011C', "#{field.collimator_y1.to_f * 10}\\#{field.collimator_y2.to_f * 10}", :parent => dp_item_y)
-                # The ASYMX item ('backup jaws') only exsists on some models:
-                if ['SYM', 'ASY'].include?(field.field_x_mode.upcase)
-                  dp_item_x = DICOM::Item.new(:parent => dp_seq)
-                  DICOM::Element.new('300A,00B8', "ASYMX", :parent => dp_item_x)
-                  DICOM::Element.new('300A,011C', "#{field.collimator_x1.to_f * 10}\\#{field.collimator_x2.to_f * 10}", :parent => dp_item_x)
-                end
-                # MLCX:
-                dp_item_mlcx = DICOM::Item.new(:parent => dp_seq)
-                # RT Beam Limiting Device Type:
-                DICOM::Element.new('300A,00B8', "MLCX", :parent => dp_item_mlcx)
-                # Leaf/Jaw Positions:
-                pos_a = cp1.mlc_lp_a.collect{|p| (p.to_f * 10).round(2) unless p.empty?}.compact
-                pos_b = cp1.mlc_lp_b.collect{|p| (p.to_f * 10).round(2) unless p.empty?}.compact
-                leaf_pos = "#{pos_a.join("\\")}\\#{pos_b.join("\\")}"
-                DICOM::Element.new('300A,011C', leaf_pos, :parent => dp_item_mlcx)
-                # Referenced Dose Reference Sequence:
-                rd_seq = DICOM::Sequence.new('300C,0050', :parent => cp_item1)
-                rd_item = DICOM::Item.new(:parent => rd_seq)
-                # Cumulative Dose Reference Coeffecient:
-                DICOM::Element.new('300A,010C', '', :parent => rd_item)
-                # Referenced Dose Reference Number:
-                DICOM::Element.new('300C,0051', '1', :parent => rd_item)
-                # Second control point:
-                # Always include index and cumulative weight:
-                DICOM::Element.new('300A,0112', "#{cp2.index}", :parent => cp_item2)
-                mu_weight = (cp2.monitor_units.to_f * field.field_monitor_units.to_f).round(4)
-                DICOM::Element.new('300A,0134', "#{mu_weight}", :parent => cp_item2)
-                # The other parameters are only included if they have changed from the previous control point:
-                # Nominal Beam Energy:
-                DICOM::Element.new('300A,0114', "#{cp2.energy.to_f}", :parent => cp_item2) if cp2.energy != cp1.energy
-                # Dose Rate Set:
-                DICOM::Element.new('300A,0115', cp1.doserate, :parent => cp_item2) if cp2.doserate != cp1.doserate
-                # Gantry Angle:
-                DICOM::Element.new('300A,011E', cp2.gantry_angle, :parent => cp_item2) if cp2.gantry_angle != cp1.gantry_angle
-                # Gantry Rotation Direction:
-                DICOM::Element.new('300A,011F', (cp2.gantry_dir.empty? ? 'NONE' : cp2.gantry_dir), :parent => cp_item2) if cp2.gantry_dir != cp1.gantry_dir
-                # Beam Limiting Device Angle:
-                DICOM::Element.new('300A,0120', cp2.collimator_angle, :parent => cp_item2) if cp2.collimator_angle != cp1.collimator_angle
-                # Beam Limiting Device Rotation Direction:
-                DICOM::Element.new('300A,0121', (cp2.collimator_dir.empty? ? 'NONE' : cp2.collimator_dir), :parent => cp_item2) if cp2.collimator_dir != cp1.collimator_dir
-                # Patient Support Angle:
-                DICOM::Element.new('300A,0122', cp2.couch_pedestal, :parent => cp_item2) if cp2.couch_pedestal != cp1.couch_pedestal
-                # Patient Support Rotation Direction:
-                DICOM::Element.new('300A,0123', (cp2.couch_ped_dir.empty? ? 'NONE' : cp2.couch_ped_dir), :parent => cp_item2) if cp2.couch_ped_dir != cp1.couch_ped_dir
-                # Table Top Eccentric Angle:
-                DICOM::Element.new('300A,0125', cp2.couch_angle, :parent => cp_item2) if cp2.couch_angle != cp1.couch_angle
-                # Table Top Eccentric Rotation Direction:
-                DICOM::Element.new('300A,0126', (cp2.couch_dir.empty? ? 'NONE' : cp2.couch_dir), :parent => cp_item2) if cp2.couch_dir != cp1.couch_dir
-                # Table Top Vertical Position:
-                couch_vert = cp2.couch_vertical.empty? ? '' : (cp2.couch_vertical.to_f * 10).to_s
-                DICOM::Element.new('300A,0128', couch_vert, :parent => cp_item2) if cp2.couch_vertical != cp1.couch_vertical
-                # Table Top Longitudinal Position:
-                couch_long = cp2.couch_longitudinal.empty? ? '' : (cp2.couch_longitudinal.to_f * 10).to_s
-                DICOM::Element.new('300A,0129', couch_long, :parent => cp_item2) if cp2.couch_longitudinal != cp1.couch_longitudinal
-                # Table Top Lateral Position:
-                couch_lat = cp2.couch_lateral.empty? ? '' : (cp2.couch_lateral.to_f * 10).to_s
-                DICOM::Element.new('300A,012A', couch_lat, :parent => cp_item2) if cp2.couch_lateral != cp1.couch_lateral
-                # Source to Surface Distance:
-                DICOM::Element.new('300A,0130', "#{cp2.ssd.to_f * 10}", :parent => cp_item2) if cp2.ssd != cp1.ssd
-                # Beam Limiting Device Position Sequence:
-                dp_seq = DICOM::Sequence.new('300A,011A', :parent => cp_item2)
-                # ASYMX:
-                if cp2.collimator_x1 != cp1.collimator_x1
-                  dp_item_x = DICOM::Item.new(:parent => dp_seq)
-                  DICOM::Element.new('300A,00B8', "ASYMX", :parent => dp_item_x)
-                  DICOM::Element.new('300A,011C', "#{field.collimator_x1.to_f * 10}\\#{field.collimator_x2.to_f * 10}", :parent => dp_item_x)
-                end
-                # ASYMY:
-                if cp2.collimator_y1 != cp1.collimator_y1
-                  dp_item_y = DICOM::Item.new(:parent => dp_seq)
-                  DICOM::Element.new('300A,00B8', "ASYMY", :parent => dp_item_y)
-                  DICOM::Element.new('300A,011C', "#{field.collimator_y1.to_f * 10}\\#{field.collimator_y2.to_f * 10}", :parent => dp_item_y)
-                end
-                # MLCX:
-                if cp2.mlc_lp_a != cp1.mlc_lp_a or cp2.mlc_lp_b != cp1.mlc_lp_b
-                  dp_item_mlcx = DICOM::Item.new(:parent => dp_seq)
-                  # RT Beam Limiting Device Type:
-                  DICOM::Element.new('300A,00B8', "MLCX", :parent => dp_item_mlcx)
-                  # Leaf/Jaw Positions:
-                  pos_a = cp2.mlc_lp_a.collect{|p| (p.to_f * 10).round(2) unless p.empty?}.compact
-                  pos_b = cp2.mlc_lp_b.collect{|p| (p.to_f * 10).round(2) unless p.empty?}.compact
-                  leaf_pos = "#{pos_a.join("\\")}\\#{pos_b.join("\\")}"
-                  DICOM::Element.new('300A,011C', leaf_pos, :parent => dp_item_mlcx)
-                end
-              end
+              # When we have multiple (2 or more) control points, iterate each control point:
+              field.control_points.each { |cp| create_control_point(cp, cp_seq, options) }
+              # Make sure that hte cumulative meterset weight of the last control
+              # point is '1' (exactly equal to final cumulative meterset weight):
+              cp_seq.items.last['300A,0134'].value = '1'
             end
             # Number of Control Points:
             DICOM::Element.new('300A,0110', b_item['300A,0111'].items.length, :parent => b_item)
@@ -536,6 +351,345 @@ module RTP
       return dcm
     end
 
+
+    private
+
+
+    # Adds Collimator Angle elements to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value1 the collimator angle attribute
+    # @param [String, NilClass] value2 the collimator rotation direction attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_collimator(value1, value2, item)
+      if !@current_collimator || value1 != @current_collimator
+        @current_collimator = value1
+        DICOM::Element.new('300A,0120', value1, :parent => item)
+        DICOM::Element.new('300A,0121', (value2.empty? ? 'NONE' : value2), :parent => item)
+      end
+    end
+
+    # Adds Table Top Eccentric Angle elements to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value1 the table top eccentric angle attribute
+    # @param [String, NilClass] value2 the table top eccentric rotation direction attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_couch_angle(value1, value2, item)
+      if !@current_couch_angle || value1 != @current_couch_angle
+        @current_couch_angle = value1
+        DICOM::Element.new('300A,0125', value1, :parent => item)
+        DICOM::Element.new('300A,0126', (value2.empty? ? 'NONE' : value2), :parent => item)
+      end
+    end
+
+    # Adds a Table Top Lateral Position element to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value the couch lateral attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_couch_lateral(value, item)
+      if !@current_couch_lateral || value != @current_couch_lateral
+        @current_couch_lateral = value
+        DICOM::Element.new('300A,012A', (value.empty? ? '' : value.to_f * 10), :parent => item)
+      end
+    end
+
+    # Adds a Table Top Longitudinal Position element to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value the couch longitudinal attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_couch_longitudinal(value, item)
+      if !@current_couch_longitudinal || value != @current_couch_longitudinal
+        @current_couch_longitudinal = value
+        DICOM::Element.new('300A,0129', (value.empty? ? '' : value.to_f * 10), :parent => item)
+      end
+    end
+
+    # Adds Patient Support Angle elements to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value1 the patient support angle attribute
+    # @param [String, NilClass] value2 the patient support rotation direction attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_couch_pedestal(value1, value2, item)
+      if !@current_couch_pedestal || value1 != @current_couch_pedestal
+        @current_couch_pedestal = value1
+        DICOM::Element.new('300A,0122', value1, :parent => item)
+        DICOM::Element.new('300A,0123', (value2.empty? ? 'NONE' : value2), :parent => item)
+      end
+    end
+
+    # Adds a Table Top Vertical Position element to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value the couch vertical attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_couch_vertical(value, item)
+      if !@current_couch_vertical || value != @current_couch_vertical
+        @current_couch_vertical = value
+        DICOM::Element.new('300A,0128', (value.empty? ? '' : value.to_f * 10), :parent => item)
+      end
+    end
+
+    # Adds a Dose Rate Set element to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value the doserate attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_doserate(value, item)
+      if !@current_doserate || value != @current_doserate
+        @current_doserate = value
+        DICOM::Element.new('300A,0115', value, :parent => item)
+      end
+    end
+
+    # Adds a Nominal Beam Energy element to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value the energy attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_energy(value, item)
+      if !@current_energy || value != @current_energy
+        @current_energy = value
+        DICOM::Element.new('300A,0114', "#{value.to_f}", :parent => item)
+      end
+    end
+
+    # Adds Gantry Angle elements to a Control Point Item.
+    # Note that the element is only added if there is no 'current' attribute
+    # defined, or the given value is different form the current attribute.
+    #
+    # @param [String, NilClass] value1 the gantry angle attribute
+    # @param [String, NilClass] value2 the gantry rotation direction attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_gantry(value1, value2, item)
+      if !@current_gantry || value1 != @current_gantry
+        @current_gantry = value1
+        DICOM::Element.new('300A,011E', value1, :parent => item)
+        DICOM::Element.new('300A,011F', (value2.empty? ? 'NONE' : value2), :parent => item)
+      end
+    end
+
+    # Adds an Isosenter element to a Control Point Item.
+    # Note that the element is only added if there is a Site Setup record present,
+    # and it contains a real (non-empty) value. Also, the element is only added if there
+    # is no 'current' attribute defined, or the given value is different form the current attribute.
+    #
+    # @param [SiteSetup, NilClass] site_setup the associated site setup record
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_isosenter(site_setup, item)
+      if site_setup
+        # Create an element if the value is new or unique:
+        if !@current_isosenter
+          iso = "#{(site_setup.iso_pos_x.to_f * 10).round(2)}\\#{(site_setup.iso_pos_y.to_f * 10).round(2)}\\#{(site_setup.iso_pos_z.to_f * 10).round(2)}"
+          if iso != @current_isosenter
+            @current_isosenter = iso
+            DICOM::Element.new('300A,012C', iso, :parent => item)
+          end
+        end
+      else
+        # Log a warning if this is the first control point:
+        unless @current_isosenter
+          logger.warn("No Site Setup record exists for this plan. Unable to provide an isosenter position.")
+        end
+      end
+    end
+
+    # Adds a Source to Surface Distance element to a Control Point Item.
+    # Note that the element is only added if the SSD attribute contains
+    # real (non-empty) value.
+    #
+    # @param [String, NilClass] value the SSD attribute
+    # @param [DICOM::Item] item the DICOM control point item in which to create an element
+    #
+    def add_ssd(value, item)
+      DICOM::Element.new('300A,0130', "#{value.to_f * 10}", :parent => item) if value && !value.empty?
+    end
+
+    # Creates a control point item in the given control point sequence, based
+    # on an RTP control point record.
+    #
+    # @param [ControlPoint] cp the RTP ControlPoint record to convert
+    # @param [DICOM::Sequence] sequence the DICOM parent sequence of the item to be created
+    # @param [Hash] options the options to use for creating the control point
+    # @option options [Boolean] :dose_ref if set, a Referenced Dose Reference sequence will be included in the generated control point item
+    # @return [DICOM::Item] the constructed control point DICOM item
+    #
+    def create_control_point(cp, sequence, options={})
+      cp_item = DICOM::Item.new(:parent => sequence)
+      # Some CP attributes will always be written (CP index, BLD positions & Cumulative meterset weight).
+      # The other attributes are only written if they are different from the previous control point.
+      # Control Point Index:
+      DICOM::Element.new('300A,0112', "#{cp.index}", :parent => cp_item)
+      # Beam Limiting Device Position Sequence:
+      create_beam_limiting_device_positions(cp_item, cp)
+      # Source to Surface Distance:
+      add_ssd(cp.ssd, cp_item)
+      # Cumulative Meterset Weight:
+      DICOM::Element.new('300A,0134', cp.monitor_units.to_f, :parent => cp_item)
+      # Referenced Dose Reference Sequence:
+      create_referenced_dose_reference(cp_item) if options[:dose_ref]
+      # Attributes that are only added if they carry an updated value:
+      # Nominal Beam Energy:
+      add_energy(cp.energy, cp_item)
+      # Dose Rate Set:
+      add_doserate(cp.doserate, cp_item)
+      # Gantry Angle & Rotation Direction:
+      add_gantry(cp.gantry_angle, cp.gantry_dir, cp_item)
+      # Beam Limiting Device Angle & Rotation Direction:
+      add_collimator(cp.collimator_angle, cp.collimator_dir, cp_item)
+      # Patient Support Angle & Rotation Direction:
+      add_couch_pedestal(cp.couch_pedestal, cp.couch_ped_dir, cp_item)
+      # Table Top Eccentric Angle & Rotation Direction:
+      add_couch_angle(cp.couch_angle, cp.couch_dir, cp_item)
+      # Table Top Vertical Position:
+      add_couch_vertical(cp.couch_vertical, cp_item)
+      # Table Top Longitudinal Position:
+      add_couch_longitudinal(cp.couch_vertical, cp_item)
+      # Table Top Lateral Position:
+      add_couch_lateral(cp.couch_vertical, cp_item)
+      # Isocenter Position (x\y\z):
+      add_isosenter(cp.parent.parent.site_setup, cp_item)
+      cp_item
+    end
+
+    # Creates a beam limiting device sequence in the given DICOM object.
+    #
+    # @param [DICOM::Item] beam_item the DICOM beam item in which to insert the sequence
+    # @param [Field] field the RTP field to fetch device parameters from
+    # @return [DICOM::Sequence] the constructed beam limiting device sequence
+    #
+    def create_beam_limiting_devices(beam_item, field)
+      bl_seq = DICOM::Sequence.new('300A,00B6', :parent => beam_item)
+      # The ASYMX item ('backup jaws') doesn't exist on all models:
+      if ['SYM', 'ASY'].include?(field.field_x_mode.upcase)
+        bl_item_x = DICOM::Item.new(:parent => bl_seq)
+        DICOM::Element.new('300A,00B8', "ASYMX", :parent => bl_item_x)
+        DICOM::Element.new('300A,00BC', "1", :parent => bl_item_x)
+      end
+      # The ASYMY item is always created:
+      bl_item_y = DICOM::Item.new(:parent => bl_seq)
+      # RT Beam Limiting Device Type:
+      DICOM::Element.new('300A,00B8', "ASYMY", :parent => bl_item_y)
+      # Number of Leaf/Jaw Pairs:
+      DICOM::Element.new('300A,00BC', "1", :parent => bl_item_y)
+      # MLCX item is only created if leaves are defined:
+      # (NB: The RTP file doesn't specify leaf position boundaries, so we
+      # have to set these based on a set of known MLC types, their number
+      # of leaves, and their leaf boundary positions.)
+      if field.control_points.length > 0
+        bl_item_mlcx = DICOM::Item.new(:parent => bl_seq)
+        DICOM::Element.new('300A,00B8', "MLCX", :parent => bl_item_mlcx)
+        num_leaves = field.control_points.first.mlc_leaves.to_i
+        DICOM::Element.new('300A,00BC', num_leaves.to_s, :parent => bl_item_mlcx)
+        DICOM::Element.new('300A,00BE', "#{RTP.leaf_boundaries(num_leaves).join("\\")}", :parent => bl_item_mlcx)
+      end
+      bl_seq
+    end
+
+    # Creates a beam limiting device positions sequence in the given DICOM object.
+    #
+    # @param [DICOM::Item] cp_item the DICOM control point item in which to insert the sequence
+    # @param [ControlPoint] cp the RTP control point to fetch device parameters from
+    # @return [DICOM::Sequence] the constructed beam limiting device positions sequence
+    #
+    def create_beam_limiting_device_positions(cp_item, cp)
+      dp_seq = DICOM::Sequence.new('300A,011A', :parent => cp_item)
+      # The ASYMX item ('backup jaws') doesn't exist on all models:
+      if ['SYM', 'ASY'].include?(cp.parent.field_x_mode.upcase)
+        dp_item_x = DICOM::Item.new(:parent => dp_seq)
+        DICOM::Element.new('300A,00B8', "ASYMX", :parent => dp_item_x)
+        DICOM::Element.new('300A,011C', "#{cp.dcm_collimator_x1}\\#{cp.dcm_collimator_x2}", :parent => dp_item_x)
+      end
+      # Always create one ASYMY item:
+      dp_item_y = DICOM::Item.new(:parent => dp_seq)
+      # RT Beam Limiting Device Type:
+      DICOM::Element.new('300A,00B8', "ASYMY", :parent => dp_item_y)
+      # Leaf/Jaw Positions:
+      DICOM::Element.new('300A,011C', "#{cp.dcm_collimator_y1}\\#{cp.dcm_collimator_y2}", :parent => dp_item_y)
+      # MLCX:
+      dp_item_mlcx = DICOM::Item.new(:parent => dp_seq)
+      # RT Beam Limiting Device Type:
+      DICOM::Element.new('300A,00B8', "MLCX", :parent => dp_item_mlcx)
+      # Leaf/Jaw Positions:
+      DICOM::Element.new('300A,011C', cp.dcm_mlc_positions, :parent => dp_item_mlcx)
+      dp_seq
+    end
+
+    # Creates a dose reference sequence in the given DICOM object.
+    #
+    # @param [DICOM::DObject] dcm the DICOM object in which to insert the sequence
+    # @param [String] description the value to use for Dose Reference Description
+    # @return [DICOM::Sequence] the constructed dose reference sequence
+    #
+    def create_dose_reference(dcm, description)
+      dr_seq = DICOM::Sequence.new('300A,0010', :parent => dcm)
+      dr_item = DICOM::Item.new(:parent => dr_seq)
+      # Dose Reference Number:
+      DICOM::Element.new('300A,0012', '1', :parent => dr_item)
+      # Dose Reference Structure Type:
+      DICOM::Element.new('300A,0014', 'SITE', :parent => dr_item)
+      # Dose Reference Description:
+      DICOM::Element.new('300A,0016', description, :parent => dr_item)
+      # Dose Reference Type:
+      DICOM::Element.new('300A,0020', 'TARGET', :parent => dr_item)
+      dr_seq
+    end
+
+    # Creates a referenced dose reference sequence in the given DICOM object.
+    #
+    # @param [DICOM::Item] cp_item the DICOM item in which to insert the sequence
+    # @return [DICOM::Sequence] the constructed referenced dose reference sequence
+    #
+    def create_referenced_dose_reference(cp_item)
+      # Referenced Dose Reference Sequence:
+      rd_seq = DICOM::Sequence.new('300C,0050', :parent => cp_item)
+      rd_item = DICOM::Item.new(:parent => rd_seq)
+      # Cumulative Dose Reference Coeffecient:
+      DICOM::Element.new('300A,010C', '', :parent => rd_item)
+      # Referenced Dose Reference Number:
+      DICOM::Element.new('300C,0051', '1', :parent => rd_item)
+      rd_seq
+    end
+
+    # Resets the types of control point attributes that are only written to the
+    # first control point item, and for following control point items only when
+    # they are different from the 'current' value. When a new field is reached,
+    # it is essential to reset these attributes, or else we could risk to start
+    # the field with a control point with missing attributes, if one of its first
+    # attributes is equal to the last attribute of the previous field.
+    #
+    def reset_cp_current_attributes
+      @current_gantry = nil
+      @current_collimator = nil
+      @current_couch_pedestal = nil
+      @current_couch_angle = nil
+      @current_couch_vertical = nil
+      @current_couch_longitudinal = nil
+      @current_couch_lateral = nil
+      @current_isosenter = nil
+    end
+
   end
 
 end

data/lib/rtp-connect/version.rb

@@ -1,6 +1,6 @@
 module RTP
 
   # The RTPConnect library version string.
-  VERSION = '1.5'
+  VERSION = '1.6'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtp-connect
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1061055599
+      hash: -111446803
 requirements: []
 rubyforge_project: rtp-connect
 rubygems_version: 1.8.24