rtp-connect 1.8 → 1.9

data/lib/rtp-connect/control_point.rb

@@ -8,8 +8,11 @@ module RTP
   #
   class ControlPoint < Record
 
+    # The number of attributes not having their own variable for this record (200 - 2).
+    NR_SURPLUS_ATTRIBUTES = 198
+
     # The Record which this instance belongs to.
-    attr_reader :parent
+    attr_accessor :parent
     # The MLC shape record (if any) that belongs to this ControlPoint.
     attr_reader :mlc_shape
     attr_reader :field_id
@@ -144,15 +147,7 @@ module RTP
     # @return [Float] the DICOM-formatted collimator_x1 attribute
     #
     def dcm_collimator_x1(scale=nil)
-      coeff = 1
-      axis = :x
-      if scale == :elekta
-        axis = :y
-        coeff = -1
-      elsif scale == :varian
-        coeff = -1
-      end
-      dcm_collimator1(axis, coeff)
+      dcm_collimator_1(scale, default_axis=:x)
     end
 
     # Converts the collimator_x2 attribute to proper DICOM format.
@@ -162,7 +157,7 @@ module RTP
     #
     def dcm_collimator_x2(scale=nil)
       axis = (scale == :elekta ? :y : :x)
-      dcm_collimator2(axis, coeff=1)
+      dcm_collimator(axis, coeff=1, side=2)
     end
 
     # Converts the collimator_y1 attribute to proper DICOM format.
@@ -171,15 +166,7 @@ module RTP
     # @return [Float] the DICOM-formatted collimator_y1 attribute
     #
     def dcm_collimator_y1(scale=nil)
-      coeff = 1
-      axis = :y
-      if scale == :elekta
-        axis = :x
-        coeff = -1
-      elsif scale == :varian
-        coeff = -1
-      end
-      dcm_collimator1(axis, coeff)
+      dcm_collimator_1(scale, default_axis=:y)
     end
 
     # Converts the collimator_y2 attribute to proper DICOM format.
@@ -189,7 +176,7 @@ module RTP
     #
     def dcm_collimator_y2(scale=nil)
       axis = (scale == :elekta ? :x : :y)
-      dcm_collimator2(axis, coeff=1)
+      dcm_collimator(axis, coeff=1, side=2)
     end
 
     # Converts the mlc_lp_a & mlc_lp_b attributes to a proper DICOM formatted string.
@@ -276,25 +263,6 @@ module RTP
       self
     end
 
-    # Encodes the ControlPoint object + any hiearchy of child objects,
-    # to a properly formatted RTPConnect ascii string.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] an RTP string with a single or multiple lines/records
-    #
-    def to_s(options={})
-      str = encode(options)
-      if children
-        children.each do |child|
-          str += child.to_s(options)
-        end
-      end
-      return str
-    end
-
-    alias :to_str :to_s
-
     # Sets the mlc_lp_a attribute.
     #
     # @note As opposed to the ordinary (string) attributes, this attribute
@@ -578,74 +546,49 @@ module RTP
     #
     # @param [Symbol] axis a representation for the axis of interest (x or y)
     # @param [Integer] coeff a coeffecient (of -1 or 1) which the attribute is multiplied with
+    # @param [Integer] nr collimator side/index (1 or 2)
     # @return [Float] the DICOM-formatted collimator attribute
     #
-    def dcm_collimator1(axis, coeff)
+    def dcm_collimator(axis, coeff, nr)
       mode = self.send("field_#{axis}_mode")
       if mode && !mode.empty?
         target = self
       else
         target = @parent
       end
-      target.send("collimator_#{axis}1").to_f * 10 * coeff
+      target.send("collimator_#{axis}#{nr}").to_f * 10 * coeff
     end
 
-    # Converts the collimator attribute to proper DICOM format.
+    # Converts the collimator1 attribute to proper DICOM format.
     #
