rtp-connect 1.9 → 1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d14e5fd97bfd2c6331fd30fc0a74b0e8e6a75f7
-  data.tar.gz: 6e8bc11d9d6dbd7ba739657cb51f10d7dab37cf2
+  metadata.gz: d562152c2ccba6301fcf82f5bdd7329c8efb0515
+  data.tar.gz: ef3af37f9d5960f1821073345950b7523aa66ee3
 SHA512:
-  metadata.gz: 59d74a73647a8f6f8dbc37ef26d5f9dea0a96c115ca8894fa368d86d6ff6fb2d788cb15071479df5faff65d215b623a63ae0bfab691184d582339d23e7fe3fc3
-  data.tar.gz: 00a0d20da67fc7bf8e4bcc4a05e2c9abbaec421fac260eaa583692a5c5c7324c1e5d059227e10065734d81cd430ec0c7453d7e6c5aae0b653a9f1eea01bfc3e4
+  metadata.gz: bc23ea92ce17778ec1c0c253d68c976d3b5079fb80dc7b3f85f3d93afccb3e95f502d812bf0d408ff347d9f88251cd4caa34a1c87febf3847b4ca74ad55db5bd
+  data.tar.gz: 7c5b9a0174462db12b0c015915a9a655ed943f37dc611225b8620444bf47b5c77a54da8ab433766f87cf37851dfe0cd2257ad25b21fd66a7f4b9c5c407349332

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-# 1.9
+# 1.10
 
 ## (Unreleased)
 
+* Added support for Mosaiq 2.64, which includes three new iso_pos_x/y/z attributes in the Field and ControlPoint records.
+
+# 1.9
+
+## 23rd March 2016
+
 * Added an variable for retrieving a record's attributes (in an array).
 * Added a sample script for beam parameter modification (useful for linac/plan QA purposes).
 * Made the parent attribute accessible, and properly update the parent attribute when assigning a record to a new parent.

data/Gemfile.lock

@@ -1,45 +1,45 @@
 PATH
   remote: .
   specs:
-    rtp-connect (1.9)
+    rtp-connect (1.10)
 
 GEM
   remote: http://www.rubygems.org/
   specs:
-    dicom (0.9.6)
+    dicom (0.9.8)
     diff-lcs (1.2.5)
     metaclass (0.0.4)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    rake (10.5.0)
-    redcarpet (3.3.3)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (12.3.1)
+    redcarpet (3.4.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.0)
-    yard (0.8.7.6)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    yard (0.9.12)
 
 PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  bundler (~> 1.8)
-  dicom (~> 0.9, >= 0.9.6)
+  bundler (~> 1.11)
+  dicom (~> 0.9, >= 0.9.8)
   mocha (~> 1.1)
-  rake (~> 10.4)
-  redcarpet (~> 3.2)
-  rspec (~> 3.2)
+  rake (~> 12.3)
+  redcarpet (~> 3.4)
+  rspec (~> 3.7)
   rtp-connect!
-  yard (~> 0.8, >= 0.8.7)
+  yard (~> 0.9, >= 0.9.12)
 
 BUNDLED WITH
-   1.11.2
+   1.16.5

data/README.md

@@ -56,6 +56,17 @@ external dependencies.
     # Write a corrected RTP file:
     rtp.write('valid.rtp')
 
+### Write RTP files for specific Mosaiq versions:
+
+    # Mosaiq 2.4:
+    rtp.write('treatment_plan.rtp', version: 2.4)
+    # Mosaiq 2.5:
+    rtp.write('treatment_plan.rtp', version: 2.5)
+    # Mosaiq 2.6 (and 2.62):
+    rtp.write('treatment_plan.rtp', version: 2.6)
+    # By default files are outputted at the latest supported version (currently 2.64) when omitting the version parameter:
+    rtp.write('treatment_plan.rtp')
+
 ### Convert an RTP file to DICOM:
 
     p = Plan.read('some_file.rtp')
