ruby-vips 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -1
- data/VERSION +1 -1
- data/lib/vips/call.rb +234 -170
- data/lib/vips/image.rb +48 -18
- data/lib/vips/interpolate.rb +2 -2
- data/lib/vips/kernel.rb +22 -0
- data/lib/vips/methods.rb +269 -119
- data/lib/vips/version.rb +1 -1
- data/ruby-vips.gemspec +6 -3
- metadata +9 -9
data/lib/vips/image.rb
CHANGED
@@ -70,7 +70,7 @@
|
|
70
70
|
# {Image.new_from_array} creates an image from an array constant. The 8 at
|
71
71
|
# the end sets the scale: the amount to divide the image by after
|
72
72
|
# integer convolution. See the libvips API docs for `vips_conv()` (the operation
|
73
|
-
# invoked by {
|
73
|
+
# invoked by {Image#conv}) for details on the convolution operator.
|
74
74
|
#
|
75
75
|
# Finally:
|
76
76
|
#
|
@@ -78,7 +78,7 @@
|
|
78
78
|
# im.write_to_file ARGV[1]
|
79
79
|
# ```
|
80
80
|
#
|
81
|
-
# {
|
81
|
+
# {Image#write_to_file} writes an image back to the filesystem. It can
|
82
82
|
# write any format supported by vips: the file type is set from the filename
|
83
83
|
# suffix. You can also write formatted images to memory buffers, or dump
|
84
84
|
# image data to a raw memory array.
|
@@ -108,7 +108,7 @@
|
|
108
108
|
#
|
109
109
|
# `ruby-vips` adds a {Image.method_missing} handler to {Image} and uses
|
110
110
|
# it to look up vips operations. For example, the libvips operation `add`, which
|
111
|
-
# appears in C as `vips_add()`, appears in Ruby as {
|
111
|
+
# appears in C as `vips_add()`, appears in Ruby as {Image#add}.
|
112
112
|
#
|
113
113
|
# The operation's list of required arguments is searched and the first input
|
114
114
|
# image is set to the value of `self`. Operations which do not take an input
|
@@ -120,7 +120,7 @@
|
|
120
120
|
# produces several results. If the operation has optional output objects, they
|
121
121
|
# are returned as a final hash.
|
122
122
|
#
|
123
|
-
# For example, {
|
123
|
+
# For example, {Image#min}, the vips operation that searches an image for
|
124
124
|
# the minimum value, has a large number of optional arguments. You can use it to
|
125
125
|
# find the minimum value like this:
|
126
126
|
#
|
@@ -137,7 +137,7 @@
|
|
137
137
|
# ```
|
138
138
|
#
|
139
139
|
# Now `x_pos` and `y_pos` will have the coordinates of the minimum value.
|
140
|
-
# There's actually a convenience function for this, {
|
140
|
+
# There's actually a convenience function for this, {Image#minpos}.
|
141
141
|
#
|
142
142
|
# You can also ask for the top *n* minimum, for example:
|
143
143
|
#
|
@@ -162,7 +162,7 @@
|
|
162
162
|
#
|
163
163
|
# libvips types are also automatically wrapped. The override looks at the type
|
164
164
|
# of argument required by the operation and converts the value you supply,
|
165
|
-
# when it can. For example, {
|
165
|
+
# when it can. For example, {Image#linear} takes a `VipsArrayDouble` as
|
166
166
|
# an argument
|
167
167
|
# for the set of constants to use for multiplication. You can supply this
|
168
168
|
# value as an integer, a float, or some kind of compound object and it
|
@@ -175,7 +175,7 @@
|
|
175
175
|
# result_image = image.linear 1, [4, 5, 6]
|
176
176
|
# ```
|
177
177
|
#
|
178
|
-
# And so on. A set of overloads are defined for {
|
178
|
+
# And so on. A set of overloads are defined for {Image#linear}, see below.
|
179
179
|
#
|
180
180
|
# It does a couple of more ambitious conversions. It will automatically convert
|
181
181
|
# to and from the various vips types, like `VipsBlob` and `VipsArrayImage`. For
|
@@ -189,7 +189,7 @@
|
|
189
189
|
#
|
190
190
|
# If an operation takes several input images, you can use a constant for all but
|
191
191
|
# one of them and the wrapper will expand the constant to an image for you. For
|
192
|
-
# example, {
|
192
|
+
# example, {Image#ifthenelse} uses a condition image to pick pixels
|
193
193
|
# between a then and an else image:
|
194
194
|
#
|
195
195
|
# ```ruby
|
@@ -206,7 +206,7 @@
|
|
206
206
|
#
|
207
207
|
# Will make an image where true pixels are green and false pixels are red.
|
208
208
|
#
|
209
|
-
# This is useful for {
|
209
|
+
# This is useful for {Image#bandjoin}, the thing to join two or more
|
210
210
|
# images up bandwise. You can write:
|
211
211
|
#
|
212
212
|
# ```ruby
|
@@ -230,7 +230,7 @@
|
|
230
230
|
# The bulk of these API docs are generated automatically by
|
231
231
|
# {Vips::generate_yard}. It examines
|
232
232
|
# libvips and writes a summary of each operation and the arguments and options
|
233
|
-
# that operation expects.
|
233
|
+
# that that operation expects.
|
234
234
|
#
|
235
235
|
# Use the [C API
|
236
236
|
# docs](http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips)
|
@@ -240,10 +240,31 @@
|
|
240
240
|
#
|
241
241
|
# The wrapper spots errors from vips operations and raises the {Vips::Error}
|
242
242
|
# exception. You can catch it in the usual way.
|
243
|
+
#
|
244
|
+
# # Enums
|
245
|
+
#
|
246
|
+
# The libvips enums, such as `VipsBandFormat` appear in ruby-vips as classes
|
247
|
+
# like {Vips::BandFormat}. Overloads let you manipulate them in the obvious
|
248
|
+
# way. For example:
|
249
|
+
#
|
250
|
+
# ```ruby
|
251
|
+
# irb(main):002:0> im = Vips::Image.new_from_file "IMG_1867.JPG"
|
252
|
+
# => #<Vips::Image:0x13e9760 ptr=0x1a88010>
|
253
|
+
# irb(main):003:0> im.format
|
254
|
+
# => #<Vips::BandFormat uchar>
|
255
|
+
# irb(main):004:0> im.format == :uchar
|
256
|
+
# => true
|
257
|
+
# irb(main):005:0> im.format == "uchar"
|
258
|
+
# => true
|
259
|
+
# irb(main):007:0> im.format == 0
|
260
|
+
# => true
|
261
|
+
# ```
|
262
|
+
#
|
263
|
+
# The `0` is the C value of the enum.
|
243
264
|
#
|
244
265
|
# # Draw operations
|
245
266
|
#
|
246
|
-
# Paint operations like {
|
267
|
+
# Paint operations like {Image#draw_circle} and {Image#draw_line}
|
247
268
|
# modify their input image. This
|
248
269
|
# makes them hard to use with the rest of libvips: you need to be very careful
|
249
270
|
# about the order in which operations execute or you can get nasty crashes.
|
@@ -270,7 +291,7 @@
|
|
270
291
|
# # Expansions
|
271
292
|
#
|
272
293
|
# Some vips operators take an enum to select an action, for example
|
273
|
-
# {
|
294
|
+
# {Image#math} can be used to calculate sine of every pixel like this:
|
274
295
|
#
|
275
296
|
# ```ruby
|
276
297
|
# result_image = image.math :sin
|
@@ -286,9 +307,9 @@
|
|
286
307
|
# # Convenience functions
|
287
308
|
#
|
288
309
|
# The wrapper defines a few extra useful utility functions:
|
289
|
-
# {
|
290
|
-
# {
|
291
|
-
# {
|
310
|
+
# {Image#get_value}, {Image#set_value}, {Image#bandsplit},
|
311
|
+
# {Image#maxpos}, {Image#minpos},
|
312
|
+
# {Image#median}.
|
292
313
|
|
293
314
|
module Vips
|
294
315
|
|
@@ -721,6 +742,13 @@ module Vips
|
|
721
742
|
set name, value
|
722
743
|
end
|
723
744
|
|
745
|
+
# Get the image size.
|
746
|
+
#
|
747
|
+
# @return [Integer, Integer] image width and height
|
748
|
+
def size
|
749
|
+
[width, height]
|
750
|
+
end
|
751
|
+
|
724
752
|
# Add an image, constant or array.
|
725
753
|
#
|
726
754
|
# @param other [Image, Real, Array<Real>] Thing to add to self
|
@@ -1256,9 +1284,11 @@ module Vips
|
|
1256
1284
|
#
|
1257
1285
|
# Regenerate with something like:
|
1258
1286
|
#
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
#
|
1287
|
+
# ```
|
1288
|
+
# $ ruby > methods.rb
|
1289
|
+
# require 'vips'; Vips::generate_yard
|
1290
|
+
# ^D
|
1291
|
+
# ```
|
1262
1292
|
|
1263
1293
|
def self.generate_yard
|
1264
1294
|
# these have hand-written methods, see above
|
data/lib/vips/interpolate.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
module Vips
|
2
2
|
|
3
3
|
# An interpolator. One of these can be given to operations like
|
4
|
-
# {
|
4
|
+
# {Image#affine} or {Image#mapim} to select the type of pixel interpolation
|
5
5
|
# to use.
|
6
6
|
#
|
7
7
|
# To see all interpolators supported by your
|
@@ -23,7 +23,7 @@ module Vips
|
|
23
23
|
# For example:
|
24
24
|
#
|
25
25
|
# ```ruby
|
26
|
-
# im = im.affine :interpolate => Vips::Interpolate.new
|
26
|
+
# im = im.affine [2, 0, 0, 2], :interpolate => Vips::Interpolate.new(:bicubic)
|
27
27
|
# ```
|
28
28
|
|
29
29
|
class Interpolate
|
data/lib/vips/kernel.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
module Vips
|
2
|
+
|
3
|
+
# A resizing kernel. One of these can be given to operations like
|
4
|
+
# {Image#reduceh} or {Image#resize} to select the resizing kernel to use.
|
5
|
+
#
|
6
|
+
# At least these should be available:
|
7
|
+
#
|
8
|
+
# * `:nearest` Nearest-neighbour interpolation.
|
9
|
+
# * `:linear` Linear interpolation.
|
10
|
+
# * `:cubic` Cubic interpolation.
|
11
|
+
# * `:lanczos2` Two-lobe Lanczos
|
12
|
+
# * `:lanczos3` Three-lobe Lanczos
|
13
|
+
#
|
14
|
+
# For example:
|
15
|
+
#
|
16
|
+
# ```ruby
|
17
|
+
# im = im.resize 3, :kernel => :lanczos2
|
18
|
+
# ```
|
19
|
+
|
20
|
+
class Kernel
|
21
|
+
end
|
22
|
+
end
|
data/lib/vips/methods.rb
CHANGED
@@ -8,8 +8,8 @@ module Vips
|
|
8
8
|
# @option opts [Array<Image>] :in Array of input images
|
9
9
|
# @option opts [String] :in_format Format for input filename
|
10
10
|
# @option opts [String] :out_format Format for output filename
|
11
|
-
# @option opts [Vips::Image] :out Output
|
12
|
-
# @option opts [String] :log Output
|
11
|
+
# @option opts [Vips::Image] :out Output Output image
|
12
|
+
# @option opts [String] :log Output Command log
|
13
13
|
# @return [nil, Hash<Symbol => Object>] Hash of optional output items
|
14
14
|
|
15
15
|
# @!method add(right, opts = {})
|
@@ -165,22 +165,22 @@ module Vips
|
|
165
165
|
# Find image minimum.
|
166
166
|
# @param [Hash] opts Set of options
|
167
167
|
# @option opts [Integer] :size Number of minimum values to find
|
168
|
-
# @option opts [Integer] :x Output
|
169
|
-
# @option opts [Integer] :y Output
|
170
|
-
# @option opts [Array<Double>] :out_array Output
|
171
|
-
# @option opts [Array<Integer>] :x_array Output
|
172
|
-
# @option opts [Array<Integer>] :y_array Output
|
168
|
+
# @option opts [Integer] :x Output Horizontal position of minimum
|
169
|
+
# @option opts [Integer] :y Output Vertical position of minimum
|
170
|
+
# @option opts [Array<Double>] :out_array Output Array of output values
|
171
|
+
# @option opts [Array<Integer>] :x_array Output Array of horizontal positions
|
172
|
+
# @option opts [Array<Integer>] :y_array Output Array of vertical positions
|
173
173
|
# @return [Float, Hash<Symbol => Object>] Output value, Hash of optional output items
|
174
174
|
|
175
175
|
# @!method max(, opts = {})
|
176
176
|
# Find image maximum.
|
177
177
|
# @param [Hash] opts Set of options
|
178
178
|
# @option opts [Integer] :size Number of maximum values to find
|
179
|
-
# @option opts [Integer] :x Output
|
180
|
-
# @option opts [Integer] :y Output
|
181
|
-
# @option opts [Array<Double>] :out_array Output
|
182
|
-
# @option opts [Array<Integer>] :x_array Output
|
183
|
-
# @option opts [Array<Integer>] :y_array Output
|
179
|
+
# @option opts [Integer] :x Output Horizontal position of maximum
|
180
|
+
# @option opts [Integer] :y Output Vertical position of maximum
|
181
|
+
# @option opts [Array<Double>] :out_array Output Array of output values
|
182
|
+
# @option opts [Array<Integer>] :x_array Output Array of horizontal positions
|
183
|
+
# @option opts [Array<Integer>] :y_array Output Array of vertical positions
|
184
184
|
# @return [Float, Hash<Symbol => Object>] Output value, Hash of optional output items
|
185
185
|
|
186
186
|
# @!method deviate(, opts = {})
|
@@ -434,7 +434,7 @@ module Vips
|
|
434
434
|
# @!method autorot(, opts = {})
|
435
435
|
# Autorotate image by exif tag.
|
436
436
|
# @param [Hash] opts Set of options
|
437
|
-
# @option opts [Vips::Angle] :angle Output
|
437
|
+
# @option opts [Vips::Angle] :angle Output Angle image was rotated by
|
438
438
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
439
439
|
|
440
440
|
# @!method recomb(m, opts = {})
|
@@ -554,7 +554,7 @@ module Vips
|
|
554
554
|
# Make a text image.
|
555
555
|
# @param text [String] Text to render
|
556
556
|
# @param [Hash] opts Set of options
|
557
|
-
# @option opts [String] :font Font to render
|
557
|
+
# @option opts [String] :font Font to render with
|
558
558
|
# @option opts [Integer] :width Maximum image width in pixels
|
559
559
|
# @option opts [Vips::Align] :align Align on the low, centre or high edge
|
560
560
|
# @option opts [Integer] :dpi DPI to render at
|
@@ -631,9 +631,9 @@ module Vips
|
|
631
631
|
# @param frequency_cutoff [Float] Frequency cutoff
|
632
632
|
# @param [Hash] opts Set of options
|
633
633
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
634
|
-
# @option opts [Boolean] :nodc Remove DC component
|
635
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
636
634
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
635
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
636
|
+
# @option opts [Boolean] :nodc Remove DC component
|
637
637
|
# @return [Vips::Image] Output image
|
638
638
|
|
639
639
|
# @!method self.mask_ideal_ring(width, height, frequency_cutoff, ringwidth, opts = {})
|
@@ -644,9 +644,9 @@ module Vips
|
|
644
644
|
# @param ringwidth [Float] Ringwidth
|
645
645
|
# @param [Hash] opts Set of options
|
646
646
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
647
|
-
# @option opts [Boolean] :nodc Remove DC component
|
648
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
649
647
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
648
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
649
|
+
# @option opts [Boolean] :nodc Remove DC component
|
650
650
|
# @return [Vips::Image] Output image
|
651
651
|
|
652
652
|
# @!method self.mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, opts = {})
|
@@ -659,8 +659,8 @@ module Vips
|
|
659
659
|
# @param [Hash] opts Set of options
|
660
660
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
661
661
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
662
|
-
# @option opts [Boolean] :nodc Remove DC component
|
663
662
|
# @option opts [Boolean] :reject Invert the sense of the filter
|
663
|
+
# @option opts [Boolean] :nodc Remove DC component
|
664
664
|
# @return [Vips::Image] Output image
|
665
665
|
|
666
666
|
# @!method self.mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, opts = {})
|
@@ -673,8 +673,8 @@ module Vips
|
|
673
673
|
# @param [Hash] opts Set of options
|
674
674
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
675
675
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
676
|
-
# @option opts [Boolean] :nodc Remove DC component
|
677
676
|
# @option opts [Boolean] :reject Invert the sense of the filter
|
677
|
+
# @option opts [Boolean] :nodc Remove DC component
|
678
678
|
# @return [Vips::Image] Output image
|
679
679
|
|
680
680
|
# @!method self.mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {})
|
@@ -688,8 +688,8 @@ module Vips
|
|
688
688
|
# @param [Hash] opts Set of options
|
689
689
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
690
690
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
691
|
-
# @option opts [Boolean] :nodc Remove DC component
|
692
691
|
# @option opts [Boolean] :reject Invert the sense of the filter
|
692
|
+
# @option opts [Boolean] :nodc Remove DC component
|
693
693
|
# @return [Vips::Image] Output image
|
694
694
|
|
695
695
|
# @!method self.mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {})
|
@@ -716,9 +716,9 @@ module Vips
|
|
716
716
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
717
717
|
# @param [Hash] opts Set of options
|
718
718
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
719
|
-
# @option opts [Boolean] :nodc Remove DC component
|
720
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
721
719
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
720
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
721
|
+
# @option opts [Boolean] :nodc Remove DC component
|
722
722
|
# @return [Vips::Image] Output image
|
723
723
|
|
724
724
|
# @!method self.mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {})
|
@@ -731,8 +731,8 @@ module Vips
|
|
731
731
|
# @param [Hash] opts Set of options
|
732
732
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
733
733
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
734
|
-
# @option opts [Boolean] :nodc Remove DC component
|
735
734
|
# @option opts [Boolean] :reject Invert the sense of the filter
|
735
|
+
# @option opts [Boolean] :nodc Remove DC component
|
736
736
|
# @return [Vips::Image] Output image
|
737
737
|
|
738
738
|
# @!method self.mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {})
|
@@ -746,8 +746,8 @@ module Vips
|
|
746
746
|
# @param [Hash] opts Set of options
|
747
747
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
748
748
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
749
|
-
# @option opts [Boolean] :nodc Remove DC component
|
750
749
|
# @option opts [Boolean] :reject Invert the sense of the filter
|
750
|
+
# @option opts [Boolean] :nodc Remove DC component
|
751
751
|
# @return [Vips::Image] Output image
|
752
752
|
|
753
753
|
# @!method self.mask_fractal(width, height, fractal_dimension, opts = {})
|
@@ -757,9 +757,9 @@ module Vips
|
|
757
757
|
# @param fractal_dimension [Float] Fractal dimension
|
758
758
|
# @param [Hash] opts Set of options
|
759
759
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
760
|
-
# @option opts [Boolean] :nodc Remove DC component
|
761
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
762
760
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
761
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
762
|
+
# @option opts [Boolean] :nodc Remove DC component
|
763
763
|
# @return [Vips::Image] Output image
|
764
764
|
|
765
765
|
# @!method buildlut(, opts = {})
|
@@ -804,23 +804,22 @@ module Vips
|
|
804
804
|
# @param [Hash] opts Set of options
|
805
805
|
# @return [Vips::Image] Output image
|
806
806
|
|
807
|
-
# @!method self.
|
808
|
-
#
|
809
|
-
# @param
|
807
|
+
# @!method self.worley(width, height, opts = {})
|
808
|
+
# Make a worley noise image.
|
809
|
+
# @param width [Integer] Image width in pixels
|
810
|
+
# @param height [Integer] Image height in pixels
|
810
811
|
# @param [Hash] opts Set of options
|
811
|
-
# @option opts [
|
812
|
-
# @
|
813
|
-
# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
|
814
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
812
|
+
# @option opts [Integer] :cell_size Size of Worley cells
|
813
|
+
# @return [Vips::Image] Output image
|
815
814
|
|
816
|
-
# @!method self.
|
817
|
-
#
|
818
|
-
# @param
|
815
|
+
# @!method self.perlin(width, height, opts = {})
|
816
|
+
# Make a perlin noise image.
|
817
|
+
# @param width [Integer] Image width in pixels
|
818
|
+
# @param height [Integer] Image height in pixels
|
819
819
|
# @param [Hash] opts Set of options
|
820
|
-
# @option opts [
|
821
|
-
# @option opts [
|
822
|
-
# @
|
823
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
820
|
+
# @option opts [Integer] :cell_size Size of Perlin cells
|
821
|
+
# @option opts [Boolean] :uchar Output an unsigned char image
|
822
|
+
# @return [Vips::Image] Output image
|
824
823
|
|
825
824
|
# @!method self.csvload(filename, opts = {})
|
826
825
|
# Load csv from file.
|
@@ -832,7 +831,7 @@ module Vips
|
|
832
831
|
# @option opts [Integer] :lines Read this many lines from the file
|
833
832
|
# @option opts [String] :whitespace Set of whitespace characters
|
834
833
|
# @option opts [String] :separator Set of separator characters
|
835
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
834
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
836
835
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
837
836
|
|
838
837
|
# @!method self.matrixload(filename, opts = {})
|
@@ -841,16 +840,7 @@ module Vips
|
|
841
840
|
# @param [Hash] opts Set of options
|
842
841
|
# @option opts [Boolean] :disc Open to disc
|
843
842
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
844
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
845
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
846
|
-
|
847
|
-
# @!method self.analyzeload(filename, opts = {})
|
848
|
-
# Load an analyze6 image.
|
849
|
-
# @param filename [String] Filename to load from
|
850
|
-
# @param [Hash] opts Set of options
|
851
|
-
# @option opts [Boolean] :disc Open to disc
|
852
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
853
|
-
# @option opts [Vips::ForeignFlags] :flags Output -- Flags for this file
|
843
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
854
844
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
855
845
|
|
856
846
|
# @!method self.rawload(filename, width, height, bands, opts = {})
|
@@ -863,7 +853,7 @@ module Vips
|
|
863
853
|
# @option opts [Boolean] :disc Open to disc
|
864
854
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
865
855
|
# @option opts [Integer] :offset Offset in bytes from start of file
|
866
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
856
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
867
857
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
868
858
|
|
869
859
|
# @!method self.vipsload(filename, opts = {})
|
@@ -872,7 +862,102 @@ module Vips
|
|
872
862
|
# @param [Hash] opts Set of options
|
873
863
|
# @option opts [Boolean] :disc Open to disc
|
874
864
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
875
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
865
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
866
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
867
|
+
|
868
|
+
# @!method self.analyzeload(filename, opts = {})
|
869
|
+
# Load an analyze6 image.
|
870
|
+
# @param filename [String] Filename to load from
|
871
|
+
# @param [Hash] opts Set of options
|
872
|
+
# @option opts [Boolean] :disc Open to disc
|
873
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
874
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
875
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
876
|
+
|
877
|
+
# @!method self.ppmload(filename, opts = {})
|
878
|
+
# Load ppm from file.
|
879
|
+
# @param filename [String] Filename to load from
|
880
|
+
# @param [Hash] opts Set of options
|
881
|
+
# @option opts [Boolean] :disc Open to disc
|
882
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
883
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
884
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
885
|
+
|
886
|
+
# @!method self.radload(filename, opts = {})
|
887
|
+
# Load a radiance image from a file.
|
888
|
+
# @param filename [String] Filename to load from
|
889
|
+
# @param [Hash] opts Set of options
|
890
|
+
# @option opts [Boolean] :disc Open to disc
|
891
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
892
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
893
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
894
|
+
|
895
|
+
# @!method self.pdfload(filename, opts = {})
|
896
|
+
# Load pdf with libpoppler.
|
897
|
+
# @param filename [String] Filename to load from
|
898
|
+
# @param [Hash] opts Set of options
|
899
|
+
# @option opts [Boolean] :disc Open to disc
|
900
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
901
|
+
# @option opts [Integer] :page Load this page from the file
|
902
|
+
# @option opts [Integer] :n Load this many pages
|
903
|
+
# @option opts [Float] :dpi Render at this DPI
|
904
|
+
# @option opts [Float] :scale Scale output by this factor
|
905
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
906
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
907
|
+
|
908
|
+
# @!method self.pdfload_buffer(buffer, opts = {})
|
909
|
+
# Load pdf with libpoppler.
|
910
|
+
# @param buffer [Vips::Blob] Buffer to load from
|
911
|
+
# @param [Hash] opts Set of options
|
912
|
+
# @option opts [Boolean] :disc Open to disc
|
913
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
914
|
+
# @option opts [Integer] :page Load this page from the file
|
915
|
+
# @option opts [Integer] :n Load this many pages
|
916
|
+
# @option opts [Float] :dpi Render at this DPI
|
917
|
+
# @option opts [Float] :scale Scale output by this factor
|
918
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
919
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
920
|
+
|
921
|
+
# @!method self.svgload(filename, opts = {})
|
922
|
+
# Load svg with rsvg.
|
923
|
+
# @param filename [String] Filename to load from
|
924
|
+
# @param [Hash] opts Set of options
|
925
|
+
# @option opts [Boolean] :disc Open to disc
|
926
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
927
|
+
# @option opts [Float] :dpi Render at this DPI
|
928
|
+
# @option opts [Float] :scale Scale output by this factor
|
929
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
930
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
931
|
+
|
932
|
+
# @!method self.svgload_buffer(buffer, opts = {})
|
933
|
+
# Load svg with rsvg.
|
934
|
+
# @param buffer [Vips::Blob] Buffer to load from
|
935
|
+
# @param [Hash] opts Set of options
|
936
|
+
# @option opts [Boolean] :disc Open to disc
|
937
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
938
|
+
# @option opts [Float] :dpi Render at this DPI
|
939
|
+
# @option opts [Float] :scale Scale output by this factor
|
940
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
941
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
942
|
+
|
943
|
+
# @!method self.gifload(filename, opts = {})
|
944
|
+
# Load gif with giflib.
|
945
|
+
# @param filename [String] Filename to load from
|
946
|
+
# @param [Hash] opts Set of options
|
947
|
+
# @option opts [Boolean] :disc Open to disc
|
948
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
949
|
+
# @option opts [Integer] :page Load this page from the file
|
950
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
951
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
952
|
+
|
953
|
+
# @!method self.gifload_buffer(buffer, opts = {})
|
954
|
+
# Load gif with giflib.
|
955
|
+
# @param buffer [Vips::Blob] Buffer to load from
|
956
|
+
# @param [Hash] opts Set of options
|
957
|
+
# @option opts [Boolean] :disc Open to disc
|
958
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
959
|
+
# @option opts [Integer] :page Load this page from the file
|
960
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
876
961
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
877
962
|
|
878
963
|
# @!method self.pngload(filename, opts = {})
|
@@ -881,7 +966,7 @@ module Vips
|
|
881
966
|
# @param [Hash] opts Set of options
|
882
967
|
# @option opts [Boolean] :disc Open to disc
|
883
968
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
884
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
969
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
885
970
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
886
971
|
|
887
972
|
# @!method self.pngload_buffer(buffer, opts = {})
|
@@ -890,7 +975,7 @@ module Vips
|
|
890
975
|
# @param [Hash] opts Set of options
|
891
976
|
# @option opts [Boolean] :disc Open to disc
|
892
977
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
893
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
978
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
894
979
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
895
980
|
|
896
981
|
# @!method self.matload(filename, opts = {})
|
@@ -899,7 +984,7 @@ module Vips
|
|
899
984
|
# @param [Hash] opts Set of options
|
900
985
|
# @option opts [Boolean] :disc Open to disc
|
901
986
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
902
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
987
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
903
988
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
904
989
|
|
905
990
|
# @!method self.jpegload(filename, opts = {})
|
@@ -911,7 +996,7 @@ module Vips
|
|
911
996
|
# @option opts [Integer] :shrink Shrink factor on load
|
912
997
|
# @option opts [Boolean] :fail Fail on first warning
|
913
998
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
914
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
999
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
915
1000
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
916
1001
|
|
917
1002
|
# @!method self.jpegload_buffer(buffer, opts = {})
|
@@ -923,7 +1008,7 @@ module Vips
|
|
923
1008
|
# @option opts [Integer] :shrink Shrink factor on load
|
924
1009
|
# @option opts [Boolean] :fail Fail on first warning
|
925
1010
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
926
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
1011
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
927
1012
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
928
1013
|
|
929
1014
|
# @!method self.webpload(filename, opts = {})
|
@@ -932,7 +1017,8 @@ module Vips
|
|
932
1017
|
# @param [Hash] opts Set of options
|
933
1018
|
# @option opts [Boolean] :disc Open to disc
|
934
1019
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
935
|
-
# @option opts [
|
1020
|
+
# @option opts [Integer] :shrink Shrink factor on load
|
1021
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
936
1022
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
937
1023
|
|
938
1024
|
# @!method self.webpload_buffer(buffer, opts = {})
|
@@ -941,7 +1027,8 @@ module Vips
|
|
941
1027
|
# @param [Hash] opts Set of options
|
942
1028
|
# @option opts [Boolean] :disc Open to disc
|
943
1029
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
944
|
-
# @option opts [
|
1030
|
+
# @option opts [Integer] :shrink Shrink factor on load
|
1031
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
945
1032
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
946
1033
|
|
947
1034
|
# @!method self.tiffload(filename, opts = {})
|
@@ -951,7 +1038,8 @@ module Vips
|
|
951
1038
|
# @option opts [Boolean] :disc Open to disc
|
952
1039
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
953
1040
|
# @option opts [Integer] :page Load this page from the image
|
954
|
-
# @option opts [
|
1041
|
+
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1042
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
955
1043
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
956
1044
|
|
957
1045
|
# @!method self.tiffload_buffer(buffer, opts = {})
|
@@ -961,7 +1049,8 @@ module Vips
|
|
961
1049
|
# @option opts [Boolean] :disc Open to disc
|
962
1050
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
963
1051
|
# @option opts [Integer] :page Load this page from the image
|
964
|
-
# @option opts [
|
1052
|
+
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1053
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
965
1054
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
966
1055
|
|
967
1056
|
# @!method self.openslideload(filename, opts = {})
|
@@ -973,7 +1062,7 @@ module Vips
|
|
973
1062
|
# @option opts [Integer] :level Load this level from the file
|
974
1063
|
# @option opts [Boolean] :autocrop Crop to image bounds
|
975
1064
|
# @option opts [String] :associated Load this associated image
|
976
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
1065
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
977
1066
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
978
1067
|
|
979
1068
|
# @!method self.magickload(filename, opts = {})
|
@@ -982,9 +1071,10 @@ module Vips
|
|
982
1071
|
# @param [Hash] opts Set of options
|
983
1072
|
# @option opts [Boolean] :all_frames Read all frames from an image
|
984
1073
|
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1074
|
+
# @option opts [Integer] :page Load this page from the file
|
985
1075
|
# @option opts [Boolean] :disc Open to disc
|
986
1076
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
987
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
1077
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
988
1078
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
989
1079
|
|
990
1080
|
# @!method self.magickload_buffer(buffer, opts = {})
|
@@ -993,9 +1083,10 @@ module Vips
|
|
993
1083
|
# @param [Hash] opts Set of options
|
994
1084
|
# @option opts [Boolean] :all_frames Read all frames from an image
|
995
1085
|
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1086
|
+
# @option opts [Integer] :page Load this page from the file
|
996
1087
|
# @option opts [Boolean] :disc Open to disc
|
997
1088
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
998
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
1089
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
999
1090
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1000
1091
|
|
1001
1092
|
# @!method self.fitsload(filename, opts = {})
|
@@ -1004,7 +1095,7 @@ module Vips
|
|
1004
1095
|
# @param [Hash] opts Set of options
|
1005
1096
|
# @option opts [Boolean] :disc Open to disc
|
1006
1097
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1007
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
1098
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1008
1099
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1009
1100
|
|
1010
1101
|
# @!method self.openexrload(filename, opts = {})
|
@@ -1013,27 +1104,9 @@ module Vips
|
|
1013
1104
|
# @param [Hash] opts Set of options
|
1014
1105
|
# @option opts [Boolean] :disc Open to disc
|
1015
1106
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1016
|
-
# @option opts [Vips::ForeignFlags] :flags Output
|
1107
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1017
1108
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1018
1109
|
|
1019
|
-
# @!method radsave(filename, opts = {})
|
1020
|
-
# Save image to radiance file.
|
1021
|
-
# @param filename [String] Filename to save to
|
1022
|
-
# @param [Hash] opts Set of options
|
1023
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
1024
|
-
# @option opts [Array<Double>] :background Background value
|
1025
|
-
# @return [nil]
|
1026
|
-
|
1027
|
-
# @!method ppmsave(filename, opts = {})
|
1028
|
-
# Save image to ppm file.
|
1029
|
-
# @param filename [String] Filename to save to
|
1030
|
-
# @param [Hash] opts Set of options
|
1031
|
-
# @option opts [Boolean] :ascii save as ascii
|
1032
|
-
# @option opts [Boolean] :squash save as one bit
|
1033
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
1034
|
-
# @option opts [Array<Double>] :background Background value
|
1035
|
-
# @return [nil]
|
1036
|
-
|
1037
1110
|
# @!method csvsave(filename, opts = {})
|
1038
1111
|
# Save image to csv file.
|
1039
1112
|
# @param filename [String] Filename to save to
|
@@ -1082,6 +1155,31 @@ module Vips
|
|
1082
1155
|
# @option opts [Array<Double>] :background Background value
|
1083
1156
|
# @return [nil]
|
1084
1157
|
|
1158
|
+
# @!method ppmsave(filename, opts = {})
|
1159
|
+
# Save image to ppm file.
|
1160
|
+
# @param filename [String] Filename to save to
|
1161
|
+
# @param [Hash] opts Set of options
|
1162
|
+
# @option opts [Boolean] :ascii save as ascii
|
1163
|
+
# @option opts [Boolean] :squash save as one bit
|
1164
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1165
|
+
# @option opts [Array<Double>] :background Background value
|
1166
|
+
# @return [nil]
|
1167
|
+
|
1168
|
+
# @!method radsave(filename, opts = {})
|
1169
|
+
# Save image to radiance file.
|
1170
|
+
# @param filename [String] Filename to save to
|
1171
|
+
# @param [Hash] opts Set of options
|
1172
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1173
|
+
# @option opts [Array<Double>] :background Background value
|
1174
|
+
# @return [nil]
|
1175
|
+
|
1176
|
+
# @!method radsave_buffer(, opts = {})
|
1177
|
+
# Save image to radiance buffer.
|
1178
|
+
# @param [Hash] opts Set of options
|
1179
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1180
|
+
# @option opts [Array<Double>] :background Background value
|
1181
|
+
# @return [Vips::Blob] Buffer to save to
|
1182
|
+
|
1085
1183
|
# @!method dzsave(filename, opts = {})
|
1086
1184
|
# Save image to deep zoom format.
|
1087
1185
|
# @param filename [String] Filename to save to
|
@@ -1090,11 +1188,12 @@ module Vips
|
|
1090
1188
|
# @option opts [String] :suffix Filename suffix for tiles
|
1091
1189
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1092
1190
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1093
|
-
# @option opts [Boolean] :centre Center image in tile
|
1094
1191
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1192
|
+
# @option opts [Boolean] :centre Center image in tile
|
1095
1193
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
1096
1194
|
# @option opts [Vips::ForeignDzContainer] :container Pyramid container type
|
1097
1195
|
# @option opts [Boolean] :properties Write a properties file to the output directory
|
1196
|
+
# @option opts [Integer] :compression ZIP deflate compression level
|
1098
1197
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1099
1198
|
# @option opts [Array<Double>] :background Background value
|
1100
1199
|
# @return [nil]
|
@@ -1134,6 +1233,7 @@ module Vips
|
|
1134
1233
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1135
1234
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1136
1235
|
# @option opts [Boolean] :optimize_scans Split the spectrum of DCT coefficients into separate scans
|
1236
|
+
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1137
1237
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1138
1238
|
# @option opts [Array<Double>] :background Background value
|
1139
1239
|
# @return [nil]
|
@@ -1149,6 +1249,7 @@ module Vips
|
|
1149
1249
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1150
1250
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1151
1251
|
# @option opts [Boolean] :optimize_scans Split the spectrum of DCT coefficients into separate scans
|
1252
|
+
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1152
1253
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1153
1254
|
# @option opts [Array<Double>] :background Background value
|
1154
1255
|
# @return [Vips::Blob] Buffer to save to
|
@@ -1164,6 +1265,7 @@ module Vips
|
|
1164
1265
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1165
1266
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1166
1267
|
# @option opts [Boolean] :optimize_scans Split the spectrum of DCT coefficients into separate scans
|
1268
|
+
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1167
1269
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1168
1270
|
# @option opts [Array<Double>] :background Background value
|
1169
1271
|
# @return [nil]
|
@@ -1174,6 +1276,10 @@ module Vips
|
|
1174
1276
|
# @param [Hash] opts Set of options
|
1175
1277
|
# @option opts [Integer] :Q Q factor
|
1176
1278
|
# @option opts [Boolean] :lossless enable lossless compression
|
1279
|
+
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
1280
|
+
# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
|
1281
|
+
# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
|
1282
|
+
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
1177
1283
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1178
1284
|
# @option opts [Array<Double>] :background Background value
|
1179
1285
|
# @return [nil]
|
@@ -1183,6 +1289,10 @@ module Vips
|
|
1183
1289
|
# @param [Hash] opts Set of options
|
1184
1290
|
# @option opts [Integer] :Q Q factor
|
1185
1291
|
# @option opts [Boolean] :lossless enable lossless compression
|
1292
|
+
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
1293
|
+
# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
|
1294
|
+
# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
|
1295
|
+
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
1186
1296
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1187
1297
|
# @option opts [Array<Double>] :background Background value
|
1188
1298
|
# @return [Vips::Blob] Buffer to save to
|
@@ -1199,8 +1309,8 @@ module Vips
|
|
1199
1309
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1200
1310
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1201
1311
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1202
|
-
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1203
1312
|
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1313
|
+
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1204
1314
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1205
1315
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1206
1316
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
@@ -1225,30 +1335,45 @@ module Vips
|
|
1225
1335
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
1226
1336
|
# @return [Vips::Image] Output image
|
1227
1337
|
|
1228
|
-
# @!method shrink(
|
1338
|
+
# @!method shrink(hshrink, vshrink, opts = {})
|
1229
1339
|
# Shrink an image.
|
1230
|
-
# @param
|
1231
|
-
# @param
|
1340
|
+
# @param hshrink [Float] Horizontal shrink factor
|
1341
|
+
# @param vshrink [Float] Vertical shrink factor
|
1232
1342
|
# @param [Hash] opts Set of options
|
1233
1343
|
# @return [Vips::Image] Output image
|
1234
1344
|
|
1235
|
-
# @!method shrinkh(
|
1345
|
+
# @!method shrinkh(hshrink, opts = {})
|
1236
1346
|
# Shrink an image horizontally.
|
1237
|
-
# @param
|
1347
|
+
# @param hshrink [Integer] Horizontal shrink factor
|
1238
1348
|
# @param [Hash] opts Set of options
|
1239
1349
|
# @return [Vips::Image] Output image
|
1240
1350
|
|
1241
|
-
# @!method shrinkv(
|
1351
|
+
# @!method shrinkv(vshrink, opts = {})
|
1242
1352
|
# Shrink an image vertically.
|
1243
|
-
# @param
|
1353
|
+
# @param vshrink [Integer] Vertical shrink factor
|
1244
1354
|
# @param [Hash] opts Set of options
|
1245
1355
|
# @return [Vips::Image] Output image
|
1246
1356
|
|
1247
|
-
# @!method
|
1248
|
-
# Shrink an image.
|
1249
|
-
# @param
|
1250
|
-
# @param yshrink [Float] Vertical shrink factor
|
1357
|
+
# @!method reduceh(hshrink, opts = {})
|
1358
|
+
# Shrink an image horizontally.
|
1359
|
+
# @param hshrink [Float] Horizontal shrink factor
|
1251
1360
|
# @param [Hash] opts Set of options
|
1361
|
+
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1362
|
+
# @return [Vips::Image] Output image
|
1363
|
+
|
1364
|
+
# @!method reducev(vshrink, opts = {})
|
1365
|
+
# Shrink an image vertically.
|
1366
|
+
# @param vshrink [Float] Vertical shrink factor
|
1367
|
+
# @param [Hash] opts Set of options
|
1368
|
+
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1369
|
+
# @return [Vips::Image] Output image
|
1370
|
+
|
1371
|
+
# @!method reduce(hshrink, vshrink, opts = {})
|
1372
|
+
# Reduce an image.
|
1373
|
+
# @param hshrink [Float] Horizontal shrink factor
|
1374
|
+
# @param vshrink [Float] Vertical shrink factor
|
1375
|
+
# @param [Hash] opts Set of options
|
1376
|
+
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1252
1377
|
# @return [Vips::Image] Output image
|
1253
1378
|
|
1254
1379
|
# @!method quadratic(coeff, opts = {})
|
@@ -1286,10 +1411,8 @@ module Vips
|
|
1286
1411
|
# Resize an image.
|
1287
1412
|
# @param scale [Float] Scale image by this factor
|
1288
1413
|
# @param [Hash] opts Set of options
|
1289
|
-
# @option opts [Vips::
|
1414
|
+
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1290
1415
|
# @option opts [Float] :vscale Vertical scale image by this factor
|
1291
|
-
# @option opts [Float] :idx Horizontal input displacement
|
1292
|
-
# @option opts [Float] :idy Vertical input displacement
|
1293
1416
|
# @return [Vips::Image] Output image
|
1294
1417
|
|
1295
1418
|
# @!method colourspace(space, opts = {})
|
@@ -1409,8 +1532,8 @@ module Vips
|
|
1409
1532
|
# @!method icc_import(, opts = {})
|
1410
1533
|
# Import from device with icc profile.
|
1411
1534
|
# @param [Hash] opts Set of options
|
1412
|
-
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1413
1535
|
# @option opts [Vips::Intent] :intent Rendering intent
|
1536
|
+
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1414
1537
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
1415
1538
|
# @option opts [String] :input_profile Filename to load input profile from
|
1416
1539
|
# @return [Vips::Image] Output image
|
@@ -1418,8 +1541,8 @@ module Vips
|
|
1418
1541
|
# @!method icc_export(, opts = {})
|
1419
1542
|
# Output to device with icc profile.
|
1420
1543
|
# @param [Hash] opts Set of options
|
1421
|
-
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1422
1544
|
# @option opts [Vips::Intent] :intent Rendering intent
|
1545
|
+
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1423
1546
|
# @option opts [String] :output_profile Filename to load output profile from
|
1424
1547
|
# @option opts [Integer] :depth Output device space depth in bits
|
1425
1548
|
# @return [Vips::Image] Output image
|
@@ -1428,8 +1551,8 @@ module Vips
|
|
1428
1551
|
# Transform between devices with icc profiles.
|
1429
1552
|
# @param output_profile [String] Filename to load output profile from
|
1430
1553
|
# @param [Hash] opts Set of options
|
1431
|
-
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1432
1554
|
# @option opts [Vips::Intent] :intent Rendering intent
|
1555
|
+
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1433
1556
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
1434
1557
|
# @option opts [String] :input_profile Filename to load input profile from
|
1435
1558
|
# @option opts [Integer] :depth Output device space depth in bits
|
@@ -1489,9 +1612,9 @@ module Vips
|
|
1489
1612
|
# @param height [Integer] Window height in pixels
|
1490
1613
|
# @param [Hash] opts Set of options
|
1491
1614
|
# @option opts [Float] :a Weight of new mean
|
1492
|
-
# @option opts [Float] :s0 New deviation
|
1493
|
-
# @option opts [Float] :b Weight of new deviation
|
1494
1615
|
# @option opts [Float] :m0 New mean
|
1616
|
+
# @option opts [Float] :b Weight of new deviation
|
1617
|
+
# @option opts [Float] :s0 New deviation
|
1495
1618
|
# @return [Vips::Image] Output image
|
1496
1619
|
|
1497
1620
|
# @!method hist_cum(, opts = {})
|
@@ -1547,6 +1670,26 @@ module Vips
|
|
1547
1670
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1548
1671
|
# @return [Vips::Image] Output image
|
1549
1672
|
|
1673
|
+
# @!method conva(mask, opts = {})
|
1674
|
+
# Approximate integer convolution.
|
1675
|
+
# @param mask [Vips::Image] Input matrix image
|
1676
|
+
# @param [Hash] opts Set of options
|
1677
|
+
# @option opts [Integer] :layers Use this many layers in approximation
|
1678
|
+
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1679
|
+
# @return [Vips::Image] Output image
|
1680
|
+
|
1681
|
+
# @!method convf(mask, opts = {})
|
1682
|
+
# Float convolution operation.
|
1683
|
+
# @param mask [Vips::Image] Input matrix image
|
1684
|
+
# @param [Hash] opts Set of options
|
1685
|
+
# @return [Vips::Image] Output image
|
1686
|
+
|
1687
|
+
# @!method convi(mask, opts = {})
|
1688
|
+
# Int convolution operation.
|
1689
|
+
# @param mask [Vips::Image] Input matrix image
|
1690
|
+
# @param [Hash] opts Set of options
|
1691
|
+
# @return [Vips::Image] Output image
|
1692
|
+
|
1550
1693
|
# @!method compass(mask, opts = {})
|
1551
1694
|
# Convolve with rotating mask.
|
1552
1695
|
# @param mask [Vips::Image] Input matrix image
|
@@ -1568,6 +1711,13 @@ module Vips
|
|
1568
1711
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1569
1712
|
# @return [Vips::Image] Output image
|
1570
1713
|
|
1714
|
+
# @!method convasep(mask, opts = {})
|
1715
|
+
# Approximate separable integer convolution.
|
1716
|
+
# @param mask [Vips::Image] Input matrix image
|
1717
|
+
# @param [Hash] opts Set of options
|
1718
|
+
# @option opts [Integer] :layers Use this many layers in approximation
|
1719
|
+
# @return [Vips::Image] Output image
|
1720
|
+
|
1571
1721
|
# @!method fastcor(ref, opts = {})
|
1572
1722
|
# Fast correlation.
|
1573
1723
|
# @param ref [Vips::Image] Input reference image
|
@@ -1583,7 +1733,7 @@ module Vips
|
|
1583
1733
|
# @!method sharpen(, opts = {})
|
1584
1734
|
# Unsharp masking for print.
|
1585
1735
|
# @param [Hash] opts Set of options
|
1586
|
-
# @option opts [
|
1736
|
+
# @option opts [Float] :sigma Sigma of Gaussian
|
1587
1737
|
# @option opts [Float] :x1 Flat/jaggy threshold
|
1588
1738
|
# @option opts [Float] :y2 Maximum brightening
|
1589
1739
|
# @option opts [Float] :y3 Maximum darkening
|
@@ -1651,7 +1801,7 @@ module Vips
|
|
1651
1801
|
# @!method labelregions(, opts = {})
|
1652
1802
|
# Label regions in an image.
|
1653
1803
|
# @param [Hash] opts Set of options
|
1654
|
-
# @option opts [Integer] :segments Output
|
1804
|
+
# @option opts [Integer] :segments Output Number of discrete contigious regions
|
1655
1805
|
# @return [Vips::Image, Hash<Symbol => Object>] Mask of region labels, Hash of optional output items
|
1656
1806
|
|
1657
1807
|
# @!method draw_rect(ink, left, top, width, height, opts = {})
|
@@ -1702,10 +1852,10 @@ module Vips
|
|
1702
1852
|
# @param [Hash] opts Set of options
|
1703
1853
|
# @option opts [Vips::Image] :test Test pixels in this image
|
1704
1854
|
# @option opts [Boolean] :equal DrawFlood while equal to edge
|
1705
|
-
# @option opts [Integer] :left Output
|
1706
|
-
# @option opts [Integer] :top Output
|
1707
|
-
# @option opts [Integer] :width Output
|
1708
|
-
# @option opts [Integer] :height Output
|
1855
|
+
# @option opts [Integer] :left Output Left edge of modified area
|
1856
|
+
# @option opts [Integer] :top Output top edge of modified area
|
1857
|
+
# @option opts [Integer] :width Output width of modified area
|
1858
|
+
# @option opts [Integer] :height Output height of modified area
|
1709
1859
|
# @return [Vips::Image, Hash<Symbol => Object>] Image to draw on, Hash of optional output items
|
1710
1860
|
|
1711
1861
|
# @!method draw_image(sub, x, y, opts = {})
|
@@ -1749,12 +1899,12 @@ module Vips
|
|
1749
1899
|
# @option opts [Integer] :harea Half area size
|
1750
1900
|
# @option opts [Integer] :mblend Maximum blend size
|
1751
1901
|
# @option opts [Integer] :bandno Band to search for features on
|
1752
|
-
# @option opts [Integer] :dx0 Output
|
1753
|
-
# @option opts [Integer] :dy0 Output
|
1754
|
-
# @option opts [Float] :scale1 Output
|
1755
|
-
# @option opts [Float] :angle1 Output
|
1756
|
-
# @option opts [Float] :dx1 Output
|
1757
|
-
# @option opts [Float] :dy1 Output
|
1902
|
+
# @option opts [Integer] :dx0 Output Detected integer offset
|
1903
|
+
# @option opts [Integer] :dy0 Output Detected integer offset
|
1904
|
+
# @option opts [Float] :scale1 Output Detected scale
|
1905
|
+
# @option opts [Float] :angle1 Output Detected rotation
|
1906
|
+
# @option opts [Float] :dx1 Output Detected first-order displacement
|
1907
|
+
# @option opts [Float] :dy1 Output Detected first-order displacement
|
1758
1908
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1759
1909
|
|
1760
1910
|
# @!method mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {})
|