dicom 0.9.3 → 0.9.4

data/lib/dicom/uid.rb

@@ -0,0 +1,82 @@
+module DICOM
+
+  # This class handles the various UID types (transfer syntax, SOP Class, LDAP OID, etc)
+  # found in the DICOM Data Dictionary (Annex A: Registry of DICOM unique identifiers,
+  # Table A-1).
+  #
+  class UID
+
+    # The UID name, e.g. 'Verification SOP Class'.
+    attr_reader :name
+    # The UID's retired status string, i.e. an empty string or 'R'.
+    attr_reader :retired
+    # The UID type, e.g. 'SOP Class'.
+    attr_reader :type
+    # The UID value, e.g. '1.2.840.10008.1.1'.
+    attr_reader :value
+
+    # Creates a new UID.
+    #
+    # @param [String] value the UID's value
+    # @param [String] name the UID's name
+    # @param [String] type the UID's type
+    # @param [String] retired the UID's retired status string
+    #
+    def initialize(value, name, type, retired)
+      @value = value
+      @name = name
+      @type = type
+      @retired = retired
+    end
+
+    # Checks if the UID is a Transfer Syntax that big endian byte order.
+    #
+    # @return [Boolean] true if the UID indicates big endian byte order, and false if not
+    #
+    def big_endian?
+      @value == EXPLICIT_BIG_ENDIAN ? true : false
+    end
+
+    # Checks if the UID is a Transfer Syntax that implies compressed pixel data.
+    #
+    # @return [Boolean] true if the UID indicates compressed pixel data, and false if not
+    #
+    def compressed_pixels?
+      transfer_syntax? ? (@name =~ /Implicit|Explicit/).nil? : false
+    end
+
+    # Checks if the UID is a Transfer Syntax that implies explicit encoding.
+    #
+    # @return [Boolean] true if the UID indicates explicit encoding, and false if not
+    #
+    def explicit?
+      transfer_syntax? ? (@name =~ /Implicit/).nil? : false
+    end
+
+    # Converts the retired status string to a boolean.
+    #
+    # @return [Boolean] true if the UID is retired, and false if not
+    #
+    def retired?
+      @retired =~ /R/ ? true : false
+    end
+
+    # Checks if the UID is a SOP Class.
+    #
+    # @return [Boolean] true if the UID is of type SOP Class, and false if not
+    #
+    def sop_class?
+      @type =~ /SOP Class/ ? true : false
+    end
+
+    # Checks if the UID is a Transfer Syntax.
+    #
+    # @return [Boolean] true if the UID is of type Transfer Syntax, and false if not
+    #
+    def transfer_syntax?
+      @type =~ /Transfer Syntax/ ? true : false
+    end
+
+  end
+
+end

data/lib/dicom/variables.rb

@@ -17,17 +17,17 @@ module DICOM
     # Module methods:
     #++
 
-    # Generates a random (unique) UID string.
+    # Generates a unique identifier string.
     # The UID is composed of a DICOM root UID, a type prefix,
     # a datetime part and a random number part.
-    # Returns the UID string.
     #
-    # === Parameters
+    # @param [String] root the DICOM root UID to be used for generating the UID string
+    # @param [String] prefix an integer string which is placed between the dicom root and the time/random part of the UID
+    # @return [String] the generated unique identifier
+    # @example Create a random UID with specified root and prefix
+    #   uid = DICOM.generate_uid('1.2.840.999', '5')
     #
-    # * <tt>root</tt> -- String. The DICOM root UID to be used for generating the UID string, e.g. '1.2.840.999'.
-    # * <tt>prefix</tt> -- String. An integer string which is placed between the dicom root and the time/random part of the UID.
-    #
-    def generate_uid(root=UID, prefix=1)
+    def generate_uid(root=UID_ROOT, prefix=1)
       # NB! For UIDs, leading zeroes immediately after a dot is not allowed.
       date = Time.now.strftime("%Y%m%d").to_i.to_s
       time = Time.now.strftime("%H%M%S").to_i.to_s