@@ -125,7 +136,7 @@ If you encounter an RTP file with an unsupported record type, please contact me.
 
 ## COPYRIGHT
 
-Copyright 2011-2016 Christoffer Lervåg
+Copyright 2011-2018 Christoffer Lervåg
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/lib/rtp-connect/control_point.rb

@@ -46,6 +46,9 @@ module RTP
     attr_reader :couch_dir
     attr_reader :couch_pedestal
     attr_reader :couch_ped_dir
+    attr_reader :iso_pos_x
+    attr_reader :iso_pos_y
+    attr_reader :iso_pos_z
     # Note: This attribute contains an array of all MLC LP A values (leaves 1..100).
     attr_reader :mlc_lp_a
     # Note: This attribute contains an array of all MLC LP B values (leaves 1..100).
@@ -68,7 +71,7 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
-      super('CONTROL_PT_DEF', 233, 233)
+      super('CONTROL_PT_DEF', 233, 236)
       # Child:
       @mlc_shape = nil
       # Parent relation (may get more than one type of record here):
@@ -110,6 +113,9 @@ module RTP
         :couch_dir,
         :couch_pedestal,
         :couch_ped_dir,
+        :iso_pos_x,
+        :iso_pos_y,
+        :iso_pos_z,
         :mlc_lp_a,
         :mlc_lp_b
       ]
@@ -250,6 +256,9 @@ module RTP
         @couch_dir,
         @couch_pedestal,
         @couch_ped_dir,
+        @iso_pos_x,
+        @iso_pos_y,
+        @iso_pos_z,
         *@mlc_lp_a,
         *@mlc_lp_b
       ]
@@ -531,6 +540,30 @@ module RTP
       @couch_ped_dir = value && value.to_s
     end
 
+    # Sets the iso_pos_x attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def iso_pos_x=(value)
+      @iso_pos_x = value && value.to_s.strip
+    end
+
+    # Sets the iso_pos_y attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def iso_pos_y=(value)
+      @iso_pos_y = value && value.to_s.strip
+    end
+
+    # Sets the iso_pos_z attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def iso_pos_z=(value)
+      @iso_pos_z = value && value.to_s.strip
+    end
+
 
     private
 
@@ -584,10 +617,30 @@ module RTP
       # 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] }
+      #
+      # Furthermore, as of Mosaiq version 2.64, the RTP ControlPoint record includes
+      # 3 new attributes: iso_pos_x/y/z. Since these (unfortunately) are not placed
+      # at the end of the record (which is the norm), but rather inserted before the
+      # MLC leaf positions, we have to take special care here to make sure that this
+      # gets right for records where these are included or excluded.
+      #
+      # Override length:
+      applied_length = 235
+      ind = Array.new(applied_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
+      # Allocation here is dependent on the RTP file version:
+      # For 2.62 and earlier, where length is 232, we dont have the 3 iso_pos_x/y/z values preceeding the mlc arrays leaf position arrays.
+      # For 2.64 (and later), where length is 235, we have the 3 iso_pos_x/y/z values preceeding the mlc leaf position arrays.
+      if length == 232
+        ind[32] = nil
+        ind[33] = nil
+        ind[34] = nil
+        ind[35] = (32..131).to_a
+        ind[36] = (132..231).to_a
+      else # (length = 235)
+        ind[35] = (35..134).to_a
+        ind[36] = (135..234).to_a
+      end
       ind
     end
 

data/lib/rtp-connect/field.rb

@@ -61,6 +61,9 @@ module RTP
     attr_reader :portfilm_delta_open
     attr_reader :portfilm_mu_treat
     attr_reader :portfilm_coeff_treat
+    attr_reader :iso_pos_x
+    attr_reader :iso_pos_y
+    attr_reader :iso_pos_z
 
     # Creates a new (treatment) Field by parsing a RTPConnect string line.
     #
@@ -79,7 +82,7 @@ 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)
+      super('FIELD_DEF', 27, 52)
       # Child records:
       @control_points = Array.new
       @extended_field = nil
