dcm_dict 0.1.0

data/lib/dcm_dict.rb

@@ -0,0 +1,46 @@
+#
+#  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 "dcm_dict/version"
+require "dcm_dict/error/dictionary_error"
+require "dcm_dict/ext/object_extension"
+require "dcm_dict/refine/internal/string_refine_internal"
+require "dcm_dict/refine/internal/array_refine_internal"
+require "dcm_dict/refine/internal/hash_refine_internal"
+require "dcm_dict/xml/constant"
+require "dcm_dict/xml/field_data"
+require "dcm_dict/xml/tag_field_data"
+require "dcm_dict/xml/uid_field_data"
+require "dcm_dict/encoder/data_to_code"
+require "dcm_dict/source_data/data_elements_data"
+require "dcm_dict/source_data/uid_values_data"
+require "dcm_dict/source_data/detached_data"
+require "dcm_dict/dictionary/data_element_record"
+require "dcm_dict/dictionary/data_element_dictionary"
+require "dcm_dict/dictionary/uid_record"
+require "dcm_dict/dictionary/uid_dictionary"
+require "dcm_dict/refine/data_element_refine"
+require "dcm_dict/refine/uid_refine"
+require "dcm_dict/refine/string_refine"
+require "dcm_dict/refine/array_refine"
+require "dcm_dict/refine/symbol_refine"

data/lib/dcm_dict/dictionary/base_dictionary.rb

@@ -0,0 +1,47 @@
+#
+#  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 Dictionary
+
+    # Base class for specific dictionary
+    class BaseDictionary
+      def initialize
+        @semaphore = Mutex.new
+        map_source_data
+        freeze_source_data
+      end
+
+      # Find record data using +key+
+      def record_at(key)
+        @semaphore.synchronize { atomic_record_at(key) }
+      end
+
+      # Find single feature identified by +field+ for record indexed by +key+
+      def feature_at(key, field)
+        @semaphore.synchronize { atomic_feature_at(key, field) }
+      end
+    end
+
+  end
+end

data/lib/dcm_dict/dictionary/base_record.rb

@@ -0,0 +1,62 @@
+#
+#  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 Dictionary
+
+    # Base class for dictionary record element
+    class BaseRecord
+      def initialize(data)
+        @data = {}
+        initialize_data(data)
+      end
+
+      private
+      def method_missing(name, *args, &block)
+        name_as_sym = name.to_sym
+        return @data[method_map[name_as_sym]] if (method_map.has_key?(name_as_sym))
+        return @data[name_as_sym] if (@data.has_key?(name_as_sym))
+        super
+      end
+
+      def respond_to_missing?(name, include_priv)
+        method_map.has_key?(name) || @data.has_key?(name)
+      end
+
+      def initialize_data(data)
+        @data = data
+        freeze_data
+      end
+
+      def freeze_data
+        @data.each {|key, value| value.freeze }
+        @data.freeze
+      end
+
+      def record_data
+        @data
+      end
+
+    end
+  end
+end

data/lib/dcm_dict/dictionary/data_element_dictionary.rb

@@ -0,0 +1,117 @@
+#
+#  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_dictionary'
+
+module DcmDict
+  module Dictionary
+    DataElementIndexKey = [:tag_ps, :tag_name, :tag_key, :tag_str,
+                           :tag_sym, :tag_ndm, :tag_ary]
+
+    # Main class to handle data element data as dictionary
+    class DataElementDictionary < BaseDictionary
+      using DcmDict::Refine::Internal::ArrayRefineInternal
+      using DcmDict::Refine::Internal::StringRefineInternal
+
+      def initialize
+        super
+      end
+
+      private
+      def map_source_data
+        @standard_dict = {}
+        @multi_dict = []
+        SourceData::DataElementsData.each do |data|
+          record = DataElementRecord.new(data).freeze
+          DataElementIndexKey.each { |key| @standard_dict[data[key]] = record }
+          @multi_dict << record if record.tag_multiple?
+        end
+      end
+
+      def freeze_source_data
+        @standard_dict.freeze
+        @multi_dict.freeze
+      end
+
+      def atomic_feature_at(tag, key)
+        try_to_find_feature(tag, key)
+      rescue Exception => ex
+        raise DictionaryError.new("Unable to find feature #{key.inspect} for tag '#{tag}' (#{ex.class}: #{ex.message.inspect})")
+
+      end
+
+      def try_to_find_feature(tag, key)
+        atomic_record_at(tag).send(key)
+      end
+
+      def atomic_record_at(tag)
+        try_to_find(tag)
+      rescue Exception => ex
+        raise DictionaryError.new("Unable to find reference for tag '#{tag}' as #{tag.class} (#{ex.class}: #{ex.message.inspect})")
+      end
+
+      def try_to_find(tag)
+        try_to_find_standard_tag(tag) ||
+          try_to_find_group_length_tag(tag) ||
+          try_to_find_multiple_tag(tag) ||
+          try_to_find_private_creator_tag(tag) ||
+          try_to_find_unknown_tag(tag)
+      end
+
+      def try_to_find_standard_tag(tag)
+        @standard_dict[tag]
+      end
+
+      def try_to_find_multiple_tag(tag)
+        @multi_dict.each do |record|
+          mrec = record.extract_multiple_tag_record(tag)
+          return mrec if mrec
+        end
+        nil
+      end
+
+      def try_to_find_group_length_tag(tag)
+        if (tag.group_length_tag?)
+          return DataElementRecord.new(
+                   SourceData::DetachedData.make_group_length_data(tag))
+        end
+      end
+
+      def try_to_find_private_creator_tag(tag)
+        if ( tag.private_creator_tag? )
+          return DataElementRecord.new(
+                   SourceData::DetachedData.make_private_creator_data(tag))
+        end
+      end
+
+      def try_to_find_unknown_tag(tag)
+        DataElementRecord.new(
+          SourceData::DetachedData.make_unknown_data(tag))
+      end
+
+    end
+
+    TheDataElementDictionary = DataElementDictionary.new.freeze
+
+  end
+end