-    # @param [Symbol] axis a representation for the axis of interest (x or y)
-    # @param [Integer] coeff a coeffecient (of -1 or 1) which the attribute is multiplied with
-    # @return [Float] the DICOM-formatted collimator attribute
+    # @param [Symbol] scale if set, relevant device parameters are converted from a native readout format to IEC1217 (supported values are :elekta & :varian)
+    # @return [Float] the DICOM-formatted collimator_x1 attribute
     #
-    def dcm_collimator2(axis, coeff)
-      mode = self.send("field_#{axis}_mode")
-      if mode && !mode.empty?
-        target = self
-      else
-        target = @parent
+    def dcm_collimator_1(scale=nil, axis)
+      coeff = 1
+      if scale == :elekta
+        axis = (axis == :x ? :y : :x)
+        coeff = -1
+      elsif scale == :varian
+        coeff = -1
       end
-      target.send("collimator_#{axis}2").to_f * 10 * coeff
-    end
-
-    # Sets the attributes of the record instance.
-    #
-    # @param [Array<String>] values the record attributes (as parsed from a record string)
-    #
-    def set_attributes(values)
-      self.keyword = values[0]
-      @field_id = values[1]
-      @mlc_type = values[2]
-      @mlc_leaves = values[3]
-      @total_control_points = values[4]
-      @control_pt_number = values[5]
-      @mu_convention = values[6]
-      @monitor_units = values[7]
-      @wedge_position = values[8]
-      @energy = values[9]
-      @doserate = values[10]
-      @ssd = values[11]
-      @scale_convention = values[12]
-      @gantry_angle = values[13]
-      @gantry_dir = values[14]
-      @collimator_angle = values[15]
-      @collimator_dir = values[16]
-      @field_x_mode = values[17]
-      @field_x = values[18]
-      @collimator_x1 = values[19]
-      @collimator_x2 = values[20]
-      @field_y_mode = values[21]
-      @field_y = values[22]
-      @collimator_y1 = values[23]
-      @collimator_y2 = values[24]
-      @couch_vertical = values[25]
-      @couch_lateral = values[26]
-      @couch_longitudinal = values[27]
-      @couch_angle = values[28]
-      @couch_dir = values[29]
-      @couch_pedestal = values[30]
-      @couch_ped_dir = values[31]
-      @mlc_lp_a = [*values[32..131]]
-      @mlc_lp_b = [*values[132..231]]
-      @crc = values[-1]
+      dcm_collimator(axis, coeff, side=1)
+    end
+
+    # Gives an array of indices indicating where the attributes of this record gets its
+    # values from in the comma separated string which the instance is created from.
+    #
+    # @param [Integer] length the number of elements to create in the indices array
+    #
+    def import_indices(length)
+      # Note that this method is defined in the parent Record class, where it is
+      # used for most record types. However, because this record has two attributes
+      # which contain an array of values, we use a custom import_indices method.
+      ind = Array.new(length - NR_SURPLUS_ATTRIBUTES) { |i| [i] }
+      # Override indices for mlc_pl_a and mlc_lp_b:
+      ind[32] = (32..131).to_a
+      ind[33] = (132..231).to_a
+      ind
     end
 
   end

data/lib/rtp-connect/dose_tracking.rb

@@ -8,8 +8,11 @@ module RTP
   #
   class DoseTracking < Record
 
+    # The number of attributes not having their own variable for this record (20 - 2).
+    NR_SURPLUS_ATTRIBUTES = 18
+
     # The Record which this instance belongs to.
-    attr_reader :parent
+    attr_accessor :parent
     # The DoseAction records (if any) that belongs to this DoseTracking.
     attr_reader :dose_actions
     attr_reader :region_name
@@ -120,25 +123,6 @@ module RTP
       self
     end
 
-    # Encodes the DoseTracking object + any hiearchy of child objects,
-    # to a properly formatted RTPConnect ascii string.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] an RTP string with a single or multiple lines/records
-    #
-    def to_s(options={})
-      str = encode(options)
-      if children
-        children.each do |child|
-          str += child.to_s(options)
-        end
-      end
-      return str
-    end
-
-    alias :to_str :to_s
-
     # Sets the field_ids attribute.
     #
     # @note As opposed to the ordinary (string) attributes, this attribute
