rtp-connect 1.6 → 1.7

data/lib/rtp-connect/dose_tracking.rb

@@ -29,23 +29,8 @@ module RTP
     # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
-      # Get the quote-less values:
-      values = string.to_s.values
-      low_limit = 24
-      high_limit = 26
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{low_limit} elements, got #{values.length}." if values.length < low_limit
-      RTP.logger.warn "The number of elements (#{values.length}) for this DoseTracking record exceeds the known number of data items for this record (#{high_limit}). This may indicate an invalid record or that the RTP format has recently been expanded with new items." if values.length > high_limit
       d = self.new(parent)
-      # Assign the values to attributes:
-      d.keyword = values[0]
-      d.region_name = values[1]
-      d.region_prior_dose = values[2]
-      d.field_ids = values.values_at(3, 5, 7, 9, 11, 13, 15, 17, 19, 21)
-      d.region_coeffs = values.values_at(4, 6, 8, 10, 12, 14, 16, 18, 20, 22)
-      d.actual_dose = values[23]
-      d.actual_fractions = values[24]
-      d.crc = values[-1]
-      return d
+      d.load(string)
     end
 
     # Creates a new DoseTracking.
@@ -53,14 +38,25 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
+      super('DOSE_DEF', 24, 26)
       # Child records:
       @dose_actions = Array.new
       # Parent relation (may get more than one type of record here):
       @parent = get_parent(parent.to_record, Plan)
       @parent.add_dose_tracking(self)
-      @keyword = 'DOSE_DEF'
       @field_ids = Array.new(10)
       @region_coeffs = Array.new(10)
+      @attributes = [
+        # Required:
+        :keyword,
+        :region_name,
+        :region_prior_dose,
+        :field_ids,
+        :region_coeffs,
+        # Optional:
+        :actual_dose,
+        :actual_fractions
+      ]
     end
 
     # Checks for equality.
@@ -105,7 +101,7 @@ module RTP
     # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
     #
     def values