@@ -136,7 +139,10 @@ module RTP
         :portfilm_coeff_open,
         :portfilm_delta_open,
         :portfilm_mu_treat,
-        :portfilm_coeff_treat
+        :portfilm_coeff_treat,
+        :iso_pos_x,
+        :iso_pos_y,
+        :iso_pos_z
       ]
     end
 
@@ -635,6 +641,30 @@ module RTP
       @portfilm_coeff_treat = value && value.to_s
     end
 
+    # Sets the iso_pos_x attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def iso_pos_x=(value)
+      @iso_pos_x = value && value.to_s.strip
+    end
+
+    # Sets the iso_pos_y attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def iso_pos_y=(value)
+      @iso_pos_y = value && value.to_s.strip
+    end
+
+    # Sets the iso_pos_z attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def iso_pos_z=(value)
+      @iso_pos_z = value && value.to_s.strip
+    end
+
 
     private
 

data/lib/rtp-connect/plan.rb

@@ -1,4 +1,4 @@
-#    Copyright 2011-2016 Christoffer Lervag
+#    Copyright 2011-2018 Christoffer Lervag
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by

data/lib/rtp-connect/record.rb

@@ -161,8 +161,11 @@ module RTP
     #
     def set_attributes(values)
       import_indices([values.length - 1, @max_elements - 1].min).each_with_index do |indices, i|
-        param = values.values_at(*indices)
-        param = param[0] if param.length == 1
+        param = nil
+        if indices
+          param = values.values_at(*indices)
+          param = param[0] if param.length == 1
+        end
         self.send("#{@attributes[i]}=", param)
       end
       @crc = values[-1]
@@ -190,8 +193,12 @@ module RTP
       case self
       when SiteSetup
         options[:version].to_f >= 2.6 ? values : values[0..-4]
+      when Field
+        options[:version].to_f >= 2.64 ? values : values[0..-4]
       when ExtendedField
         options[:version].to_f >= 2.4 ? values : values[0..-5]
+      when ControlPoint
+        options[:version].to_f >= 2.64 ? values : values[0..31] + values[35..-1]
       else
         values
       end

data/lib/rtp-connect/version.rb

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

data/rtp-connect.gemspec

@@ -16,13 +16,13 @@ Gem::Specification.new do |s|
   s.description = 'RTPConnect is a file format used in radiotherapy for export & import of treatment planning data.'
   s.files = Dir["{lib}/**/*", "[A-Z]*"]
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.2'
 
-  s.add_development_dependency('bundler', '~> 1.8')
-  s.add_development_dependency('dicom', '~> 0.9', '>= 0.9.6')
+  s.add_development_dependency('bundler', '~> 1.11')
+  s.add_development_dependency('dicom', '~> 0.9', '>= 0.9.8')
   s.add_development_dependency('mocha', '~> 1.1')
-  s.add_development_dependency('rake', '~> 10.4')
-  s.add_development_dependency('redcarpet', '~> 3.2')
-  s.add_development_dependency('rspec', '~> 3.2')
-  s.add_development_dependency('yard', '~> 0.8', '>= 0.8.7')
+  s.add_development_dependency('rake', '~> 12.3')
+  s.add_development_dependency('redcarpet', '~> 3.4')
+  s.add_development_dependency('rspec', '~> 3.7')
+  s.add_development_dependency('yard', '~> 0.9', '>= 0.9.12')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtp-connect
 version: !ruby/object:Gem::Version
-  version: '1.9'
+  version: '1.10'
 platform: ruby
 authors:
 - Christoffer Lervag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: dicom
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +33,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: 0.9.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: 0.9.8
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -64,62 +64,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.12
 description: RTPConnect is a file format used in radiotherapy for export & import
   of treatment planning data.
 email: chris.lervag@gmail.com
@@ -164,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -172,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Library for handling RTPConnect files.
 test_files: []
-has_rdoc: