rtp-connect 1.8 → 1.9

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://www.rubygems.org"
-
+source "http://www.rubygems.org"
+
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rtp-connect (1.8)
+    rtp-connect (1.9)
 
 GEM
   remote: http://www.rubygems.org/
@@ -11,31 +11,35 @@ GEM
     metaclass (0.0.4)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    rake (10.3.2)
-    redcarpet (3.1.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-    yard (0.8.7.3)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.0)
+    yard (0.8.7.6)
 
 PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  bundler (~> 1.6)
+  bundler (~> 1.8)
   dicom (~> 0.9, >= 0.9.6)
   mocha (~> 1.1)
-  rake (~> 10.3)
-  redcarpet (~> 3.1)
-  rspec (~> 3.0)
+  rake (~> 10.4)
+  redcarpet (~> 3.2)
+  rspec (~> 3.2)
   rtp-connect!
   yard (~> 0.8, >= 0.8.7)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,150 +1,150 @@
-[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11752.png)](http://dx.doi.org/10.5281/zenodo.11752)
-
-# RTPConnect
-
-The RTPConnect library allows you to read, edit and write RTPConnect files in Ruby.
-RTPConnect is a file format used in radiotherapy (e.g. Mosaiq) for export & import
-of treatment planning data. The library is written entirely in Ruby and has no
-external dependencies.
-
-
-## INSTALLATION
-
-  gem install rtp-connect
-
-
-## REQUIREMENTS
-
-* Ruby 1.9.3 (or higher)
-
-
-## BASIC USAGE
-
-### Load & Include
-
-    require 'rtp-connect'
-    include RTP
-
-### Read, modify and write
-
-    # Read file:
-    rtp = Plan.read('some_file.rtp')
-    # Extract the Patient's Name:
-    name = rtp.patient_last_name
-    # Modify the Patient's Name:
-    rtp.patient_last_name = 'Anonymous'
-    # Write to file:
-    rtp.write('new_file.rtp')
-
-### Create a new Plan Definition Record from scratch
-
-    # Create the instance:
-    rtp = Plan.new
-    # Set the Patient's ID attribute:
-    rtp.patient_id = '12345'
-    # Export the instance to an RTP string (with CRC):
-    output = rtp.to_s
-
-### Fix invalid RTP files:
-
-    # Read an RTP file containing invalid checksum(s):
-    rtp = Plan.read('invalid_crc.rtp', ignore_crc: true)
-    # Read an RTP file containing unknown record type(s):
-    rtp = Plan.read('custom.rtp', skip_unknown: true)
-    # Read an RTP file containing invalid CSV format:
-    rtp = Plan.read('invalid_csv.rtp', repair: true)
-    # Write a corrected RTP file:
-    rtp.write('valid.rtp')
-
-### Convert an RTP file to DICOM:
-
-    p = Plan.read('some_file.rtp')
-    dcm = p.to_dcm
-    dcm.write('rtplan.dcm')
-
-### Log settings
-
-    # Change the log level so that only error messages are displayed:
-    RTP.logger.level = Logger::ERROR
-    # Setting up a simple file log:
-    l = Logger.new('my_logfile.log')
-    RTP.logger = l
-    # Create a logger which ages logfile daily/monthly:
-    RTP.logger = Logger.new('foo.log', 'daily')
-    RTP.logger = Logger.new('foo.log', 'monthly')
-
-### Scripts
-
-For more comprehensive and useful examples, check out the scripts folder
-which contains various Ruby scripts that intends to show off real world
-usage scenarios of the RTPConnect library.
-
-### IRB Tip
-
-When working with the RTPConnect library in irb, you may be annoyed with all
-the information that is printed to screen, regardless of your log level.
-This is because in irb every variable loaded in the program is
-automatically printed to the screen. A useful hack to avoid this effect is
-to append ";0" after a command.
-
-Example:
-
-    rtp = Plan.read('some_file.rtp') ;0
-
-
-## RESOURCES
-
-* [Rubygems download](https://rubygems.org/gems/rtp-connect)
-* [Documentation](http://rubydoc.info/gems/rtp-connect/frames)
-* [Source code repository](https://github.com/dicom/rtp-connect)
-
-
-## RESTRICTIONS
-
-### Supported records
-
-* Plan definition [PLAN_DEF]
-* Extended plan definition [EXTENDED_PLAN_DEF]
-* Prescription site [RX_DEF]
-* Site setup [SITE_SETUP_DEF]
-* Simulation field [SIM_DEF]
-* Treatment field [FIELD_DEF]
-* Extended treatment field [EXTENDED_FIELD_DEF]
-* Control point record [CONTROL_PT_DEF]
-* Dose tracking record [DOSE_DEF]
-
-### Unsupported records
-
-* Document based treatment field [PDF_FIELD_DEF]
-* Multileaf collimator [MLC_DEF]
-* MLC shape [MLC_SHAPE_DEF]
-* Dose action points [DOSE_ACTION]
-
-If you encounter an RTP file with an unsupported record type, please contact me.
-
-
-## COPYRIGHT
-
-Copyright 2011-2015 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
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see http://www.gnu.org/licenses/ .
-
-
-## ABOUT THE AUTHOR
-
-* Name: Christoffer Lervåg
-* Location: Norway
-* Email: chris.lervag [@nospam.com] @gmail.com
-
+[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11752.png)](http://dx.doi.org/10.5281/zenodo.11752)
+
+# RTPConnect
+
+The RTPConnect library allows you to read, edit and write RTPConnect files in Ruby.
+RTPConnect is a file format used in radiotherapy (e.g. Mosaiq) for export & import
+of treatment planning data. The library is written entirely in Ruby and has no
+external dependencies.
+
+
+## INSTALLATION
+
+  gem install rtp-connect
+
+
+## REQUIREMENTS
+
+* Ruby 1.9.3 (or higher)
+
+
+## BASIC USAGE
+
+### Load & Include
+
+    require 'rtp-connect'
+    include RTP
+
+### Read, modify and write
+
+    # Read file:
+    rtp = Plan.read('some_file.rtp')
+    # Extract the Patient's Name:
+    name = rtp.patient_last_name
+    # Modify the Patient's Name:
+    rtp.patient_last_name = 'Anonymous'
+    # Write to file:
+    rtp.write('new_file.rtp')
+
+### Create a new Plan Definition Record from scratch
+
+    # Create the instance:
+    rtp = Plan.new
+    # Set the Patient's ID attribute:
+    rtp.patient_id = '12345'
+    # Export the instance to an RTP string (with CRC):
+    output = rtp.to_s
+
+### Fix invalid RTP files:
+
+    # Read an RTP file containing invalid checksum(s):
+    rtp = Plan.read('invalid_crc.rtp', ignore_crc: true)
+    # Read an RTP file containing unknown record type(s):
+    rtp = Plan.read('custom.rtp', skip_unknown: true)
+    # Read an RTP file containing invalid CSV format:
+    rtp = Plan.read('invalid_csv.rtp', repair: true)
+    # Write a corrected RTP file:
+    rtp.write('valid.rtp')
+
+### Convert an RTP file to DICOM:
+
+    p = Plan.read('some_file.rtp')
+    dcm = p.to_dcm
+    dcm.write('rtplan.dcm')
+
+### Log settings
+
+    # Change the log level so that only error messages are displayed:
+    RTP.logger.level = Logger::ERROR
+    # Setting up a simple file log:
+    l = Logger.new('my_logfile.log')
+    RTP.logger = l
+    # Create a logger which ages logfile daily/monthly:
+    RTP.logger = Logger.new('foo.log', 'daily')
+    RTP.logger = Logger.new('foo.log', 'monthly')
+
+### Scripts
+
+For more comprehensive and useful examples, check out the scripts folder
+which contains various Ruby scripts that intends to show off real world
+usage scenarios of the RTPConnect library.
+
+### IRB Tip
+
+When working with the RTPConnect library in irb, you may be annoyed with all
+the information that is printed to screen, regardless of your log level.
+This is because in irb every variable loaded in the program is
+automatically printed to the screen. A useful hack to avoid this effect is
+to append ";0" after a command.
+
+Example:
+
+    rtp = Plan.read('some_file.rtp') ;0
+
+
+## RESOURCES
+
+* [Rubygems download](https://rubygems.org/gems/rtp-connect)
+* [Documentation](http://rubydoc.info/gems/rtp-connect/frames)
+* [Source code repository](https://github.com/dicom/rtp-connect)
+
+
+## RESTRICTIONS
+
+### Supported records
+
+* Plan definition [PLAN_DEF]
+* Extended plan definition [EXTENDED_PLAN_DEF]
+* Prescription site [RX_DEF]
+* Site setup [SITE_SETUP_DEF]
+* Simulation field [SIM_DEF]
+* Treatment field [FIELD_DEF]
+* Extended treatment field [EXTENDED_FIELD_DEF]
+* Control point record [CONTROL_PT_DEF]
+* Dose tracking record [DOSE_DEF]
+
+### Unsupported records
+
+* Document based treatment field [PDF_FIELD_DEF]
+* Multileaf collimator [MLC_DEF]
+* MLC shape [MLC_SHAPE_DEF]
+* Dose action points [DOSE_ACTION]
+
+If you encounter an RTP file with an unsupported record type, please contact me.
+
+
+## COPYRIGHT
+
+Copyright 2011-2016 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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see http://www.gnu.org/licenses/ .
+
+
+## ABOUT THE AUTHOR
+
+* Name: Christoffer Lervåg
+* Location: Norway
+* Email: chris.lervag [@nospam.com] @gmail.com
+
 Please don't hesitate to email me if you have any feedback related to this project!

data/lib/rtp-connect/constants.rb

@@ -1,59 +1,59 @@
-module RTP
-
-  # The seed value used in the RTPConnect implementation of the CCITT algorithm.
-  CRC_SEED = 0x0521
-
-  # The table & values used in the RTPConnect implementation of the CCITT algorithm.
-  CRC_TABLE = [
-    0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
-    0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
-    0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
-    0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
-    0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
-    0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
-    0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
-    0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
-    0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
-    0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
-    0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
-    0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
-    0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
-    0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
-    0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
-    0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
-    0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
-    0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
-    0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
-    0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
-    0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
-    0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
-    0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
-    0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
-    0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
-    0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
-    0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
-    0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
-    0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
-    0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
-    0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
-    0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
-  ]
-
-  # Pairs of RTPConnect keywords and parse method names.
-  PARSE_METHOD = {
-    "PLAN_DEF" => :plan_definition,
-    "EXTENDED_PLAN_DEF" => :extended_plan_def,
-    "RX_DEF" => :prescription_site,
-    "SITE_SETUP_DEF" => :site_setup,
-    "SIM_DEF" => :simulation_field,
-    "FIELD_DEF" => :treatment_field,
-    "EXTENDED_FIELD_DEF" => :extended_treatment_field,
-    "PDF_FIELD_DEF" => :document_based_treatment_field,
-    "MLC_DEF" => :multileaf_collimator,
-    "CONTROL_PT_DEF" => :control_point,
-    "MLC_SHAPE_DEF" => :mlc_shape,
-    "DOSE_DEF" => :dose_tracking,
-    "DOSE_ACTION" => :dose_action,
-  }
-
+module RTP
+
+  # The seed value used in the RTPConnect implementation of the CCITT algorithm.
+  CRC_SEED = 0x0521
+
+  # The table & values used in the RTPConnect implementation of the CCITT algorithm.
+  CRC_TABLE = [
+    0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
+    0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
+    0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
+    0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
+    0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
+    0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
+    0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
+    0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
+    0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
+    0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
+    0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
+    0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
+    0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
+    0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
+    0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
+    0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
+    0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
+    0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
+    0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
+    0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
+    0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
+    0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
+    0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
+    0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
+    0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
+    0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
+    0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
+    0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
+    0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
+    0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
+    0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
+    0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
+  ]
+
+  # Pairs of RTPConnect keywords and parse method names.
+  PARSE_METHOD = {
+    "PLAN_DEF" => :plan_definition,
+    "EXTENDED_PLAN_DEF" => :extended_plan_def,
+    "RX_DEF" => :prescription_site,
+    "SITE_SETUP_DEF" => :site_setup,
+    "SIM_DEF" => :simulation_field,
+    "FIELD_DEF" => :treatment_field,
+    "EXTENDED_FIELD_DEF" => :extended_treatment_field,
+    "PDF_FIELD_DEF" => :document_based_treatment_field,
+    "MLC_DEF" => :multileaf_collimator,
+    "CONTROL_PT_DEF" => :control_point,
+    "MLC_SHAPE_DEF" => :mlc_shape,
+    "DOSE_DEF" => :dose_tracking,
+    "DOSE_ACTION" => :dose_action,
+  }
+
 end