dcm_dict 0.1.0

data/lib/dcm_dict/dictionary/uid_record.rb

@@ -0,0 +1,48 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+require_relative 'base_record'
+
+module DcmDict
+  module Dictionary
+    UidMethodMap = {uid_value: :uid_value,
+                    uid: :uid_value,
+                    uid_name: :uid_name,
+                    uid_type: :uid_type }.freeze
+
+    UidMethod = UidMethodMap.flatten.uniq.freeze
+
+    # Class to handle uid record from source dictionary data
+    class UidRecord < BaseRecord
+      def initialize(data)
+        super
+      end
+
+      private
+      def method_map
+        UidMethodMap
+      end
+    end
+
+  end
+end

data/lib/dcm_dict/encoder/data_to_code.rb

@@ -0,0 +1,79 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Encoder
+    module DataToCode
+      using DcmDict::Refine::Internal::ArrayRefineInternal
+
+      # Convert data element +data+ to Ruby code using +indent+ spaces indentation
+      def self.data_element_data_to_code(data, indent=4)
+        indent = 4 unless indent
+        tag_ary_str = "[0x#{data[:tag_ary].tag_group_str},0x#{data[:tag_ary].tag_element_str}]"
+        "#{' '*indent}{ tag_ps: '#{data[:tag_ps]}', tag_name: \"#{data[:tag_name]}\", tag_key: '#{data[:tag_key]}', tag_vr: #{data[:tag_vr]}, tag_vm: #{data[:tag_vm]}, tag_str: '#{data[:tag_str]}', tag_sym: #{data[:tag_sym].inspect}, tag_ndm: '#{data[:tag_ndm]}', tag_ary: #{tag_ary_str}, tag_multiple: #{data[:tag_multiple].inspect}, tag_note: '#{data[:tag_note]}'},"
+      end
+
+      # Source data element header
+      def self.data_element_header
+        <<END
+module DcmDict
+  module SourceData
+    DataElementsData = [
+END
+      end
+
+      # Source data element footer
+      def self.data_element_footer
+        <<END
+    ]
+  end
+end
+END
+      end
+
+      # Source uid header
+      def self.uid_header
+        <<END
+module DcmDict
+  module SourceData
+    UidValuesData = [
+END
+      end
+
+      # Source uid footer
+      def self.uid_footer
+        <<END
+    ]
+  end
+end
+END
+      end
+
+      # Convert uid +data+ to Ruby code using +indent+ spaces indentation
+      def self.uid_data_to_code(data, indent=4)
+        indent = 4 unless indent
+        "#{' '*indent}{ uid_value: '#{data[:uid_value]}', uid_name: \"#{data[:uid_name]}\", uid_type: #{data[:uid_type].inspect}},"
+      end
+    end
+  end
+end

data/lib/dcm_dict/error/dictionary_error.rb

@@ -0,0 +1,30 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+
+  # Dictionary Exception class
+  class DictionaryError < StandardError
+  end
+
+end

data/lib/dcm_dict/ext/object_extension.rb

@@ -0,0 +1,38 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Ext
+
+    # Extension for object class
+    class ::Object
+
+      # Check for nil or 'empty' object
+      def nil_or_empty?
+        return empty? if(respond_to?(:empty?))
+        nil?
+      end
+    end
+
+  end
+end

data/lib/dcm_dict/refine/array_refine.rb

@@ -0,0 +1,34 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Refine
+    module ArrayRefine
+
+      refine Array do
+        include DcmDict::Refine::DataElementRefine
+      end
+
+    end
+  end
+end

data/lib/dcm_dict/refine/data_element_refine.rb

@@ -0,0 +1,37 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Refine
+
+    # Module to manage data element record data
+    module DataElementRefine
+      DcmDict::Dictionary::DataElementMethod.each do |method|
+        define_method(method) do
+          Dictionary::TheDataElementDictionary.feature_at(self, method)
+        end
+      end
+    end
+
+  end
+end

data/lib/dcm_dict/refine/internal/array_refine_internal.rb

@@ -0,0 +1,97 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Refine
+    module Internal
+      module ArrayRefineInternal
+
+        refine Array do
+          # Tag group as number
+          def tag_group_num
+            check_dicom_tag
+            self[0]
+          end
+
+          # Tag element as number
+          def tag_element_num
+            check_dicom_tag
+            self[1]
+          end
+
+          # Tag group as string
+          def tag_group_str
+            tag_group_num.to_s(16).rjust(4, '0').upcase()
+          end
+
+          # Tag element as string
+          def tag_element_str
+            tag_element_num.to_s(16).rjust(4, '0').upcase()
+          end
+
+          # Tag as string
+          def to_tag_str
+            "(#{tag_group_str},#{tag_element_str})"
+          end
+
+          # Tag as Native Dicom Model tag
+          def to_tag_ndm
+            "#{tag_group_str}#{tag_element_str}"
+          end
+
+          # Tag as array
+          def to_tag_ary
+            [tag_group_num, tag_element_num]
+          end
+
+          # Check for group length tag
+          def group_length_tag?
+            tag_element_num == 0
+          end
+
+          # Check for private creator tag
+          def private_creator_tag?
+            (tag_group_num.odd? && (tag_element_num < 0xff))
+          end
+
+          private
+          def check_dicom_tag
+            return true if ( (self.size==2) &&
+                             valid_tag_value?(0) &&
+                             valid_tag_value?(1) )
+            raise "Wrong object definition for Tag Array"
+          end
+
+          def valid_tag_value?(index)
+            value = self[index]
+            return true if ( (value.is_a?(Integer)) &&
+                             (value.bit_length <=16) &&
+                             (value >=0) )
+            raise "Wrong value at index #{index} for Tag Array"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dcm_dict/refine/internal/hash_refine_internal.rb

