dicom 0.9.6 → 0.9.7

data/lib/dicom/image_processor.rb

@@ -1,80 +1,80 @@
-module DICOM
-
-  # This module is the general interface between the ImageItem class and the
-  # image methods found in the specific image processor modules.
-  #
-  module ImageProcessor
-
-    # Creates image objects from one or more compressed, binary string blobs.
-    #
-    # @param [Array<String>, String] blobs binary string blob(s) containing compressed pixel data
-    # @return [Array<MagickImage>, FalseClass] - an array of images, or false (if decompression failed)
-    #
-    def decompress(blobs)
-      raise ArgumentError, "Expected Array or String, got #{blobs.class}." unless [String, Array].include?(blobs.class)
-      blobs = [blobs] unless blobs.is_a?(Array)
-      begin
-        return image_module.decompress(blobs)
-      rescue
-        return false
-      end
-    end
-
-    # Extracts an array of pixels (integers) from an image object.
-    #
-    # @param [MagickImage] image a Magick image object
-    # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-    # @return [Array<Integer>] an array of pixel values
-    #
-    def export_pixels(image, photometry)
-      raise ArgumentError, "Expected String, got #{photometry.class}." unless photometry.is_a?(String)
-      image_module.export_pixels(image, photometry)
-    end
-
-    # Creates an image object from a binary string blob.
-    #
-    # @param [String] blob binary string blob containing pixel data
-    # @param [Integer] columns the number of columns
-    # @param [Integer] rows the number of rows
-    # @param [Integer] depth the bit depth of the encoded pixel data
-    # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-    # @return [MagickImage] a Magick image object
-    #
-    def import_pixels(blob, columns, rows, depth, photometry)
-      raise ArgumentError, "Expected String, got #{blob.class}." unless blob.is_a?(String)
-      image_module.import_pixels(blob, columns, rows, depth, photometry)
-    end
-
-    # Gives an array containing the image objects that are supported by the image processor.
-    #
-    # @return [Array<String>] the valid image classes
-    #
-    def valid_image_objects
-      return ['Magick::Image', 'MiniMagick::Image']
-    end
-
-
-    private
-
-
-    # Gives the specific image processor module corresponding to the specified
-    # image_processor module option.
-    #
-    # @raise [RuntimeError] if an unknown image processor is specified
-    # @return [DcmMiniMagick, DcmRMagick] the image processor module to be used
-    #
-    def image_module
-      case DICOM.image_processor
-      when :mini_magick
-        require 'mini_magick'
-        DcmMiniMagick
-      when :rmagick
-        require 'rmagick'
-        DcmRMagick
-      else
-        raise "Uknown image processor #{DICOM.image_processor}"
-      end
-    end
-
-  end
+module DICOM
+
+  # This module is the general interface between the ImageItem class and the
+  # image methods found in the specific image processor modules.
+  #
+  module ImageProcessor
+
+    # Creates image objects from one or more compressed, binary string blobs.
+    #
+    # @param [Array<String>, String] blobs binary string blob(s) containing compressed pixel data
+    # @return [Array<MagickImage>, FalseClass] - an array of images, or false (if decompression failed)
+    #
+    def decompress(blobs)
+      raise ArgumentError, "Expected Array or String, got #{blobs.class}." unless [String, Array].include?(blobs.class)
+      blobs = [blobs] unless blobs.is_a?(Array)
+      begin
+        return image_module.decompress(blobs)
+      rescue
+        return false
+      end
+    end
+
+    # Extracts an array of pixels (integers) from an image object.
+    #
+    # @param [MagickImage] image a Magick image object
+    # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+    # @return [Array<Integer>] an array of pixel values
+    #
+    def export_pixels(image, photometry)
+      raise ArgumentError, "Expected String, got #{photometry.class}." unless photometry.is_a?(String)
+      image_module.export_pixels(image, photometry)
+    end
+
+    # Creates an image object from a binary string blob.
+    #
+    # @param [String] blob binary string blob containing pixel data
+    # @param [Integer] columns the number of columns
+    # @param [Integer] rows the number of rows
+    # @param [Integer] depth the bit depth of the encoded pixel data
+    # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+    # @return [MagickImage] a Magick image object
+    #
+    def import_pixels(blob, columns, rows, depth, photometry)
+      raise ArgumentError, "Expected String, got #{blob.class}." unless blob.is_a?(String)
+      image_module.import_pixels(blob, columns, rows, depth, photometry)
+    end
+
+    # Gives an array containing the image objects that are supported by the image processor.
+    #
+    # @return [Array<String>] the valid image classes
+    #
+    def valid_image_objects
+      return ['Magick::Image', 'MiniMagick::Image']
+    end
+
+
+    private
+
+
+    # Gives the specific image processor module corresponding to the specified
+    # image_processor module option.
+    #
+    # @raise [RuntimeError] if an unknown image processor is specified
+    # @return [DcmMiniMagick, DcmRMagick] the image processor module to be used
+    #
+    def image_module
+      case DICOM.image_processor
+      when :mini_magick
+        require 'mini_magick'
+        DcmMiniMagick
+      when :rmagick
+        require 'rmagick'
+        DcmRMagick
+      else
+        raise "Uknown image processor #{DICOM.image_processor}"
+      end
+    end
+
+  end
 end