@@ -202,19 +186,21 @@ module RTP
     #
     alias_method :state, :values
 
-    # Sets the attributes of the record instance.
-    #
-    # @param [Array<String>] values the record attributes (as parsed from a record string)
-    #
-    def set_attributes(values)
-      self.keyword = values[0]
-      @region_name = values[1]
-      @region_prior_dose = values[2]
-      @field_ids = values.values_at(3, 5, 7, 9, 11, 13, 15, 17, 19, 21)
-      @region_coeffs = values.values_at(4, 6, 8, 10, 12, 14, 16, 18, 20, 22)
-      @actual_dose = values[23]
-      @actual_fractions = values[24]
-      @crc = values[-1]
+    # Gives an array of indices indicating where the attributes of this record gets its
+    # values from in the comma separated string which the instance is created from.
+    #
+    # @param [Integer] length the number of elements to create in the indices array
+    #
+    def import_indices(length)
+      # Note that this method is defined in the parent Record class, where it is
+      # used for most record types. However, because this record has two attributes
+      # which contain an array of values, we use a custom import_indices method.
+      ind = Array.new(length - NR_SURPLUS_ATTRIBUTES) { |i| i }
+      # Override indices for field_ids and region_coeffs:
+      ind[3] = [3, 5, 7, 9, 11, 13, 15, 17, 19, 21]
+      ind[4] = [4, 6, 8, 10, 12, 14, 16, 18, 20, 22]
+      ind[5, 6] = [23, 24]
+      ind
     end
 
   end

data/lib/rtp-connect/extended_field.rb

@@ -9,7 +9,7 @@ module RTP
   class ExtendedField < Record
 
     # The Record which this instance belongs to.
-    attr_reader :parent
+    attr_accessor :parent
     attr_reader :field_id
     attr_reader :original_plan_uid
     attr_reader :original_beam_number
@@ -97,25 +97,6 @@ module RTP
       self
     end
 
-    # Encodes the ExtendedField object + any hiearchy of child objects,
-    # to a properly formatted RTPConnect ascii string.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] an RTP string with a single or multiple lines/records
-    #
-    def to_s(options={})
-      str = encode(options)
-      if children
-        children.each do |child|
-          str += child.to_s(options)
-        end
-      end
-      return str
-    end
-
-    alias :to_str :to_s
-
     # Sets the field_id attribute.
     #
     # @param [nil, #to_s] value the new attribute value

data/lib/rtp-connect/extended_plan.rb