@@ -36,7 +36,7 @@ module DICOM
       return uid
     end
 
-    # Use tags as key. Example: "0010,0010"
+    # Use tags as key. Example: '0010,0010'
     #
     def key_use_tags
       @key_representation = :tag
@@ -65,6 +65,6 @@ module DICOM
   # The default key representation.
   self.key_representation = :name
   # The default source application entity title.
-  self.source_app_title = "RUBY_DICOM"
+  self.source_app_title = 'RUBY_DICOM'
 
 end

data/lib/dicom/version.rb

@@ -1,6 +1,6 @@
-module DICOM
-
-  # The ruby-dicom version string.
-  VERSION = "0.9.3"
-
+module DICOM
+
+  # The ruby-dicom version string.
+  VERSION = '0.9.4'
+
 end

data/rakefile.rb

@@ -0,0 +1,29 @@
+# Available commands:
+# Testing the specification:
+#   bundle exec rake spec
+# Building a gem package from source:
+#   bundle exec rake package
+# Create html documentation files:
+#   bundle exec rake yard
+
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'yard'
+
+# Build gem:
+gem_spec = eval(File.read('dicom.gemspec'))
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.gem_spec = gem_spec
+  pkg.need_tar = true
+end
+
+# RSpec 2:
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+# Build documentation (YARD):
+YARD::Rake::YardocTask.new do |t|
+  t.options += ['--title', "ruby-dicom #{DICOM::VERSION} Documentation"]
+end

metadata

@@ -1,114 +1,166 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dicom
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.9.4
   prerelease: 
-  version: 0.9.3
 platform: ruby
-authors: 
+authors:
 - Christoffer Lervag
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.10.5
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: narray
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+- !ruby/object:Gem::Dependency
+  name: narray
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.6.0.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rmagick
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
   name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
   type: :development
-  version_requirements: *id007
-description: DICOM is a standard widely used throughout the world to store and transfer medical image data. This library enables efficient and powerful handling of DICOM in Ruby, to the benefit of any student or professional who would like to use their favorite language to process DICOM files and communicate across the network.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: DICOM is a standard widely used throughout the world to store and transfer
+  medical image data. This library enables efficient and powerful handling of DICOM
+  in Ruby, to the benefit of any student or professional who would like to use their
+  favorite language to process DICOM files and communicate across the network.
 email: chris.lervag@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/dicom/anonymizer.rb
 - lib/dicom/audit_trail.rb
 - lib/dicom/constants.rb
+- lib/dicom/deprecated.rb
+- lib/dicom/dictionary/elements.txt
+- lib/dicom/dictionary/uids.txt
+- lib/dicom/dictionary_element.rb
 - lib/dicom/d_client.rb
 - lib/dicom/d_library.rb
 - lib/dicom/d_object.rb
 - lib/dicom/d_read.rb
 - lib/dicom/d_server.rb
 - lib/dicom/d_write.rb
-- lib/dicom/deprecated.rb
-- lib/dicom/dictionary.rb
 - lib/dicom/element.rb
 - lib/dicom/elemental.rb
 - lib/dicom/file_handler.rb
@@ -123,38 +175,40 @@ files:
 - lib/dicom/ruby_extensions.rb
 - lib/dicom/sequence.rb
 - lib/dicom/stream.rb
+- lib/dicom/uid.rb
 - lib/dicom/variables.rb
 - lib/dicom/version.rb
 - lib/dicom.rb
 - CHANGELOG.rdoc
 - COPYING
+- dicom.gemspec
+- Gemfile
+- rakefile.rb
 - README.rdoc
 homepage: http://dicom.rubyforge.org/
-licenses: 
+licenses:
 - GPLv3
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.6
 requirements: []
-
 rubyforge_project: dicom
-rubygems_version: 1.8.13
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Library for handling DICOM files and DICOM network communication.
 test_files: []
-
+has_rdoc: