lib/vips/methods.rb in ruby-vips-1.0.2 vs lib/vips/methods.rb in ruby-vips-1.0.3
- old
+ new
@@ -6,12 +6,12 @@
# @param cmd_format [String] Command to run
# @param [Hash] opts Set of options
# @option opts [Array<Image>] :in Array of input images
# @option opts [String] :in_format Format for input filename
# @option opts [String] :out_format Format for output filename
-# @option opts [Vips::Image] :out Output -- Output image
-# @option opts [String] :log Output -- Command log
+# @option opts [Vips::Image] :out Output Output image
+# @option opts [String] :log Output Command log
# @return [nil, Hash<Symbol => Object>] Hash of optional output items
# @!method add(right, opts = {})
# Add two images.
# @param right [Vips::Image] Right-hand image argument
@@ -163,26 +163,26 @@
# @!method min(, opts = {})
# Find image minimum.
# @param [Hash] opts Set of options
# @option opts [Integer] :size Number of minimum values to find
-# @option opts [Integer] :x Output -- Horizontal position of minimum
-# @option opts [Integer] :y Output -- Vertical position of minimum
-# @option opts [Array<Double>] :out_array Output -- Array of output values
-# @option opts [Array<Integer>] :x_array Output -- Array of horizontal positions
-# @option opts [Array<Integer>] :y_array Output -- Array of vertical positions
+# @option opts [Integer] :x Output Horizontal position of minimum
+# @option opts [Integer] :y Output Vertical position of minimum
+# @option opts [Array<Double>] :out_array Output Array of output values
+# @option opts [Array<Integer>] :x_array Output Array of horizontal positions
+# @option opts [Array<Integer>] :y_array Output Array of vertical positions
# @return [Float, Hash<Symbol => Object>] Output value, Hash of optional output items
# @!method max(, opts = {})
# Find image maximum.
# @param [Hash] opts Set of options
# @option opts [Integer] :size Number of maximum values to find
-# @option opts [Integer] :x Output -- Horizontal position of maximum
-# @option opts [Integer] :y Output -- Vertical position of maximum
-# @option opts [Array<Double>] :out_array Output -- Array of output values
-# @option opts [Array<Integer>] :x_array Output -- Array of horizontal positions
-# @option opts [Array<Integer>] :y_array Output -- Array of vertical positions
+# @option opts [Integer] :x Output Horizontal position of maximum
+# @option opts [Integer] :y Output Vertical position of maximum
+# @option opts [Array<Double>] :out_array Output Array of output values
+# @option opts [Array<Integer>] :x_array Output Array of horizontal positions
+# @option opts [Array<Integer>] :y_array Output Array of vertical positions
# @return [Float, Hash<Symbol => Object>] Output value, Hash of optional output items
# @!method deviate(, opts = {})
# Find image standard deviation.
# @param [Hash] opts Set of options
@@ -432,11 +432,11 @@
# @return [Vips::Image] Output image
# @!method autorot(, opts = {})
# Autorotate image by exif tag.
# @param [Hash] opts Set of options
-# @option opts [Vips::Angle] :angle Output -- Angle image was rotated by
+# @option opts [Vips::Angle] :angle Output Angle image was rotated by
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method recomb(m, opts = {})
# Linear recombination with matrix.
# @param m [Vips::Image] matrix of coefficients
@@ -552,11 +552,11 @@
# @!method self.text(text, opts = {})
# Make a text image.
# @param text [String] Text to render
# @param [Hash] opts Set of options
-# @option opts [String] :font Font to render width
+# @option opts [String] :font Font to render with
# @option opts [Integer] :width Maximum image width in pixels
# @option opts [Vips::Align] :align Align on the low, centre or high edge
# @option opts [Integer] :dpi DPI to render at
# @option opts [Integer] :spacing Line spacing
# @return [Vips::Image] Output image
@@ -629,26 +629,26 @@
# @param width [Integer] Image width in pixels
# @param height [Integer] Image height in pixels
# @param frequency_cutoff [Float] Frequency cutoff
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
-# @option opts [Boolean] :nodc Remove DC component
-# @option opts [Boolean] :reject Invert the sense of the filter
# @option opts [Boolean] :optical Rotate quadrants to optical space
+# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_ideal_ring(width, height, frequency_cutoff, ringwidth, opts = {})
# Make an ideal ring filter.
# @param width [Integer] Image width in pixels
# @param height [Integer] Image height in pixels
# @param frequency_cutoff [Float] Frequency cutoff
# @param ringwidth [Float] Ringwidth
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
-# @option opts [Boolean] :nodc Remove DC component
-# @option opts [Boolean] :reject Invert the sense of the filter
# @option opts [Boolean] :optical Rotate quadrants to optical space
+# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, opts = {})
# Make an ideal band filter.
# @param width [Integer] Image width in pixels
@@ -657,12 +657,12 @@
# @param frequency_cutoff_y [Float] Frequency cutoff y
# @param radius [Float] radius of circle
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
# @option opts [Boolean] :optical Rotate quadrants to optical space
-# @option opts [Boolean] :nodc Remove DC component
# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, opts = {})
# Make a butterworth filter.
# @param width [Integer] Image width in pixels
@@ -671,12 +671,12 @@
# @param frequency_cutoff [Float] Frequency cutoff
# @param amplitude_cutoff [Float] Amplitude cutoff
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
# @option opts [Boolean] :optical Rotate quadrants to optical space
-# @option opts [Boolean] :nodc Remove DC component
# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {})
# Make a butterworth ring filter.
# @param width [Integer] Image width in pixels
@@ -686,12 +686,12 @@
# @param amplitude_cutoff [Float] Amplitude cutoff
# @param ringwidth [Float] Ringwidth
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
# @option opts [Boolean] :optical Rotate quadrants to optical space
-# @option opts [Boolean] :nodc Remove DC component
# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {})
# Make a butterworth_band filter.
# @param width [Integer] Image width in pixels
@@ -714,13 +714,13 @@
# @param height [Integer] Image height in pixels
# @param frequency_cutoff [Float] Frequency cutoff
# @param amplitude_cutoff [Float] Amplitude cutoff
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
-# @option opts [Boolean] :nodc Remove DC component
-# @option opts [Boolean] :reject Invert the sense of the filter
# @option opts [Boolean] :optical Rotate quadrants to optical space
+# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {})
# Make a gaussian ring filter.
# @param width [Integer] Image width in pixels
@@ -729,12 +729,12 @@
# @param amplitude_cutoff [Float] Amplitude cutoff
# @param ringwidth [Float] Ringwidth
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
# @option opts [Boolean] :optical Rotate quadrants to optical space
-# @option opts [Boolean] :nodc Remove DC component
# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {})
# Make a gaussian filter.
# @param width [Integer] Image width in pixels
@@ -744,24 +744,24 @@
# @param radius [Float] radius of circle
# @param amplitude_cutoff [Float] Amplitude cutoff
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
# @option opts [Boolean] :optical Rotate quadrants to optical space
-# @option opts [Boolean] :nodc Remove DC component
# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method self.mask_fractal(width, height, fractal_dimension, opts = {})
# Make fractal filter.
# @param width [Integer] Image width in pixels
# @param height [Integer] Image height in pixels
# @param fractal_dimension [Float] Fractal dimension
# @param [Hash] opts Set of options
# @option opts [Boolean] :uchar Output an unsigned char image
-# @option opts [Boolean] :nodc Remove DC component
-# @option opts [Boolean] :reject Invert the sense of the filter
# @option opts [Boolean] :optical Rotate quadrants to optical space
+# @option opts [Boolean] :reject Invert the sense of the filter
+# @option opts [Boolean] :nodc Remove DC component
# @return [Vips::Image] Output image
# @!method buildlut(, opts = {})
# Build a look-up table.
# @param [Hash] opts Set of options
@@ -802,27 +802,26 @@
# @param height [Integer] Image height in pixels
# @param fractal_dimension [Float] Fractal dimension
# @param [Hash] opts Set of options
# @return [Vips::Image] Output image
-# @!method self.radload(filename, opts = {})
-# Load a radiance image from a file.
-# @param filename [String] Filename to load from
+# @!method self.worley(width, height, opts = {})
+# Make a worley noise image.
+# @param width [Integer] Image width in pixels
+# @param height [Integer] Image height in pixels
# @param [Hash] opts Set of options
-# @option opts [Boolean] :disc Open to disc
-# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
-# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+# @option opts [Integer] :cell_size Size of Worley cells
+# @return [Vips::Image] Output image
-# @!method self.ppmload(filename, opts = {})
-# Load ppm from file.
-# @param filename [String] Filename to load from
+# @!method self.perlin(width, height, opts = {})
+# Make a perlin noise image.
+# @param width [Integer] Image width in pixels
+# @param height [Integer] Image height in pixels
# @param [Hash] opts Set of options
-# @option opts [Boolean] :disc Open to disc
-# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
-# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+# @option opts [Integer] :cell_size Size of Perlin cells
+# @option opts [Boolean] :uchar Output an unsigned char image
+# @return [Vips::Image] Output image
# @!method self.csvload(filename, opts = {})
# Load csv from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
@@ -830,78 +829,164 @@
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :skip Skip this many lines at the start of the file
# @option opts [Integer] :lines Read this many lines from the file
# @option opts [String] :whitespace Set of whitespace characters
# @option opts [String] :separator Set of separator characters
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.matrixload(filename, opts = {})
# Load matrix from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
-# @!method self.analyzeload(filename, opts = {})
-# Load an analyze6 image.
-# @param filename [String] Filename to load from
-# @param [Hash] opts Set of options
-# @option opts [Boolean] :disc Open to disc
-# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
-# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
-
# @!method self.rawload(filename, width, height, bands, opts = {})
# Load raw data from a file.
# @param filename [String] Filename to load from
# @param width [Integer] Image width in pixels
# @param height [Integer] Image height in pixels
# @param bands [Integer] Number of bands in image
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :offset Offset in bytes from start of file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.vipsload(filename, opts = {})
# Load vips from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+# @!method self.analyzeload(filename, opts = {})
+# Load an analyze6 image.
+# @param filename [String] Filename to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.ppmload(filename, opts = {})
+# Load ppm from file.
+# @param filename [String] Filename to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.radload(filename, opts = {})
+# Load a radiance image from a file.
+# @param filename [String] Filename to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.pdfload(filename, opts = {})
+# Load pdf with libpoppler.
+# @param filename [String] Filename to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Integer] :page Load this page from the file
+# @option opts [Integer] :n Load this many pages
+# @option opts [Float] :dpi Render at this DPI
+# @option opts [Float] :scale Scale output by this factor
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.pdfload_buffer(buffer, opts = {})
+# Load pdf with libpoppler.
+# @param buffer [Vips::Blob] Buffer to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Integer] :page Load this page from the file
+# @option opts [Integer] :n Load this many pages
+# @option opts [Float] :dpi Render at this DPI
+# @option opts [Float] :scale Scale output by this factor
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.svgload(filename, opts = {})
+# Load svg with rsvg.
+# @param filename [String] Filename to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Float] :dpi Render at this DPI
+# @option opts [Float] :scale Scale output by this factor
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.svgload_buffer(buffer, opts = {})
+# Load svg with rsvg.
+# @param buffer [Vips::Blob] Buffer to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Float] :dpi Render at this DPI
+# @option opts [Float] :scale Scale output by this factor
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.gifload(filename, opts = {})
+# Load gif with giflib.
+# @param filename [String] Filename to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Integer] :page Load this page from the file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.gifload_buffer(buffer, opts = {})
+# Load gif with giflib.
+# @param buffer [Vips::Blob] Buffer to load from
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :disc Open to disc
+# @option opts [Vips::Access] :access Required access pattern for this file
+# @option opts [Integer] :page Load this page from the file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
# @!method self.pngload(filename, opts = {})
# Load png from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.pngload_buffer(buffer, opts = {})
# Load png from buffer.
# @param buffer [Vips::Blob] Buffer to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.matload(filename, opts = {})
# Load mat from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.jpegload(filename, opts = {})
# Load jpeg from file.
# @param filename [String] Filename to load from
@@ -909,11 +994,11 @@
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :shrink Shrink factor on load
# @option opts [Boolean] :fail Fail on first warning
# @option opts [Boolean] :autorotate Rotate image using exif orientation
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.jpegload_buffer(buffer, opts = {})
# Load jpeg from buffer.
# @param buffer [Vips::Blob] Buffer to load from
@@ -921,49 +1006,53 @@
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :shrink Shrink factor on load
# @option opts [Boolean] :fail Fail on first warning
# @option opts [Boolean] :autorotate Rotate image using exif orientation
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.webpload(filename, opts = {})
# Load webp from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Integer] :shrink Shrink factor on load
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.webpload_buffer(buffer, opts = {})
# Load webp from buffer.
# @param buffer [Vips::Blob] Buffer to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Integer] :shrink Shrink factor on load
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.tiffload(filename, opts = {})
# Load tiff from file.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :page Load this page from the image
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Boolean] :autorotate Rotate image using orientation tag
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.tiffload_buffer(buffer, opts = {})
# Load tiff from buffer.
# @param buffer [Vips::Blob] Buffer to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :page Load this page from the image
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Boolean] :autorotate Rotate image using orientation tag
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.openslideload(filename, opts = {})
# Load file with openslide.
# @param filename [String] Filename to load from
@@ -971,71 +1060,55 @@
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
# @option opts [Integer] :level Load this level from the file
# @option opts [Boolean] :autocrop Crop to image bounds
# @option opts [String] :associated Load this associated image
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.magickload(filename, opts = {})
# Load file with imagemagick.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :all_frames Read all frames from an image
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
+# @option opts [Integer] :page Load this page from the file
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.magickload_buffer(buffer, opts = {})
# Load buffer with imagemagick.
# @param buffer [Vips::Blob] Buffer to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :all_frames Read all frames from an image
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
+# @option opts [Integer] :page Load this page from the file
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.fitsload(filename, opts = {})
# Load a fits image.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method self.openexrload(filename, opts = {})
# Load an openexr image.
# @param filename [String] Filename to load from
# @param [Hash] opts Set of options
# @option opts [Boolean] :disc Open to disc
# @option opts [Vips::Access] :access Required access pattern for this file
-# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
+# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
-# @!method radsave(filename, opts = {})
-# Save image to radiance file.
-# @param filename [String] Filename to save to
-# @param [Hash] opts Set of options
-# @option opts [Boolean] :strip Strip all metadata from image
-# @option opts [Array<Double>] :background Background value
-# @return [nil]
-
-# @!method ppmsave(filename, opts = {})
-# Save image to ppm file.
-# @param filename [String] Filename to save to
-# @param [Hash] opts Set of options
-# @option opts [Boolean] :ascii save as ascii
-# @option opts [Boolean] :squash save as one bit
-# @option opts [Boolean] :strip Strip all metadata from image
-# @option opts [Array<Double>] :background Background value
-# @return [nil]
-
# @!method csvsave(filename, opts = {})
# Save image to csv file.
# @param filename [String] Filename to save to
# @param [Hash] opts Set of options
# @option opts [String] :separator Separator characters
@@ -1080,23 +1153,49 @@
# @param [Hash] opts Set of options
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [nil]
+# @!method ppmsave(filename, opts = {})
+# Save image to ppm file.
+# @param filename [String] Filename to save to
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :ascii save as ascii
+# @option opts [Boolean] :squash save as one bit
+# @option opts [Boolean] :strip Strip all metadata from image
+# @option opts [Array<Double>] :background Background value
+# @return [nil]
+
+# @!method radsave(filename, opts = {})
+# Save image to radiance file.
+# @param filename [String] Filename to save to
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :strip Strip all metadata from image
+# @option opts [Array<Double>] :background Background value
+# @return [nil]
+
+# @!method radsave_buffer(, opts = {})
+# Save image to radiance buffer.
+# @param [Hash] opts Set of options
+# @option opts [Boolean] :strip Strip all metadata from image
+# @option opts [Array<Double>] :background Background value
+# @return [Vips::Blob] Buffer to save to
+
# @!method dzsave(filename, opts = {})
# Save image to deep zoom format.
# @param filename [String] Filename to save to
# @param [Hash] opts Set of options
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
# @option opts [String] :suffix Filename suffix for tiles
# @option opts [Integer] :overlap Tile overlap in pixels
# @option opts [Integer] :tile_size Tile size in pixels
-# @option opts [Boolean] :centre Center image in tile
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
+# @option opts [Boolean] :centre Center image in tile
# @option opts [Vips::Angle] :angle Rotate image during save
# @option opts [Vips::ForeignDzContainer] :container Pyramid container type
# @option opts [Boolean] :properties Write a properties file to the output directory
+# @option opts [Integer] :compression ZIP deflate compression level
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [nil]
# @!method pngsave(filename, opts = {})
@@ -1132,10 +1231,11 @@
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
# @option opts [Boolean] :no_subsample Disable chroma subsample
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
# @option opts [Boolean] :optimize_scans Split the spectrum of DCT coefficients into separate scans
+# @option opts [Integer] :quant_table Use predefined quantization table with given index
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [nil]
# @!method jpegsave_buffer(, opts = {})
@@ -1147,10 +1247,11 @@
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
# @option opts [Boolean] :no_subsample Disable chroma subsample
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
# @option opts [Boolean] :optimize_scans Split the spectrum of DCT coefficients into separate scans
+# @option opts [Integer] :quant_table Use predefined quantization table with given index
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [Vips::Blob] Buffer to save to
# @!method jpegsave_mime(, opts = {})
@@ -1162,29 +1263,38 @@
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
# @option opts [Boolean] :no_subsample Disable chroma subsample
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
# @option opts [Boolean] :optimize_scans Split the spectrum of DCT coefficients into separate scans
+# @option opts [Integer] :quant_table Use predefined quantization table with given index
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [nil]
# @!method webpsave(filename, opts = {})
# Save image to webp file.
# @param filename [String] Filename to save to
# @param [Hash] opts Set of options
# @option opts [Integer] :Q Q factor
# @option opts [Boolean] :lossless enable lossless compression
+# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
+# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
+# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
+# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [nil]
# @!method webpsave_buffer(, opts = {})
# Save image to webp buffer.
# @param [Hash] opts Set of options
# @option opts [Integer] :Q Q factor
# @option opts [Boolean] :lossless enable lossless compression
+# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
+# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
+# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
+# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
# @option opts [Boolean] :strip Strip all metadata from image
# @option opts [Array<Double>] :background Background value
# @return [Vips::Blob] Buffer to save to
# @!method tiffsave(filename, opts = {})
@@ -1197,12 +1307,12 @@
# @option opts [String] :profile ICC profile to embed
# @option opts [Boolean] :tile Write a tiled tiff
# @option opts [Integer] :tile_width Tile width in pixels
# @option opts [Integer] :tile_height Tile height in pixels
# @option opts [Boolean] :pyramid Write a pyramidal tiff
-# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
# @option opts [Boolean] :squash Squash images down to 1 bit
+# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
# @option opts [Float] :xres Horizontal resolution in pixels/mm
# @option opts [Float] :yres Vertical resolution in pixels/mm
# @option opts [Boolean] :bigtiff Write a bigtiff image
# @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
@@ -1223,36 +1333,51 @@
# @param index [Vips::Image] Index pixels with this
# @param [Hash] opts Set of options
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
# @return [Vips::Image] Output image
-# @!method shrink(xshrink, yshrink, opts = {})
+# @!method shrink(hshrink, vshrink, opts = {})
# Shrink an image.
-# @param xshrink [Float] Horizontal shrink factor
-# @param yshrink [Float] Vertical shrink factor
+# @param hshrink [Float] Horizontal shrink factor
+# @param vshrink [Float] Vertical shrink factor
# @param [Hash] opts Set of options
# @return [Vips::Image] Output image
-# @!method shrinkh(xshrink, opts = {})
+# @!method shrinkh(hshrink, opts = {})
# Shrink an image horizontally.
-# @param xshrink [Integer] Horizontal shrink factor
+# @param hshrink [Integer] Horizontal shrink factor
# @param [Hash] opts Set of options
# @return [Vips::Image] Output image
-# @!method shrinkv(yshrink, opts = {})
+# @!method shrinkv(vshrink, opts = {})
# Shrink an image vertically.
-# @param yshrink [Integer] Vertical shrink factor
+# @param vshrink [Integer] Vertical shrink factor
# @param [Hash] opts Set of options
# @return [Vips::Image] Output image
-# @!method shrink2(xshrink, yshrink, opts = {})
-# Shrink an image.
-# @param xshrink [Float] Horizontal shrink factor
-# @param yshrink [Float] Vertical shrink factor
+# @!method reduceh(hshrink, opts = {})
+# Shrink an image horizontally.
+# @param hshrink [Float] Horizontal shrink factor
# @param [Hash] opts Set of options
+# @option opts [Vips::Kernel] :kernel Resampling kernel
# @return [Vips::Image] Output image
+# @!method reducev(vshrink, opts = {})
+# Shrink an image vertically.
+# @param vshrink [Float] Vertical shrink factor
+# @param [Hash] opts Set of options
+# @option opts [Vips::Kernel] :kernel Resampling kernel
+# @return [Vips::Image] Output image
+
+# @!method reduce(hshrink, vshrink, opts = {})
+# Reduce an image.
+# @param hshrink [Float] Horizontal shrink factor
+# @param vshrink [Float] Vertical shrink factor
+# @param [Hash] opts Set of options
+# @option opts [Vips::Kernel] :kernel Resampling kernel
+# @return [Vips::Image] Output image
+
# @!method quadratic(coeff, opts = {})
# Resample an image with a quadratic transform.
# @param coeff [Vips::Image] Coefficient matrix
# @param [Hash] opts Set of options
# @option opts [Vips::Interpolate] :interpolate Interpolate values with this
@@ -1284,14 +1409,12 @@
# @!method resize(scale, opts = {})
# Resize an image.
# @param scale [Float] Scale image by this factor
# @param [Hash] opts Set of options
-# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
+# @option opts [Vips::Kernel] :kernel Resampling kernel
# @option opts [Float] :vscale Vertical scale image by this factor
-# @option opts [Float] :idx Horizontal input displacement
-# @option opts [Float] :idy Vertical input displacement
# @return [Vips::Image] Output image
# @!method colourspace(space, opts = {})
# Convert to a new colourspace.
# @param space [Vips::Interpretation] Destination colour space
@@ -1407,31 +1530,31 @@
# @return [Vips::Image] Output image
# @!method icc_import(, opts = {})
# Import from device with icc profile.
# @param [Hash] opts Set of options
-# @option opts [Vips::PCS] :pcs Set Profile Connection Space
# @option opts [Vips::Intent] :intent Rendering intent
+# @option opts [Vips::PCS] :pcs Set Profile Connection Space
# @option opts [Boolean] :embedded Use embedded input profile, if available
# @option opts [String] :input_profile Filename to load input profile from
# @return [Vips::Image] Output image
# @!method icc_export(, opts = {})
# Output to device with icc profile.
# @param [Hash] opts Set of options
-# @option opts [Vips::PCS] :pcs Set Profile Connection Space
# @option opts [Vips::Intent] :intent Rendering intent
+# @option opts [Vips::PCS] :pcs Set Profile Connection Space
# @option opts [String] :output_profile Filename to load output profile from
# @option opts [Integer] :depth Output device space depth in bits
# @return [Vips::Image] Output image
# @!method icc_transform(output_profile, opts = {})
# Transform between devices with icc profiles.
# @param output_profile [String] Filename to load output profile from
# @param [Hash] opts Set of options
-# @option opts [Vips::PCS] :pcs Set Profile Connection Space
# @option opts [Vips::Intent] :intent Rendering intent
+# @option opts [Vips::PCS] :pcs Set Profile Connection Space
# @option opts [Boolean] :embedded Use embedded input profile, if available
# @option opts [String] :input_profile Filename to load input profile from
# @option opts [Integer] :depth Output device space depth in bits
# @return [Vips::Image] Output image
@@ -1487,13 +1610,13 @@
# Statistical difference.
# @param width [Integer] Window width in pixels
# @param height [Integer] Window height in pixels
# @param [Hash] opts Set of options
# @option opts [Float] :a Weight of new mean
-# @option opts [Float] :s0 New deviation
-# @option opts [Float] :b Weight of new deviation
# @option opts [Float] :m0 New mean
+# @option opts [Float] :b Weight of new deviation
+# @option opts [Float] :s0 New deviation
# @return [Vips::Image] Output image
# @!method hist_cum(, opts = {})
# Form cumulative histogram.
# @param [Hash] opts Set of options
@@ -1545,10 +1668,30 @@
# @option opts [Vips::Precision] :precision Convolve with this precision
# @option opts [Integer] :layers Use this many layers in approximation
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
# @return [Vips::Image] Output image
+# @!method conva(mask, opts = {})
+# Approximate integer convolution.
+# @param mask [Vips::Image] Input matrix image
+# @param [Hash] opts Set of options
+# @option opts [Integer] :layers Use this many layers in approximation
+# @option opts [Integer] :cluster Cluster lines closer than this in approximation
+# @return [Vips::Image] Output image
+
+# @!method convf(mask, opts = {})
+# Float convolution operation.
+# @param mask [Vips::Image] Input matrix image
+# @param [Hash] opts Set of options
+# @return [Vips::Image] Output image
+
+# @!method convi(mask, opts = {})
+# Int convolution operation.
+# @param mask [Vips::Image] Input matrix image
+# @param [Hash] opts Set of options
+# @return [Vips::Image] Output image
+
# @!method compass(mask, opts = {})
# Convolve with rotating mask.
# @param mask [Vips::Image] Input matrix image
# @param [Hash] opts Set of options
# @option opts [Integer] :times Rotate and convolve this many times
@@ -1566,10 +1709,17 @@
# @option opts [Vips::Precision] :precision Convolve with this precision
# @option opts [Integer] :layers Use this many layers in approximation
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
# @return [Vips::Image] Output image
+# @!method convasep(mask, opts = {})
+# Approximate separable integer convolution.
+# @param mask [Vips::Image] Input matrix image
+# @param [Hash] opts Set of options
+# @option opts [Integer] :layers Use this many layers in approximation
+# @return [Vips::Image] Output image
+
# @!method fastcor(ref, opts = {})
# Fast correlation.
# @param ref [Vips::Image] Input reference image
# @param [Hash] opts Set of options
# @return [Vips::Image] Output image
@@ -1581,11 +1731,11 @@
# @return [Vips::Image] Output image
# @!method sharpen(, opts = {})
# Unsharp masking for print.
# @param [Hash] opts Set of options
-# @option opts [Integer] :radius Mask radius
+# @option opts [Float] :sigma Sigma of Gaussian
# @option opts [Float] :x1 Flat/jaggy threshold
# @option opts [Float] :y2 Maximum brightening
# @option opts [Float] :y3 Maximum darkening
# @option opts [Float] :m1 Slope for flat areas
# @option opts [Float] :m2 Slope for jaggy areas
@@ -1649,11 +1799,11 @@
# @return [Float] Number of lines
# @!method labelregions(, opts = {})
# Label regions in an image.
# @param [Hash] opts Set of options
-# @option opts [Integer] :segments Output -- Number of discrete contigious regions
+# @option opts [Integer] :segments Output Number of discrete contigious regions
# @return [Vips::Image, Hash<Symbol => Object>] Mask of region labels, Hash of optional output items
# @!method draw_rect(ink, left, top, width, height, opts = {})
# Paint a rectangle on an image.
# @param ink [Array<Double>] Colour for pixels
@@ -1700,14 +1850,14 @@
# @param x [Integer] DrawFlood start point
# @param y [Integer] DrawFlood start point
# @param [Hash] opts Set of options
# @option opts [Vips::Image] :test Test pixels in this image
# @option opts [Boolean] :equal DrawFlood while equal to edge
-# @option opts [Integer] :left Output -- Left edge of modified area
-# @option opts [Integer] :top Output -- top edge of modified area
-# @option opts [Integer] :width Output -- width of modified area
-# @option opts [Integer] :height Output -- height of modified area
+# @option opts [Integer] :left Output Left edge of modified area
+# @option opts [Integer] :top Output top edge of modified area
+# @option opts [Integer] :width Output width of modified area
+# @option opts [Integer] :height Output height of modified area
# @return [Vips::Image, Hash<Symbol => Object>] Image to draw on, Hash of optional output items
# @!method draw_image(sub, x, y, opts = {})
# Paint an image into another image.
# @param sub [Vips::Image] Sub-image to insert into main image
@@ -1747,15 +1897,15 @@
# @param [Hash] opts Set of options
# @option opts [Integer] :hwindow Half window size
# @option opts [Integer] :harea Half area size
# @option opts [Integer] :mblend Maximum blend size
# @option opts [Integer] :bandno Band to search for features on
-# @option opts [Integer] :dx0 Output -- Detected integer offset
-# @option opts [Integer] :dy0 Output -- Detected integer offset
-# @option opts [Float] :scale1 Output -- Detected scale
-# @option opts [Float] :angle1 Output -- Detected rotation
-# @option opts [Float] :dx1 Output -- Detected first-order displacement
-# @option opts [Float] :dy1 Output -- Detected first-order displacement
+# @option opts [Integer] :dx0 Output Detected integer offset
+# @option opts [Integer] :dy0 Output Detected integer offset
+# @option opts [Float] :scale1 Output Detected scale
+# @option opts [Float] :angle1 Output Detected rotation
+# @option opts [Float] :dx1 Output Detected first-order displacement
+# @option opts [Float] :dy1 Output Detected first-order displacement
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
# @!method mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {})
# First-order mosaic of two images.
# @param sec [Vips::Image] Secondary image