Class: Fleximage::Operator::UnsharpMask

Inherits:
Base
  • Object
show all
Defined in:
lib/fleximage/operator/unsharp_mask.rb

Overview

Sharpen an image using an unsharp mask filter.

image.unsharp_mask(options = {})

Use the following keys in the options hash:

  • radius: The radius of the Gaussian operator. The default is 0.0.

  • sigma: The standard deviation of the Gaussian operator. A good starting value is 1.0, which is the default.

  • amount: The percentage of the blurred image to be added to the receiver, specified as a fraction between 0 and 1.0. A good starting value is 1.0, which is the default.

  • threshold: The threshold needed to apply the amount, specified as a fraction between 0 and 1.0. A good starting value is 0.05, which is the default.

Example:

@photo.operate do |image|
  image.unsharp_mask
end

Instance Method Summary collapse

Methods inherited from Base

#color, color, #execute, #initialize, #scale, #scale_and_crop, size_to_xy, #size_to_xy, #stretch, #symbol_to_blending_mode, #symbol_to_gravity

Constructor Details

This class inherits a constructor from Fleximage::Operator::Base

Instance Method Details

#operate(options = {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/fleximage/operator/unsharp_mask.rb', line 21

def operate(options = {})
  options = options.symbolize_keys if options.respond_to?(:symbolize_keys)
  options = {
    :radius    => 0.0,
    :sigma     => 1.0,
    :amount    => 1.0,
    :threshold => 0.05
  }.merge(options)

  # sharpen image
  @image = @image.unsharp_mask(options[:radius], options[:sigma], options[:amount], options[:threshold])
end