-      return [
+      [
         @keyword,
         @region_name,
         @region_prior_dose,
@@ -148,9 +144,7 @@ module RTP
     # @param [Array<nil, #to_s>] array the new attribute values
     #
     def field_ids=(array)
-      array = array.to_a
-      raise ArgumentError, "Invalid argument 'array'. Expected length 10, got #{array.length}." unless array.length == 10
-      @field_ids = array.collect! {|e| e && e.to_s}
+      @field_ids = array.to_a.validate_and_process(10)
     end
 
     # Sets the region_coeffs attribute.
@@ -160,21 +154,7 @@ module RTP
     # @param [Array<nil, #to_s>] array the new attribute values
     #
     def region_coeffs=(array)
-      array = array.to_a
-      raise ArgumentError, "Invalid argument 'array'. Expected length 10, got #{array.length}." unless array.length == 10
-      @region_coeffs = array.collect! {|e| e && e.to_s}
-    end
-
-    # Sets the keyword attribute.
-    #
-    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method
-    # @param [#to_s] value the new attribute value
-    # @raise [ArgumentError] if given an unexpected keyword
-    #
-    def keyword=(value)
-      value = value.to_s.upcase
-      raise ArgumentError, "Invalid keyword. Expected 'DOSE_DEF', got #{value}." unless value == "DOSE_DEF"
-      @keyword = value
+      @region_coeffs = array.to_a.validate_and_process(10)
     end
 
     # Sets the region_name attribute.
@@ -220,6 +200,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]
+    end
+
   end
 
 end

data/lib/rtp-connect/extended_field.rb

@@ -27,26 +27,8 @@ module RTP
     # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
-      # Get the quote-less values:
-      values = string.to_s.values
-      low_limit = 4
-      high_limit = 10
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{low_limit} elements, got #{values.length}." if values.length < low_limit
-      RTP.logger.warn "The number of elements (#{values.length}) for this ExtendedField record exceeds the known number of data items for this record (#{high_limit}). This may indicate an invalid record or that the RTP format has recently been expanded with new items." if values.length > high_limit
       ef = self.new(parent)
-      # Mandatory attributes:
-      ef.keyword = values[0]
-      ef.field_id = values[1]
-      ef.original_plan_uid = values[2]
-      # Optional attributes:
-      ef.original_beam_number = values[3]
-      ef.original_beam_name = values[4]
-      ef.is_fff = values[5] if values[5]
-      ef.accessory_code = values[6]
-      ef.accessory_type = values[7]
-      ef.high_dose_authorization = values[8]
-      ef.crc = values[-1]
-      return ef
+      ef.load(string)
     end
 
     # Creates a new (treatment) ExtendedField.
@@ -54,10 +36,23 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
+      super('EXTENDED_FIELD_DEF', 4, 10)
       # Parent relation (may get more than one type of record here):
       @parent = get_parent(parent.to_record, Field)
       @parent.add_extended_field(self)
-      @keyword = 'EXTENDED_FIELD_DEF'
+      @attributes = [
+        # Required:
+        :keyword,
+        :field_id,
+        :original_plan_uid,
+        # Optional:
+        :original_beam_number,
+        :original_beam_name,
+        :is_fff,
+        :accessory_code,
+        :accessory_type,
+        :high_dose_authorization
+      ]
     end
 
     # Checks for equality.
@@ -94,25 +89,6 @@ module RTP
       state.hash
     end
 
-    # Collects the values (attributes) of this instance.
-    #
-    # @note The CRC is not considered part of the actual values and is excluded.
-    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
-    #
-    def values
-      return [
-        @keyword,
-        @field_id,
-        @original_plan_uid,
-        @original_beam_number,
-        @original_beam_name,
-        @is_fff,
-        @accessory_code,
-        @accessory_type,
-        @high_dose_authorization
-      ]
-    end
-
     # Returns self.
     #
     # @return [ExtendedField] self
@@ -138,18 +114,6 @@ module RTP
 
     alias :to_str :to_s
 
-    # Sets the keyword attribute.
-    #
-    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method
-    # @param [#to_s] value the new attribute value
-    # @raise [ArgumentError] if given an unexpected keyword
-    #
-    def keyword=(value)
-      value = value.to_s.upcase
-      raise ArgumentError, "Invalid keyword. Expected 'EXTENDED_FIELD_DEF', got #{value}." unless value == "EXTENDED_FIELD_DEF"
-      @keyword = value
-    end
-
     # Sets the field_id attribute.
     #
     # @param [nil, #to_s] value the new attribute value

data/lib/rtp-connect/extended_plan.rb

@@ -0,0 +1,133 @@
+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.
+    #
+    # @return [String] an RTP string with a single or multiple lines/records
+    #
+    def to_s
+      str = encode
+      if children
+        children.each do |child|
+          str += child.to_s
+        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
+
+end

data/lib/rtp-connect/field.rb

@@ -70,64 +70,8 @@ module RTP
     # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
-      # Get the quote-less values:
-      values = string.to_s.values
-      low_limit = 27
-      high_limit = 49
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{low_limit} elements, got #{values.length}." if values.length < low_limit
-      RTP.logger.warn "The number of elements (#{values.length}) for this Field record exceeds the known number of data items for this record (#{high_limit}). This may indicate an invalid record or that the RTP format has recently been expanded with new items." if values.length > high_limit
       f = self.new(parent)
-      # Assign the values to attributes:
-      f.keyword = values[0]
-      f.rx_site_name = values[1]
-      f.field_name = values[2]
-      f.field_id = values[3]
-      f.field_note = values[4]
-      f.field_dose = values[5]
-      f.field_monitor_units = values[6]
-      f.wedge_monitor_units = values[7]
-      f.treatment_machine = values[8]
-      f.treatment_type = values[9]
-      f.modality = values[10]
-      f.energy = values[11]
-      f.time = values[12]
-      f.doserate = values[13]
-      f.sad = values[14]
-      f.ssd = values[15]
-      f.gantry_angle = values[16]
-      f.collimator_angle = values[17]
-      f.field_x_mode = values[18]
-      f.field_x = values[19]
-      f.collimator_x1 = values[20]
-      f.collimator_x2 = values[21]
-      f.field_y_mode = values[22]
-      f.field_y = values[23]
-      f.collimator_y1 = values[24]
-      f.collimator_y2 = values[25]
-      f.couch_vertical = values[26]
-      f.couch_lateral = values[27]
-      f.couch_longitudinal = values[28]
-      f.couch_angle = values[29]
-      f.couch_pedestal = values[30]
-      f.tolerance_table = values[31]
-      f.arc_direction = values[32]
-      f.arc_start_angle = values[33]
-      f.arc_stop_angle = values[34]
-      f.arc_mu_degree = values[35]
-      f.wedge = values[36]
-      f.dynamic_wedge = values[37]
-      f.block = values[38]
-      f.compensator = values[39]
-      f.e_applicator = values[40]
-      f.e_field_def_aperture = values[41]
-      f.bolus = values[42]
-      f.portfilm_mu_open = values[43]
-      f.portfilm_coeff_open = values[44]
-      f.portfilm_delta_open = values[45]
-      f.portfilm_mu_treat = values[46]
-      f.portfilm_coeff_treat = values[47]
-      f.crc = values[-1]
-      return f
+      f.load(string)
     end
 
     # Creates a new (treatment) Field.
@@ -135,13 +79,65 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
+      super('FIELD_DEF', 27, 49)
       # Child records:
       @control_points = Array.new
       @extended_field = nil
       # Parent relation (may get more than one type of record here):
       @parent = get_parent(parent.to_record, Prescription)
       @parent.add_field(self)
-      @keyword = 'FIELD_DEF'
+      @attributes = [
+        # Required:
+        :keyword,
+        :rx_site_name,
+        :field_name,
+        :field_id,
+        :field_note,
+        :field_dose,
+        :field_monitor_units,
+        :wedge_monitor_units,
+        :treatment_machine,
+        :treatment_type,
+        :modality,
+        :energy,
+        :time,
+        :doserate,
+        :sad,
+        :ssd,
+        :gantry_angle,
+        :collimator_angle,
+        :field_x_mode,
+        :field_x,
+        :collimator_x1,
+        :collimator_x2,
+        :field_y_mode,
+        :field_y,
+        :collimator_y1,
+        :collimator_y2,
+        # Optional:
+        :couch_vertical,
+        :couch_lateral,
+        :couch_longitudinal,
+        :couch_angle,
+        :couch_pedestal,
+        :tolerance_table,
+        :arc_direction,
+        :arc_start_angle,
+        :arc_stop_angle,
+        :arc_mu_degree,
+        :wedge,
+        :dynamic_wedge,
+        :block,
+        :compensator,
+        :e_applicator,
+        :e_field_def_aperture,
+        :bolus,
+        :portfilm_mu_open,
+        :portfilm_coeff_open,
+        :portfilm_delta_open,
+        :portfilm_mu_treat,
+        :portfilm_coeff_treat
+      ]
     end
 
     # Checks for equality.
@@ -184,6 +180,38 @@ module RTP
       return [@extended_field, @control_points].flatten.compact
     end
 
+    # Converts the collimator_x1 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_x1 attribute
+    #
+    def dcm_collimator_x1
+      dcm_collimator1(:x)
+    end
+
+    # Converts the collimator_x2 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_x2 attribute
+    #
+    def dcm_collimator_x2
+      value = @collimator_x2.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
+      dcm_collimator1(:y)
+    end
+
+    # Converts the collimator_y2 attribute to proper DICOM format.
+    #
+    # @return [Float] the DICOM-formatted collimator_y2 attribute
+    #
+    def dcm_collimator_y2
+      value = @collimator_y2.to_f * 10
+    end
+
     # Computes a hash code for this object.
     #
     # @note Two objects with the same attributes will have the same hash code.
@@ -194,64 +222,6 @@ module RTP
       state.hash
     end
 
-    # Collects the values (attributes) of this instance.
-    #
-    # @note The CRC is not considered part of the actual values and is excluded.
-    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
-    #
-    def values
-      return [
-        @keyword,
-        @rx_site_name,
-        @field_name,
-        @field_id,
-        @field_note,
-        @field_dose,
-        @field_monitor_units,
-        @wedge_monitor_units,
-        @treatment_machine,
-        @treatment_type,
-        @modality,
-        @energy,
-        @time,
-        @doserate,
-        @sad,
-        @ssd,
-        @gantry_angle,
-        @collimator_angle,
-        @field_x_mode,
-        @field_x,
-        @collimator_x1,
-        @collimator_x2,
-        @field_y_mode,
-        @field_y,
-        @collimator_y1,
-        @collimator_y2,
-        @couch_vertical,
-        @couch_lateral,
-        @couch_longitudinal,
-        @couch_angle,
-        @couch_pedestal,
-        @tolerance_table,
-        @arc_direction,
-        @arc_start_angle,
-        @arc_stop_angle,
-        @arc_mu_degree,
-        @wedge,
-        @dynamic_wedge,
-        @block,
-        @compensator,
-        @e_applicator,
-        @e_field_def_aperture,
-        @bolus,
-        @portfilm_mu_open,
-        @portfilm_coeff_open,
-        @portfilm_delta_open,
-        @portfilm_mu_treat,
-        @portfilm_coeff_treat
-      ]
-    end
-
     # Returns self.
     #
     # @return [Field] self
@@ -277,18 +247,6 @@ module RTP
 
     alias :to_str :to_s
 
-    # Sets the keyword attribute.
-    #
-    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method
-    # @param [#to_s] value the new attribute value
-    # @raise [ArgumentError] if given an unexpected keyword
-    #
-    def keyword=(value)
-      value = value.to_s.upcase
-      raise ArgumentError, "Invalid keyword. Expected 'FIELD_DEF', got #{value}." unless value == "FIELD_DEF"
-      @keyword = value
-    end
-
     # Sets the rx_site_name attribute.
     #
     # @param [nil, #to_s] value the new attribute value
@@ -676,6 +634,21 @@ module RTP
     #
     alias_method :state, :values
 
+    # Converts the collimator attribute to proper DICOM format.
+    #
+    # @param [Symbol] axis a representation for the axis of interest (x or y)
+    # @return [Float] the DICOM-formatted collimator attribute
+    #
+    def dcm_collimator1(axis)
+      value = self.send("collimator_#{axis}1").to_f * 10
+      mode = self.send("field_#{axis}_mode")
+      if mode && mode.upcase == 'SYM' && value > 0
+        -value
+      else
+        value
+      end
+    end
+
   end
 
 end