Class: MiniMagick::Image
- Inherits:
-
Object
- Object
- MiniMagick::Image
- Defined in:
- lib/mini_magick/image.rb,
lib/mini_magick/image/info.rb
Defined Under Namespace
Classes: Info
Instance Attribute Summary collapse
- #colorspace ⇒ String readonly
-
#data ⇒ Hash
readonly
Returns the information from ‘identify -verbose` in a Hash format, for ImageMagick.
-
#details ⇒ Hash
readonly
Returns the information from ‘identify -verbose` in a Hash format, for GraphicsMagick.
- #dimensions ⇒ Array<Integer> readonly
- #exif ⇒ Hash readonly
- #height ⇒ Integer readonly
-
#human_size ⇒ String
readonly
Returns the file size in a human readable format.
- #mime_type ⇒ String readonly
-
#path ⇒ String
readonly
The location of the current working file.
-
#resolution ⇒ Array<Integer>
readonly
Returns the resolution of the photo.
-
#signature ⇒ String
readonly
Returns the message digest of this image as a SHA-256, hexidecimal encoded string.
-
#size ⇒ Integer
readonly
Returns the file size of the image (in bytes).
-
#tempfile ⇒ Tempfile
readonly
The underlying temporary file.
-
#type ⇒ String
readonly
Returns the image format (e.g. “JPEG”, “GIF”).
- #width ⇒ Integer readonly
Class Method Summary collapse
- .attribute(name, key = name.to_s) ⇒ Object
-
.create(ext = nil, validate = MiniMagick.validate_on_create) {|Tempfile| ... } ⇒ MiniMagick::Image
Used to create a new Image object data-copy.
-
.import_pixels(blob, columns, rows, depth, map, format = 'png') ⇒ MiniMagick::Image
Creates an image object from a binary string blob which contains raw pixel data (i.e. no header data).
-
.open(path_or_url, ext = nil, options = {}) ⇒ MiniMagick::Image
Opens a specific image file either on the local file system or at a URI.
-
.read(stream, ext = nil) ⇒ MiniMagick::Image
This is the primary loading method used by all of the other class methods.
Instance Method Summary collapse
- #==(other) ⇒ Object (also: #eql?)
-
#[](value) ⇒ String
(also: #info)
Use this method if you want to access raw Identify’s format API.
-
#collapse!(frame = 0) ⇒ self
Collapse images with sequences to the first frame (i.e. animated gifs) and preserve quality.
-
#combine_options {|MiniMagick::Tool::Mogrify| ... } ⇒ self
You can use multiple commands together using this method.
- #composite(other_image, output_extension = type.downcase, mask = nil) ⇒ Object
-
#destroy! ⇒ Object
Destroys the tempfile (created by Image.open) if it exists.
-
#format(format, page = 0, read_opts = {}) {|MiniMagick::Tool::Convert| ... } ⇒ self
This is used to change the format of the image.
-
#get_pixels ⇒ Array
Returns a matrix of pixels from the image.
- #hash ⇒ Object
-
#identify {|MiniMagick::Tool::Identify| ... } ⇒ String
Runs ‘identify` on itself.
-
#initialize(input_path, tempfile = nil) {|MiniMagick::Tool::Mogrify| ... } ⇒ Image
constructor
Create a new Image object.
- #layer? ⇒ Boolean
-
#layers ⇒ Array<MiniMagick::Image>
(also: #pages, #frames)
Returns layers of the image.
-
#method_missing(name, *args) ⇒ self
If an unknown method is called then it is sent through the mogrify program.
- #mogrify(page = nil) ⇒ Object
- #respond_to_missing?(method_name, include_private = false) ⇒ Boolean
- #run_command(tool_name, *args) ⇒ Object
-
#to_blob ⇒ String
Returns raw image data.
-
#valid? ⇒ Boolean
Checks to make sure that MiniMagick can read the file and understand it.
-
#validate! ⇒ Object
Runs ‘identify` on the current image, and raises an error if it doesn’t pass.
-
#write(output_to) ⇒ Object
Writes the temporary file out to either a file location (by passing in a String) or by passing in a Stream that you can #write(chunk) to repeatedly.
Constructor Details
#initialize(input_path, tempfile = nil) {|MiniMagick::Tool::Mogrify| ... } ⇒ Image
Create a new MiniMagick::Image object.
DANGER: The file location passed in here is the *working copy*. That is, it gets modified. You can either copy it yourself or use open which creates a temporary file for you and protects your original.
166 167 168 169 170 171 172 |
# File 'lib/mini_magick/image.rb', line 166 def initialize(input_path, tempfile = nil, &block) @path = input_path.to_s @tempfile = tempfile @info = MiniMagick::Image::Info.new(@path) (&block) if block end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args) ⇒ self
If an unknown method is called then it is sent through the mogrify program.
463 464 465 466 467 |
# File 'lib/mini_magick/image.rb', line 463 def method_missing(name, *args) mogrify do |builder| builder.send(name, *args) end end |
Instance Attribute Details
#colorspace ⇒ String (readonly)
257 |
# File 'lib/mini_magick/image.rb', line 257 attribute :colorspace |
#data ⇒ Hash (readonly)
Returns the information from ‘identify -verbose` in a Hash format, for ImageMagick.
289 |
# File 'lib/mini_magick/image.rb', line 289 attribute :data |
#details ⇒ Hash (readonly)
Returns the information from ‘identify -verbose` in a Hash format, for GraphicsMagick.
295 |
# File 'lib/mini_magick/image.rb', line 295 attribute :details |
#dimensions ⇒ Array<Integer> (readonly)
241 |
# File 'lib/mini_magick/image.rb', line 241 attribute :dimensions |
#exif ⇒ Hash (readonly)
261 |
# File 'lib/mini_magick/image.rb', line 261 attribute :exif |
#height ⇒ Integer (readonly)
237 |
# File 'lib/mini_magick/image.rb', line 237 attribute :height |
#human_size ⇒ String (readonly)
Returns the file size in a human readable format.
253 |
# File 'lib/mini_magick/image.rb', line 253 attribute :human_size |
#mime_type ⇒ String (readonly)
229 |
# File 'lib/mini_magick/image.rb', line 229 attribute :mime_type |
#path ⇒ String (readonly)
Returns The location of the current working file.
149 150 151 |
# File 'lib/mini_magick/image.rb', line 149 def path @path end |
#resolution ⇒ Array<Integer> (readonly)
Returns the resolution of the photo. You can optionally specify the units measurement.
271 |
# File 'lib/mini_magick/image.rb', line 271 attribute :resolution |
#signature ⇒ String (readonly)
Returns the message digest of this image as a SHA-256, hexidecimal encoded string. This signature uniquely identifies the image and is convenient for determining if an image has been modified or whether two images are identical.
283 |
# File 'lib/mini_magick/image.rb', line 283 attribute :signature |
#size ⇒ Integer (readonly)
Returns the file size of the image (in bytes).
247 |
# File 'lib/mini_magick/image.rb', line 247 attribute :size |
#tempfile ⇒ Tempfile (readonly)
Returns The underlying temporary file.
153 154 155 |
# File 'lib/mini_magick/image.rb', line 153 def tempfile @tempfile end |
#type ⇒ String (readonly)
Returns the image format (e.g. “JPEG”, “GIF”).
225 |
# File 'lib/mini_magick/image.rb', line 225 attribute :type, "format" |
#width ⇒ Integer (readonly)
233 |
# File 'lib/mini_magick/image.rb', line 233 attribute :width |
Class Method Details
.attribute(name, key = name.to_s) ⇒ Object
136 137 138 139 140 141 142 143 144 |
# File 'lib/mini_magick/image.rb', line 136 def self.attribute(name, key = name.to_s) define_method(name) do |*args| if args.any? && name != :resolution mogrify { |b| b.send(name, *args) } else @info[key, *args] end end end |
.create(ext = nil, validate = MiniMagick.validate_on_create) {|Tempfile| ... } ⇒ MiniMagick::Image
123 124 125 126 127 128 129 |
# File 'lib/mini_magick/image.rb', line 123 def self.create(ext = nil, validate = MiniMagick.validate_on_create, &block) tempfile = MiniMagick::Utilities.tempfile(ext.to_s.downcase, &block) new(tempfile.path, tempfile).tap do |image| image.validate! if validate end end |
.import_pixels(blob, columns, rows, depth, map, format = 'png') ⇒ MiniMagick::Image
Creates an image object from a binary string blob which contains raw pixel data (i.e. no header data).
Defaults to ‘png’.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/mini_magick/image.rb', line 52 def self.import_pixels(blob, columns, rows, depth, map, format = 'png') # Create an image object with the raw pixel data string: create(".dat", false) { |f| f.write(blob) }.tap do |image| output_path = image.path.sub(/\.\w+$/, ".#{format}") # Use ImageMagick to convert the raw data file to an image file of the # desired format: MiniMagick::Tool::Convert.new do |convert| convert.size "#{columns}x#{rows}" convert.depth depth convert << "#{map}:#{image.path}" convert << output_path end image.path.replace output_path end end |
.open(path_or_url, ext = nil, options = {}) ⇒ MiniMagick::Image
Opens a specific image file either on the local file system or at a URI. Use this if you don’t want to overwrite the image file.
Extension is either guessed from the path or you can specify it as a second parameter.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/mini_magick/image.rb', line 82 def self.open(path_or_url, ext = nil, = {}) , ext = ext, nil if ext.is_a?(Hash) # Don't use Kernel#open, but reuse its logic openable = if path_or_url.respond_to?(:open) path_or_url elsif path_or_url.respond_to?(:to_str) && %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} =~ path_or_url && (uri = URI.parse(path_or_url)).respond_to?(:open) uri else = { binmode: true }.merge() Pathname(path_or_url) end if openable.is_a?(URI::Generic) ext ||= File.extname(openable.path) else ext ||= File.extname(openable.to_s) end ext.sub!(/:.*/, '') # hack for filenames or URLs that include a colon openable.open() { |file| read(file, ext) } end |
.read(stream, ext = nil) ⇒ MiniMagick::Image
This is the primary loading method used by all of the other class methods.
Use this to pass in a stream object. Must respond to #read(size) or be a binary string object (BLOBBBB)
Probably easier to use the open method if you want to open a file or a URL.
29 30 31 32 33 34 35 |
# File 'lib/mini_magick/image.rb', line 29 def self.read(stream, ext = nil) if stream.is_a?(String) stream = StringIO.new(stream) end create(ext) { |file| IO.copy_stream(stream, file) } end |
Instance Method Details
#==(other) ⇒ Object Also known as: eql?
174 175 176 |
# File 'lib/mini_magick/image.rb', line 174 def ==(other) self.class == other.class && signature == other.signature end |
#[](value) ⇒ String Also known as: info
Use this method if you want to access raw Identify’s format API.
308 309 310 |
# File 'lib/mini_magick/image.rb', line 308 def [](value) @info[value.to_s] end |
#collapse!(frame = 0) ⇒ self
Collapse images with sequences to the first frame (i.e. animated gifs) and preserve quality.
530 531 532 |
# File 'lib/mini_magick/image.rb', line 530 def collapse!(frame = 0) mogrify(frame) { |builder| builder.quality(100) } end |
#combine_options {|MiniMagick::Tool::Mogrify| ... } ⇒ self
You can use multiple commands together using this method. Very easy to use!
452 453 454 |
# File 'lib/mini_magick/image.rb', line 452 def (&block) mogrify(&block) end |
#composite(other_image, output_extension = type.downcase, mask = nil) ⇒ Object
509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'lib/mini_magick/image.rb', line 509 def composite(other_image, output_extension = type.downcase, mask = nil) output_tempfile = MiniMagick::Utilities.tempfile(".#{output_extension}") MiniMagick::Tool::Composite.new do |composite| yield composite if block_given? composite << other_image.path composite << path composite << mask.path if mask composite << output_tempfile.path end Image.new(output_tempfile.path, output_tempfile) end |
#destroy! ⇒ Object
Destroys the tempfile (created by open) if it exists.
537 538 539 540 541 542 |
# File 'lib/mini_magick/image.rb', line 537 def destroy! if @tempfile FileUtils.rm_f @tempfile.path.sub(/mpc$/, "cache") if @tempfile.path.end_with?(".mpc") @tempfile.unlink end end |
#format(format, page = 0, read_opts = {}) {|MiniMagick::Tool::Convert| ... } ⇒ self
This is used to change the format of the image. That is, from “tiff to jpg” or something like that. Once you run it, the instance is pointing to a new file with a new extension!
DANGER: This renames the file that the instance is pointing to. So, if you manually opened the file with Image.new(file_path)… Then that file is DELETED! If you used Image.open(file) then you are OK. The original file will still be there. But, any changes to it might not be…
Formatting an animation into a non-animated type will result in ImageMagick creating multiple pages (starting with 0). You can choose which page you want to manipulate. We default to the first page.
If you would like to convert between animated formats, pass nil as your page and ImageMagick will copy all of the pages.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/mini_magick/image.rb', line 404 def format(format, page = 0, read_opts={}) if @tempfile new_tempfile = MiniMagick::Utilities.tempfile(".#{format}") new_path = new_tempfile.path else new_path = Pathname(path).sub_ext(".#{format}").to_s end input_path = path.dup input_path << "[#{page}]" if page && !layer? MiniMagick::Tool::Convert.new do |convert| read_opts.each do |opt, val| convert.send(opt.to_s, val) end convert << input_path yield convert if block_given? convert << new_path end if @tempfile destroy! @tempfile = new_tempfile else File.delete(path) unless path == new_path || layer? end path.replace new_path @info.clear self end |
#get_pixels ⇒ Array
Returns a matrix of pixels from the image. The matrix is constructed as an array (1) of arrays (2) of arrays (3) of unsigned integers:
1) one for each row of pixels 2) one for each column of pixels 3) three elements in the range 0-255, one for each of the RGB color channels
It can also be called after applying transformations:
In this example, all pixels in pix should now have equal R, G, and B values.
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/mini_magick/image.rb', line 357 def get_pixels convert = MiniMagick::Tool::Convert.new convert << path convert.depth(8) convert << "RGB:-" # Do not use `convert.call` here. We need the whole binary (unstripped) output here. shell = MiniMagick::Shell.new output, * = shell.run(convert.command) pixels_array = output.unpack("C*") pixels = pixels_array.each_slice(3).each_slice(width).to_a # deallocate large intermediary objects output.clear pixels_array.clear pixels end |
#hash ⇒ Object
179 180 181 |
# File 'lib/mini_magick/image.rb', line 179 def hash signature.hash end |
#identify {|MiniMagick::Tool::Identify| ... } ⇒ String
Runs ‘identify` on itself. Accepts an optional block for adding more options to `identify`.
556 557 558 559 560 561 |
# File 'lib/mini_magick/image.rb', line 556 def identify MiniMagick::Tool::Identify.new do |builder| yield builder if block_given? builder << path end end |
#layer? ⇒ Boolean
583 584 585 |
# File 'lib/mini_magick/image.rb', line 583 def layer? path =~ /\[\d+\]$/ end |
#layers ⇒ Array<MiniMagick::Image> Also known as: pages, frames
Returns layers of the image. For example, JPEGs are 1-layered, but formats like PSDs, GIFs and PDFs can have multiple layers/frames/pages.
324 325 326 327 328 329 |
# File 'lib/mini_magick/image.rb', line 324 def layers layers_count = identify.lines.count layers_count.times.map do |idx| MiniMagick::Image.new("#{path}[#{idx}]") end end |
#mogrify(page = nil) ⇒ Object
572 573 574 575 576 577 578 579 580 581 |
# File 'lib/mini_magick/image.rb', line 572 def mogrify(page = nil) MiniMagick::Tool::MogrifyRestricted.new do |builder| yield builder if block_given? builder << (page ? "#{path}[#{page}]" : path) end @info.clear self end |
#respond_to_missing?(method_name, include_private = false) ⇒ Boolean
469 470 471 |
# File 'lib/mini_magick/image.rb', line 469 def respond_to_missing?(method_name, include_private = false) MiniMagick::Tool::Mogrify.option_methods.include?(method_name.to_s) end |
#run_command(tool_name, *args) ⇒ Object
564 565 566 567 568 569 570 |
# File 'lib/mini_magick/image.rb', line 564 def run_command(tool_name, *args) MiniMagick::Tool.const_get(tool_name.capitalize).new do |builder| args.each do |arg| builder << arg end end end |
#to_blob ⇒ String
Returns raw image data.
188 189 190 |
# File 'lib/mini_magick/image.rb', line 188 def to_blob File.binread(path) end |
#valid? ⇒ Boolean
Checks to make sure that MiniMagick can read the file and understand it.
This uses the ‘identify’ command line utility to check the file. If you are having issues with this, then please work directly with the ‘identify’ command and see if you can figure out what the issue is.
201 202 203 204 205 206 |
# File 'lib/mini_magick/image.rb', line 201 def valid? validate! true rescue MiniMagick::Invalid false end |
#validate! ⇒ Object
Runs ‘identify` on the current image, and raises an error if it doesn’t pass.
214 215 216 217 218 |
# File 'lib/mini_magick/image.rb', line 214 def validate! identify rescue MiniMagick::Error => error raise MiniMagick::Invalid, error. end |
#write(output_to) ⇒ Object
Writes the temporary file out to either a file location (by passing in a String) or by passing in a Stream that you can #write(chunk) to repeatedly
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/mini_magick/image.rb', line 481 def write(output_to) case output_to when String, Pathname if layer? MiniMagick::Tool::Convert.new do |builder| builder << path builder << output_to end else FileUtils.copy_file path, output_to unless path == output_to.to_s end else IO.copy_stream File.open(path, "rb"), output_to end end |