data/lib/dicom/image_processor_mini_magick.rb

@@ -1,72 +1,72 @@
-module DICOM
-  module ImageProcessor
-
-    # This module contains methods for interacting with pixel data using the mini_magick gem.
-    #
-    module DcmMiniMagick
-
-      class << self
-
-        # Creates image objects from an array of compressed, binary string blobs.
-        #
-        # @param [Array<String>] blobs an array of binary string blobs containing compressed pixel data
-        # @return [Array<MiniMagick::Image>, FalseClass] - an array of images, or false (if decompression failed)
-        #
-        def decompress(blobs)
-          images = Array.new
-          # We attempt to decompress the pixels using ImageMagick:
-          blobs.each do |string|
-            images << MiniMagick::Image.read(string)
-          end
-          return images
-        end
-
-        # Extracts an array of pixels (integers) from an image object.
-        #
-        # @note This feature is not available as of yet in the mini_magick image processor.
-        #   If this feature is needed, please try another image processor (RMagick).
-        #
-        # @param [MiniMagick::Image] image a mini_magick image object
-        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-        # @return [Array<Integer>] an array of pixel values
-        #
-        def export_pixels(image, photometry)
-          raise ArgumentError, "Expected MiniMagick::Image, got #{image.class}." unless image.is_a?(MiniMagick::Image)
-          raise "Exporting pixels is not yet available with the mini_magick processor. Please try another image processor (RMagick)."
-        end
-
-        # Creates an image object from a binary string blob.
-        #
-        # @param [String] blob binary string blob containing pixel data
-        # @param [Integer] columns the number of columns
-        # @param [Integer] rows the number of rows
-        # @param [Integer] depth the bit depth of the encoded pixel data
-        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-        # @param [String] format the image format to use
-        # @return [Magick::Image] a mini_magick image object
-        #
-        def import_pixels(blob, columns, rows, depth, photometry, format='png')
-          image = MiniMagick::Image.import_pixels(blob, columns, rows, depth, im_map(photometry), format)
-        end
-
-        # Converts a given DICOM photometry string to a mini_magick pixel map string.
-        #
-        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-        # @return [String] a mini_magick pixel map string
-        #
-        def im_map(photometry)
-          raise ArgumentError, "Expected String, got #{photometry.class}." unless photometry.is_a?(String)
-          if photometry.include?('COLOR') or photometry.include?('RGB')
-            return 'rgb'
-          elsif photometry.include?('YBR')
-            return 'ybr'
-          else
-            return 'gray' # (Assuming monochromeX - greyscale)
-          end
-        end
-
-      end
-
-    end
-  end
+module DICOM
+  module ImageProcessor
+
+    # This module contains methods for interacting with pixel data using the mini_magick gem.
+    #
+    module DcmMiniMagick
+
+      class << self
+
+        # Creates image objects from an array of compressed, binary string blobs.
+        #
+        # @param [Array<String>] blobs an array of binary string blobs containing compressed pixel data
+        # @return [Array<MiniMagick::Image>, FalseClass] - an array of images, or false (if decompression failed)
+        #
+        def decompress(blobs)
+          images = Array.new
+          # We attempt to decompress the pixels using ImageMagick:
+          blobs.each do |string|
+            images << MiniMagick::Image.read(string)
+          end
+          return images
+        end
+
+        # Extracts an array of pixels (integers) from an image object.
+        #
+        # @note This feature is not available as of yet in the mini_magick image processor.
+        #   If this feature is needed, please try another image processor (RMagick).
+        #
+        # @param [MiniMagick::Image] image a mini_magick image object
+        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+        # @return [Array<Integer>] an array of pixel values
+        #
+        def export_pixels(image, photometry)
+          raise ArgumentError, "Expected MiniMagick::Image, got #{image.class}." unless image.is_a?(MiniMagick::Image)
+          raise "Exporting pixels is not yet available with the mini_magick processor. Please try another image processor (RMagick)."
+        end
+
+        # Creates an image object from a binary string blob.
+        #
+        # @param [String] blob binary string blob containing pixel data
+        # @param [Integer] columns the number of columns
+        # @param [Integer] rows the number of rows
+        # @param [Integer] depth the bit depth of the encoded pixel data
+        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+        # @param [String] format the image format to use
+        # @return [Magick::Image] a mini_magick image object
+        #
+        def import_pixels(blob, columns, rows, depth, photometry, format='png')
+          image = MiniMagick::Image.import_pixels(blob, columns, rows, depth, im_map(photometry), format)
+        end
+
+        # Converts a given DICOM photometry string to a mini_magick pixel map string.
+        #
+        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+        # @return [String] a mini_magick pixel map string
+        #
+        def im_map(photometry)
+          raise ArgumentError, "Expected String, got #{photometry.class}." unless photometry.is_a?(String)
+          if photometry.include?('COLOR') or photometry.include?('RGB')
+            return 'rgb'
+          elsif photometry.include?('YBR')
+            return 'ybr'
+          else
+            return 'gray' # (Assuming monochromeX - greyscale)
+          end
+        end
+
+      end
+
+    end
+  end
 end