@@ -1,135 +1,116 @@
-module RTP
-
-  # The Extended plan class.
-  #
-  # @note Relations:
-  #   * Parent: Plan
-  #   * Children: none
-  #
-  class ExtendedPlan < Record
-
-    # The Record which this instance belongs to.
-    attr_reader :parent
-    attr_reader :encoding
-    attr_reader :fullname
-
-    # Creates a new ExtendedPlan by parsing a RTPConnect string line.
-    #
-    # @param [#to_s] string the extended plan definition record string line
-    # @param [Record] parent a record which is used to determine the proper parent of this instance
-    # @return [ExtendedPlan] the created ExtendedPlan instance
-    # @raise [ArgumentError] if given a string containing an invalid number of elements
-    #
-    def self.load(string, parent)
-      ep = self.new(parent)
-      ep.load(string)
-    end
-
-    # Creates a new ExtendedPlan.
-    #
-    # @param [Record] parent a record which is used to determine the proper parent of this instance
-    #
-    def initialize(parent)
-      super('EXTENDED_PLAN_DEF', 4, 4)
-      # Parent relation (may get more than one type of record here):
-      @parent = get_parent(parent.to_record, Plan)
-      @parent.add_extended_plan(self)
-      @attributes = [
-        # Required:
-        :keyword,
-        :encoding,
-        :fullname
-      ]
-    end
-
-    # Checks for equality.
-    #
-    # Other and self are considered equivalent if they are
-    # of compatible types and their attributes are equivalent.
-    #
-    # @param other an object to be compared with self.
-    # @return [Boolean] true if self and other are considered equivalent
-    #
-    def ==(other)
-      if other.respond_to?(:to_extended_plan)
-        other.send(:state) == state
-      end
-    end
-
-    alias_method :eql?, :==
-
-    # Gives an empty array, as these instances are child-less by definition.
-    #
-    # @return [Array] an emtpy array
-    #
-    def children
-      return Array.new
-    end
-
-    # Computes a hash code for this object.
-    #
-    # @note Two objects with the same attributes will have the same hash code.
-    #
-    # @return [Fixnum] the object's hash code
-    #
-    def hash
-      state.hash
-    end
-
-    # Returns self.
-    #
-    # @return [ExtendedPlan] self
-    #
-    def to_extended_plan
-      self
-    end
-
-    # Encodes the ExtendedPlan object + any hiearchy of child objects,
-    # to a properly formatted RTPConnect ascii string.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] an RTP string with a single or multiple lines/records
-    #
-    def to_s(options={})
-      str = encode(options)
-      if children
-        children.each do |child|
-          str += child.to_s(options)
-        end
-      end
-      return str
-    end
-
-    alias :to_str :to_s
-
-    # Sets the encoding attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def encoding=(value)
-      @encoding = value && value.to_s
-    end
-
-    # Sets the fullname attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def fullname=(value)
-      @fullname = value && value.to_s
-    end
-
-
-    private
-
-
-    # Collects the attributes of this instance.
-    #
-    # @note The CRC is not considered part of the attributes of interest and is excluded
-    # @return [Array<String>] an array of attributes
-    #
-    alias_method :state, :values
-
-  end
-
+module RTP
+
+  # The Extended plan class.
+  #
+  # @note Relations:
+  #   * Parent: Plan
+  #   * Children: none
+  #
+  class ExtendedPlan < Record
+
+    # The Record which this instance belongs to.
+    attr_accessor :parent
+    attr_reader :encoding
+    attr_reader :fullname
+
+    # Creates a new ExtendedPlan by parsing a RTPConnect string line.
+    #
+    # @param [#to_s] string the extended plan definition record string line
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    # @return [ExtendedPlan] the created ExtendedPlan instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
+    #
+    def self.load(string, parent)
+      ep = self.new(parent)
+      ep.load(string)
+    end
+
+    # Creates a new ExtendedPlan.
+    #
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    #
+    def initialize(parent)
+      super('EXTENDED_PLAN_DEF', 4, 4)
+      # Parent relation (may get more than one type of record here):
+      @parent = get_parent(parent.to_record, Plan)
+      @parent.add_extended_plan(self)
+      @attributes = [
+        # Required:
+        :keyword,
+        :encoding,
+        :fullname
+      ]
+    end
+
+    # Checks for equality.
+    #
+    # Other and self are considered equivalent if they are
+    # of compatible types and their attributes are equivalent.
+    #
+    # @param other an object to be compared with self.
+    # @return [Boolean] true if self and other are considered equivalent
+    #
+    def ==(other)
+      if other.respond_to?(:to_extended_plan)
+        other.send(:state) == state
+      end
+    end
+
+    alias_method :eql?, :==
+
+    # Gives an empty array, as these instances are child-less by definition.
+    #
+    # @return [Array] an emtpy array
+    #
+    def children
+      return Array.new
+    end
+
+    # Computes a hash code for this object.
+    #
+    # @note Two objects with the same attributes will have the same hash code.
+    #
+    # @return [Fixnum] the object's hash code
+    #
+    def hash
+      state.hash
+    end
+
+    # Returns self.
+    #
+    # @return [ExtendedPlan] self
+    #
+    def to_extended_plan
+      self
+    end
+
+    # Sets the encoding attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def encoding=(value)
+      @encoding = value && value.to_s
+    end
+
+    # Sets the fullname attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def fullname=(value)
+      @fullname = value && value.to_s
+    end
+
+
+    private
+
+
+    # Collects the attributes of this instance.
+    #
+    # @note The CRC is not considered part of the attributes of interest and is excluded
+    # @return [Array<String>] an array of attributes
+    #
+    alias_method :state, :values
+
+  end
+
 end