@@ -0,0 +1,71 @@
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Refine
+    module Internal
+      module HashRefineInternal
+
+        refine Hash do
+          # Check/update content for data tag field
+          def check_base_data_tag_field!
+            check_tag_ps!
+            check_placeholder_data!
+            self
+          end
+
+          # Check for mandatory :tag_ps key
+          def check_tag_ps!
+            tag_ps = self[:tag_ps]
+            raise "Missing tag_ps field" if tag_ps.nil_or_empty?
+            tag_ps.upcase!
+          end
+
+          # Check for place holder tag data
+          def check_placeholder_data!
+            # PS3.5:
+            # For some Data Elements, no Name or Keyword or VR or VM is specified;
+            # these are "placeholders" that are not assigned but will not be reused.
+            tag_ps = self[:tag_ps]
+            raise "Missing tag_ps field" if tag_ps.nil_or_empty?
+            fill_nil_or_empty_value(:tag_name) { "Placeholder #{tag_ps}" }
+            fill_nil_or_empty_value(:tag_key) do
+              new_key = tag_ps.gsub(',','_').gsub(/[\(\)]/,'')
+              "Placeholder_#{new_key}"
+            end
+            fill_nil_or_empty_value(:tag_vr) { [:UN] }
+            fill_nil_or_empty_value(:tag_vm) { ['1'] }
+          end
+
+          private
+          def fill_nil_or_empty_value(key)
+            if self[key].nil_or_empty?
+              self[key] = yield
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dcm_dict/refine/internal/string_refine_internal.rb

@@ -0,0 +1,119 @@
+# coding: utf-8
+#
+#  Copyright (C) 2014  Enrico Rivarola
+#
+#  This file is part of DcmDict gem (dcm_dict).
+#
+#  DcmDict 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.
+#
+#  DcmDict 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 DcmDict.  If not, see <http://www.gnu.org/licenses/>.
+#
+#  This software has neither been tested nor approved for clinical use
+#  or for incorporation in a medical device.
+#  It is the redistributor's or user's responsibility to comply with any
+#  applicable local, state, national or international regulations.
+#
+module DcmDict
+  module Refine
+    module Internal
+      module StringRefineInternal
+
+        refine String do
+
+          # Remove zero width spaces (-> "​") and leading/trailing whitespace
+          def dcm_unspace
+            zero_width_space = "\u200B"
+            self.gsub(zero_width_space, '').strip
+          end
+
+          # Convert tag key to tag symbol -> 'PatientName' -> :patient_name
+          def tag_key_to_sym
+            self.gsub('IDs', 'IDS').gsub('3D', '_3D').
+              gsub(/([A-Z])([a-z])/,'_\1\2').
+              gsub(/([a-z])([A-Z])/,'\1_\2').
+              gsub(/^_/,'').
+              downcase.
+              to_sym
+          end
+
+          # Tag group as number
+          def tag_group_num
+            tag_group_str.hex
+          end
+
+          # Tag element as number
+          def tag_element_num
+            tag_element_str.hex
+          end
+
+          # Tag group as string
+          def tag_group_str
+            self.to_tag_ndm[0..3]
+          end
+
+          # Tag element as string
+          def tag_element_str
+            self.to_tag_ndm[4..7]
+          end
+
+          # Tag as Native Dicom Model tag ('(0010,0010)' -> '00100010')
+          def to_tag_ndm
+            check_dicom_tag
+            self.gsub(/[\(|\),]/, '').upcase
+          end
+
+          # Tag as array ('(0010,0010)' -> [0x0010, 0x0010])
+          def to_tag_ary
+            [tag_group_num, tag_element_num]
+          end
+
+          # Tag as string ('00100010'/'(0010,0010)' -> '(0010,0010)')
+          def to_tag_str
+            "(#{tag_group_str},#{tag_element_str})"
+          end
+
+          # Convert uid type to symbol
+          def uid_type_to_sym
+            self.gsub(/[ -\/]/, '_').
+              downcase.
+              to_sym
+          end
+
+          # Check for valid uid value
+          def uid_value?
+            (self.length <= 64) &&
+              (/^(([0-9][\.])|([1-9][0-9]*[\.]))*(([0-9])|([1-9][0-9]*))$/.match(self) != nil)
+          end
+
+          # Check for group length tag
+          def group_length_tag?
+            tag_element_num == 0
+          end
+
+          # Check for private creator tag
+          def private_creator_tag?
+            (tag_group_num.odd? && (tag_element_num < 0xff))
+          end
+
+          private
+          def check_dicom_tag
+            return true if (/^[0-9|A-F]{8}$/.match(self) ||
+                            /^[\(][0-9a-fA-F]{4}[\)\,\(][0-9a-fA-F]{4}\)$/.match(self))
+            raise "wrong value for tag #{self.inspect}"
+          end
+
+        end
+
+      end
+    end
+  end
+end