data/lib/dicom/image_processor_r_magick.rb

@@ -1,107 +1,107 @@
-module DICOM
-  module ImageProcessor
-
-    # This module contains methods for interacting with pixel data using the RMagick gem.
-    #
-    module DcmRMagick
-
-      class << self
-
-        # Creates image objects from an array of compressed, binary string blobs.
-        #
-        # === Note
-        #
-        # The method tries to use RMagick for unpacking, but unortunately, it seems that
-        # ImageMagick is not able to handle most of the compressed image variants used in the DICOM
-        # standard. To get a more robust implementation which is able to handle most types of
-        # compressed DICOM files, something else is needed.
-        #
-        # Probably a good candidate to use is the PVRG-JPEG library, which seems to be able to handle
-        # everything that is jpeg. It exists in the Ubuntu repositories, where it can be installed and
-        # run through terminal. For source code, and some additional information, check out this link:
-        # http://www.panix.com/~eli/jpeg/
-        #
-        # Another idea would be to study how other open source libraries, like GDCM handle these files.
-        #
-        # @param [Array<String>] blobs an array of binary string blobs containing compressed pixel data
-        # @return [Array<Magick::Image>, FalseClass] - an array of images, or false (if decompression failed)
-        #
-        def decompress(blobs)
-          # FIXME:
-          # The following transfer syntaxes have been verified as failing with ImageMagick:
-          # TXS_JPEG_LOSSLESS_NH is not supported by (my) ImageMagick version: "Unsupported JPEG process: SOF type 0xc3"
-          # TXS_JPEG_LOSSLESS_NH_FOP is not supported by (my) ImageMagick version: "Unsupported JPEG process: SOF type 0xc3"
-          # TXS_JPEG_2000_PART1_LOSSLESS is not supported by (my) ImageMagick version: "jpc_dec_decodepkts failed"
-          #
-          images = Array.new
-          # We attempt to decompress the pixels using ImageMagick:
-            blobs.each do |string|
-              images << Magick::Image.from_blob(string).first
-            end
-          return images
-        end
-
-        # Extracts an array of pixels (integers) from an image object.
-        #
-        # @param [Magick::Image] image an RMagick image object
-        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-        # @return [Array<Integer>] an array of pixel values
-        #
-        def export_pixels(image, photometry)
-          raise ArgumentError, "Expected Magick::Image, got #{image.class}." unless image.is_a?(Magick::Image)
-          pixels = image.export_pixels(0, 0, image.columns, image.rows, rm_map(photometry))
-          return pixels
-        end
-
-        # Creates an image object from a binary string blob.
-        #
-        # @param [String] blob binary string blob containing pixel data
-        # @param [Integer] columns the number of columns
-        # @param [Integer] rows the number of rows
-        # @param [Integer] depth the bit depth of the encoded pixel data
-        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-        # @param [String] format the image format to use
-        # @return [Magick::Image] an RMagick image object
-        #
-        def import_pixels(blob, columns, rows, depth, photometry, format='png')
-          image = Magick::Image.new(columns,rows).import_pixels(0, 0, columns, rows, rm_map(photometry), blob, rm_data_type(depth))
-        end
-
-        # Converts a given bit depth to an RMagick StorageType.
-        #
-        # @raise [ArgumentError] if given an unsupported bit depth
-        # @param [Integer] bit_depth the bit depth of the pixel data
-        # @return [Magick::CharPixel, Magick::ShortPixel] the proper storage type
-        #
-        def rm_data_type(bit_depth)
-          return case bit_depth
-          when 8
-            Magick::CharPixel
-          when 16
-            Magick::ShortPixel
-          else
-            raise ArgumentError, "Unsupported bit depth: #{bit_depth}."
-          end
-        end
-
-        # Converts a given DICOM photometry string to an RMagick pixel map string.
-        #
-        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
-        # @return [String] an RMagick pixel map string
-        #
-        def rm_map(photometry)
-          raise ArgumentError, "Expected String, got #{photometry.class}." unless photometry.is_a?(String)
-          if photometry.include?('COLOR') or photometry.include?('RGB')
-            return 'RGB'
-          elsif photometry.include?('YBR')
-            return 'YBR'
-          else
-            return 'I' # (Assuming monochromeX - greyscale)
-          end
-        end
-
-      end
-
-    end
-  end
+module DICOM
+  module ImageProcessor
+
+    # This module contains methods for interacting with pixel data using the RMagick gem.
+    #
+    module DcmRMagick
+
+      class << self
+
+        # Creates image objects from an array of compressed, binary string blobs.
+        #
+        # === Note
+        #
+        # The method tries to use RMagick for unpacking, but unortunately, it seems that
+        # ImageMagick is not able to handle most of the compressed image variants used in the DICOM
+        # standard. To get a more robust implementation which is able to handle most types of
+        # compressed DICOM files, something else is needed.
+        #
+        # Probably a good candidate to use is the PVRG-JPEG library, which seems to be able to handle
+        # everything that is jpeg. It exists in the Ubuntu repositories, where it can be installed and
+        # run through terminal. For source code, and some additional information, check out this link:
+        # http://www.panix.com/~eli/jpeg/
+        #
+        # Another idea would be to study how other open source libraries, like GDCM handle these files.
+        #
+        # @param [Array<String>] blobs an array of binary string blobs containing compressed pixel data
+        # @return [Array<Magick::Image>, FalseClass] - an array of images, or false (if decompression failed)
+        #
+        def decompress(blobs)
+          # FIXME:
+          # The following transfer syntaxes have been verified as failing with ImageMagick:
+          # TXS_JPEG_LOSSLESS_NH is not supported by (my) ImageMagick version: "Unsupported JPEG process: SOF type 0xc3"
+          # TXS_JPEG_LOSSLESS_NH_FOP is not supported by (my) ImageMagick version: "Unsupported JPEG process: SOF type 0xc3"
+          # TXS_JPEG_2000_PART1_LOSSLESS is not supported by (my) ImageMagick version: "jpc_dec_decodepkts failed"
+          #
+          images = Array.new
+          # We attempt to decompress the pixels using ImageMagick:
+            blobs.each do |string|
+              images << Magick::Image.from_blob(string).first
+            end
+          return images
+        end
+
+        # Extracts an array of pixels (integers) from an image object.
+        #
+        # @param [Magick::Image] image an RMagick image object
+        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+        # @return [Array<Integer>] an array of pixel values
+        #
+        def export_pixels(image, photometry)
+          raise ArgumentError, "Expected Magick::Image, got #{image.class}." unless image.is_a?(Magick::Image)
+          pixels = image.export_pixels(0, 0, image.columns, image.rows, rm_map(photometry))
+          return pixels
+        end
+
+        # Creates an image object from a binary string blob.
+        #
+        # @param [String] blob binary string blob containing pixel data
+        # @param [Integer] columns the number of columns
+        # @param [Integer] rows the number of rows
+        # @param [Integer] depth the bit depth of the encoded pixel data
+        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+        # @param [String] format the image format to use
+        # @return [Magick::Image] an RMagick image object
+        #
+        def import_pixels(blob, columns, rows, depth, photometry, format='png')
+          image = Magick::Image.new(columns,rows).import_pixels(0, 0, columns, rows, rm_map(photometry), blob, rm_data_type(depth))
+        end
+
+        # Converts a given bit depth to an RMagick StorageType.
+        #
+        # @raise [ArgumentError] if given an unsupported bit depth
+        # @param [Integer] bit_depth the bit depth of the pixel data
+        # @return [Magick::CharPixel, Magick::ShortPixel] the proper storage type
+        #
+        def rm_data_type(bit_depth)
+          return case bit_depth
+          when 8
+            Magick::CharPixel
+          when 16
+            Magick::ShortPixel
+          else
+            raise ArgumentError, "Unsupported bit depth: #{bit_depth}."
+          end
+        end
+
+        # Converts a given DICOM photometry string to an RMagick pixel map string.
+        #
+        # @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')
+        # @return [String] an RMagick pixel map string
+        #
+        def rm_map(photometry)
+          raise ArgumentError, "Expected String, got #{photometry.class}." unless photometry.is_a?(String)
+          if photometry.include?('COLOR') or photometry.include?('RGB')
+            return 'RGB'
+          elsif photometry.include?('YBR')
+            return 'YBR'
+          else
+            return 'I' # (Assuming monochromeX - greyscale)
+          end
+        end
+
+      end
+
+    end
+  end
 end