data/lib/dcm_dict/dictionary/data_element_record.rb

@@ -0,0 +1,93 @@
+#
+#  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
+    DataElementMethodMap = { :tag_multiple? => :tag_multiple,
+                             :tag_name => :tag_name,
+                             :tag_keyword => :tag_key,
+                             :tag_vr => :tag_vr,
+                             :tag_vm => :tag_vm,
+                             :tag_note => :tag_note,
+                             :tag => :tag_ary,
+                             :tag_ary => :tag_ary,
+                             :tag_ps => :tag_ps,
+                             :tag_sym => :tag_sym,
+                             :tag_ndm => :tag_ndm,
+                             :tag_str => :tag_str }.freeze
+
+    DataElementMethod = DataElementMethodMap.flatten.
+                        concat([:tag_group, :tag_element]).uniq.freeze
+
+    # Class to handle data element record from source dictionary data
+    class DataElementRecord < BaseRecord
+      using DcmDict::Refine::Internal::StringRefineInternal
+      using DcmDict::Refine::Internal::ArrayRefineInternal
+
+      def initialize(data)
+        super
+      end
+
+      # Group of tag
+      def tag_group
+        record_data[:tag_ary].tag_group_num
+      end
+
+      # Element of tag
+      def tag_element
+        record_data[:tag_ary].tag_element_num
+      end
+
+      # Extract data from 'multiple tag' record using +tag+
+      def extract_multiple_tag_record(tag)
+        if ( record_data[:tag_multiple] && match_tag?(tag) )
+          DataElementRecord.new( record_data.merge( { tag_str: tag.to_tag_str,
+                                                      tag_ndm: tag.to_tag_ndm,
+                                                      tag_ary: tag.to_tag_ary } ))
+        end
+      end
+
+      private
+      def method_map
+        DataElementMethodMap
+      end
+
+      def match_tag?(tag)
+        tag_to_match = tag.to_tag_str
+        tag_pattern.each do |pattern|
+          re = Regexp.new(pattern)
+          return true if re.match(tag_to_match)
+        end
+        false
+      end
+
+      def tag_pattern
+        gs, es = self.tag_ps.gsub(/[\(|\)]/, '').gsub(/[xX]/,"[0-9A-Fa-f]").split(',')
+        ["^\\(#{gs}\\,#{es}\\)$", "^#{gs}#{es}$" ]
+      end
+
+    end
+  end
+end

data/lib/dcm_dict/dictionary/uid_dictionary.rb

@@ -0,0 +1,82 @@
+#
+#  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_dictionary'
+
+module DcmDict
+  module Dictionary
+    using DcmDict::Refine::Internal::StringRefineInternal
+
+    UidIndexKey = [:uid_value, :uid_name]
+
+    # Main class to handle uid data as dictionary
+    class UidDictionary < BaseDictionary
+
+      def initialize
+        super
+      end
+
+      private
+      def map_source_data
+        @uid_dict={}
+        SourceData::UidValuesData.each do |data|
+          record = UidRecord.new(data).freeze
+          UidIndexKey.each { |key| @uid_dict[data[key]] = record }
+        end
+      end
+
+      def freeze_source_data
+        @uid_dict.freeze
+      end
+
+      def atomic_feature_at(uid, key)
+        try_to_find_feature(uid, key)
+      rescue Exception => ex
+        raise DictionaryError.new("Unable to find feature #{key.inspect} for uid '#{uid}' as #{uid.class} (#{ex.class}: #{ex.message.inspect})")
+      end
+
+      def try_to_find_feature(uid, key)
+        atomic_record_at(uid).send(key)
+      end
+
+      def atomic_record_at(uid)
+        try_to_find_uid(uid)
+      rescue Exception => ex
+        raise DictionaryError.new("Unable to find reference for uid '#{uid}' as #{uid.class} (#{ex.class}: #{ex.message.inspect})")
+      end
+
+      def try_to_find_uid(uid)
+        @uid_dict[uid] ||
+          try_to_find_unknown_uid(uid)
+      end
+
+      def try_to_find_unknown_uid(uid)
+        raise "Unknown UID value" unless uid.uid_value?
+        UidRecord.new({ uid_value: uid,
+                        uid_name: 'Unknown UID',
+                        uid_type: :unknown })
+      end
+    end
+
+    TheUidDictionary = UidDictionary.new.freeze
+
+  end
+end