vips 8.8.0.1 → 8.8.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/vips/image.rb +9 -9
- data/lib/vips/methods.rb +251 -251
- data/lib/vips/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 943ca3029abd78e73b18a335616a7b7f31f98ba6461eeed8b15c584887565d21
|
4
|
+
data.tar.gz: 04460b135a6d5e8e6c51dd55db60ee8e61bdac4c41035c2a896af4ae9a52f249
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2ee761b2cffa986e43f98edf6f41712b91e2a5a3b013051032618e03d288c84ef640d69ccd54f88a54308597e6c3e698737800271bf421b3fc5bff253dbd8586
|
7
|
+
data.tar.gz: 43496ceb067f1099b546d3cf8b19b42e8fe721387fc94becefb6a1d6c2ac1d3d1a146b534c505a8c2b3a900acf1220b4398af4a6891253a338dea588597c6d01
|
data/lib/vips/image.rb
CHANGED
@@ -252,7 +252,7 @@ module Vips
|
|
252
252
|
# @param name [String] the filename to load from
|
253
253
|
# @macro vips.loadopts
|
254
254
|
# @return [Image] the loaded image
|
255
|
-
def self.new_from_file name, opts
|
255
|
+
def self.new_from_file name, **opts
|
256
256
|
# very common, and Vips::vips_filename_get_filename will segv if we
|
257
257
|
# pass this
|
258
258
|
raise Vips::Error, "filename is nil" if name == nil
|
@@ -296,7 +296,7 @@ module Vips
|
|
296
296
|
# @param option_string [String] load options as a string
|
297
297
|
# @macro vips.loadopts
|
298
298
|
# @return [Image] the loaded image
|
299
|
-
def self.new_from_buffer data, option_string, opts
|
299
|
+
def self.new_from_buffer data, option_string, **opts
|
300
300
|
loader = Vips::vips_foreign_find_load_buffer data, data.bytesize
|
301
301
|
raise Vips::Error if loader == nil
|
302
302
|
|
@@ -418,7 +418,7 @@ module Vips
|
|
418
418
|
# flatten alpha against, if necessary
|
419
419
|
#
|
420
420
|
# @param name [String] filename to write to
|
421
|
-
def write_to_file name, opts
|
421
|
+
def write_to_file name, **opts
|
422
422
|
filename = Vips::p2str(Vips::vips_filename_get_filename name)
|
423
423
|
option_string = Vips::p2str(Vips::vips_filename_get_options name)
|
424
424
|
saver = Vips::vips_foreign_find_save filename
|
@@ -456,7 +456,7 @@ module Vips
|
|
456
456
|
# @param format_string [String] save format plus options
|
457
457
|
# @macro vips.saveopts
|
458
458
|
# @return [String] the image saved in the specified format
|
459
|
-
def write_to_buffer format_string, opts
|
459
|
+
def write_to_buffer format_string, **opts
|
460
460
|
filename =
|
461
461
|
Vips::p2str(Vips::vips_filename_get_filename format_string)
|
462
462
|
option_string =
|
@@ -753,7 +753,7 @@ module Vips
|
|
753
753
|
# See {Image#draw_rect}.
|
754
754
|
#
|
755
755
|
# @return [Image] modified image
|
756
|
-
def draw_point ink, left, top, opts
|
756
|
+
def draw_point ink, left, top, **opts
|
757
757
|
draw_rect ink, left, top, 1, 1, opts
|
758
758
|
end
|
759
759
|
|
@@ -1061,7 +1061,7 @@ module Vips
|
|
1061
1061
|
# @option opts [Vips::Interpretation] :compositing_space Composite images in this colour space
|
1062
1062
|
# @option opts [Boolean] :premultiplied Images have premultiplied alpha
|
1063
1063
|
# @return [Image] blended image
|
1064
|
-
def composite overlay, mode, opts
|
1064
|
+
def composite overlay, mode, **opts
|
1065
1065
|
unless overlay.is_a? Array
|
1066
1066
|
overlay = [overlay]
|
1067
1067
|
end
|
@@ -1304,7 +1304,7 @@ module Vips
|
|
1304
1304
|
# @param opts [Hash] set of options
|
1305
1305
|
# @option opts [Boolean] :blend (false) Blend smoothly between th and el
|
1306
1306
|
# @return [Image] merged image
|
1307
|
-
def ifthenelse(th, el, opts
|
1307
|
+
def ifthenelse(th, el, **opts)
|
1308
1308
|
match_image = [th, el, self].find {|x| x.is_a? Vips::Image}
|
1309
1309
|
|
1310
1310
|
unless th.is_a? Vips::Image
|
@@ -1322,7 +1322,7 @@ module Vips
|
|
1322
1322
|
#
|
1323
1323
|
# @param opts [Hash] Set of options
|
1324
1324
|
# @return [Vips::Image] Output image
|
1325
|
-
def scaleimage opts
|
1325
|
+
def scaleimage **opts
|
1326
1326
|
Vips::Image.scale self, opts
|
1327
1327
|
end
|
1328
1328
|
|
@@ -1430,7 +1430,7 @@ module Vips
|
|
1430
1430
|
print "#{nickname}("
|
1431
1431
|
print required_input.map{|x| x[:name]}.join(", ")
|
1432
1432
|
print ", " if required_input.length > 0
|
1433
|
-
puts "opts
|
1433
|
+
puts "**opts)"
|
1434
1434
|
|
1435
1435
|
puts "# #{description.capitalize}."
|
1436
1436
|
|
data/lib/vips/methods.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
module Vips
|
2
2
|
class Image
|
3
3
|
|
4
|
-
# @!method self.system(cmd_format, opts
|
4
|
+
# @!method self.system(cmd_format, **opts)
|
5
5
|
# Run an external command.
|
6
6
|
# @param cmd_format [String] Command to run
|
7
7
|
# @param opts [Hash] Set of options
|
@@ -12,82 +12,82 @@ module Vips
|
|
12
12
|
# @option opts [String] :log Output Command log
|
13
13
|
# @return [nil, Hash<Symbol => Object>] Hash of optional output items
|
14
14
|
|
15
|
-
# @!method add(right, opts
|
15
|
+
# @!method add(right, **opts)
|
16
16
|
# Add two images.
|
17
17
|
# @param right [Vips::Image] Right-hand image argument
|
18
18
|
# @param opts [Hash] Set of options
|
19
19
|
# @return [Vips::Image] Output image
|
20
20
|
|
21
|
-
# @!method subtract(right, opts
|
21
|
+
# @!method subtract(right, **opts)
|
22
22
|
# Subtract two images.
|
23
23
|
# @param right [Vips::Image] Right-hand image argument
|
24
24
|
# @param opts [Hash] Set of options
|
25
25
|
# @return [Vips::Image] Output image
|
26
26
|
|
27
|
-
# @!method multiply(right, opts
|
27
|
+
# @!method multiply(right, **opts)
|
28
28
|
# Multiply two images.
|
29
29
|
# @param right [Vips::Image] Right-hand image argument
|
30
30
|
# @param opts [Hash] Set of options
|
31
31
|
# @return [Vips::Image] Output image
|
32
32
|
|
33
|
-
# @!method divide(right, opts
|
33
|
+
# @!method divide(right, **opts)
|
34
34
|
# Divide two images.
|
35
35
|
# @param right [Vips::Image] Right-hand image argument
|
36
36
|
# @param opts [Hash] Set of options
|
37
37
|
# @return [Vips::Image] Output image
|
38
38
|
|
39
|
-
# @!method relational(right, relational, opts
|
39
|
+
# @!method relational(right, relational, **opts)
|
40
40
|
# Relational operation on two images.
|
41
41
|
# @param right [Vips::Image] Right-hand image argument
|
42
42
|
# @param relational [Vips::OperationRelational] relational to perform
|
43
43
|
# @param opts [Hash] Set of options
|
44
44
|
# @return [Vips::Image] Output image
|
45
45
|
|
46
|
-
# @!method remainder(right, opts
|
46
|
+
# @!method remainder(right, **opts)
|
47
47
|
# Remainder after integer division of two images.
|
48
48
|
# @param right [Vips::Image] Right-hand image argument
|
49
49
|
# @param opts [Hash] Set of options
|
50
50
|
# @return [Vips::Image] Output image
|
51
51
|
|
52
|
-
# @!method boolean(right, boolean, opts
|
52
|
+
# @!method boolean(right, boolean, **opts)
|
53
53
|
# Boolean operation on two images.
|
54
54
|
# @param right [Vips::Image] Right-hand image argument
|
55
55
|
# @param boolean [Vips::OperationBoolean] boolean to perform
|
56
56
|
# @param opts [Hash] Set of options
|
57
57
|
# @return [Vips::Image] Output image
|
58
58
|
|
59
|
-
# @!method math2(right, math2, opts
|
59
|
+
# @!method math2(right, math2, **opts)
|
60
60
|
# Binary math operations.
|
61
61
|
# @param right [Vips::Image] Right-hand image argument
|
62
62
|
# @param math2 [Vips::OperationMath2] math to perform
|
63
63
|
# @param opts [Hash] Set of options
|
64
64
|
# @return [Vips::Image] Output image
|
65
65
|
|
66
|
-
# @!method complex2(right, cmplx, opts
|
66
|
+
# @!method complex2(right, cmplx, **opts)
|
67
67
|
# Complex binary operations on two images.
|
68
68
|
# @param right [Vips::Image] Right-hand image argument
|
69
69
|
# @param cmplx [Vips::OperationComplex2] binary complex operation to perform
|
70
70
|
# @param opts [Hash] Set of options
|
71
71
|
# @return [Vips::Image] Output image
|
72
72
|
|
73
|
-
# @!method complexform(right, opts
|
73
|
+
# @!method complexform(right, **opts)
|
74
74
|
# Form a complex image from two real images.
|
75
75
|
# @param right [Vips::Image] Right-hand image argument
|
76
76
|
# @param opts [Hash] Set of options
|
77
77
|
# @return [Vips::Image] Output image
|
78
78
|
|
79
|
-
# @!method self.sum(im, opts
|
79
|
+
# @!method self.sum(im, **opts)
|
80
80
|
# Sum an array of images.
|
81
81
|
# @param im [Array<Image>] Array of input images
|
82
82
|
# @param opts [Hash] Set of options
|
83
83
|
# @return [Vips::Image] Output image
|
84
84
|
|
85
|
-
# @!method invert(opts
|
85
|
+
# @!method invert(**opts)
|
86
86
|
# Invert an image.
|
87
87
|
# @param opts [Hash] Set of options
|
88
88
|
# @return [Vips::Image] Output image
|
89
89
|
|
90
|
-
# @!method linear(a, b, opts
|
90
|
+
# @!method linear(a, b, **opts)
|
91
91
|
# Calculate (a * in + b).
|
92
92
|
# @param a [Array<Double>] Multiply by this
|
93
93
|
# @param b [Array<Double>] Add this
|
@@ -95,73 +95,73 @@ module Vips
|
|
95
95
|
# @option opts [Boolean] :uchar Output should be uchar
|
96
96
|
# @return [Vips::Image] Output image
|
97
97
|
|
98
|
-
# @!method math(math, opts
|
98
|
+
# @!method math(math, **opts)
|
99
99
|
# Apply a math operation to an image.
|
100
100
|
# @param math [Vips::OperationMath] math to perform
|
101
101
|
# @param opts [Hash] Set of options
|
102
102
|
# @return [Vips::Image] Output image
|
103
103
|
|
104
|
-
# @!method abs(opts
|
104
|
+
# @!method abs(**opts)
|
105
105
|
# Absolute value of an image.
|
106
106
|
# @param opts [Hash] Set of options
|
107
107
|
# @return [Vips::Image] Output image
|
108
108
|
|
109
|
-
# @!method sign(opts
|
109
|
+
# @!method sign(**opts)
|
110
110
|
# Unit vector of pixel.
|
111
111
|
# @param opts [Hash] Set of options
|
112
112
|
# @return [Vips::Image] Output image
|
113
113
|
|
114
|
-
# @!method round(round, opts
|
114
|
+
# @!method round(round, **opts)
|
115
115
|
# Perform a round function on an image.
|
116
116
|
# @param round [Vips::OperationRound] rounding operation to perform
|
117
117
|
# @param opts [Hash] Set of options
|
118
118
|
# @return [Vips::Image] Output image
|
119
119
|
|
120
|
-
# @!method relational_const(relational, c, opts
|
120
|
+
# @!method relational_const(relational, c, **opts)
|
121
121
|
# Relational operations against a constant.
|
122
122
|
# @param relational [Vips::OperationRelational] relational to perform
|
123
123
|
# @param c [Array<Double>] Array of constants
|
124
124
|
# @param opts [Hash] Set of options
|
125
125
|
# @return [Vips::Image] Output image
|
126
126
|
|
127
|
-
# @!method remainder_const(c, opts
|
127
|
+
# @!method remainder_const(c, **opts)
|
128
128
|
# Remainder after integer division of an image and a constant.
|
129
129
|
# @param c [Array<Double>] Array of constants
|
130
130
|
# @param opts [Hash] Set of options
|
131
131
|
# @return [Vips::Image] Output image
|
132
132
|
|
133
|
-
# @!method boolean_const(boolean, c, opts
|
133
|
+
# @!method boolean_const(boolean, c, **opts)
|
134
134
|
# Boolean operations against a constant.
|
135
135
|
# @param boolean [Vips::OperationBoolean] boolean to perform
|
136
136
|
# @param c [Array<Double>] Array of constants
|
137
137
|
# @param opts [Hash] Set of options
|
138
138
|
# @return [Vips::Image] Output image
|
139
139
|
|
140
|
-
# @!method math2_const(math2, c, opts
|
140
|
+
# @!method math2_const(math2, c, **opts)
|
141
141
|
# Binary math operations with a constant.
|
142
142
|
# @param math2 [Vips::OperationMath2] math to perform
|
143
143
|
# @param c [Array<Double>] Array of constants
|
144
144
|
# @param opts [Hash] Set of options
|
145
145
|
# @return [Vips::Image] Output image
|
146
146
|
|
147
|
-
# @!method complex(cmplx, opts
|
147
|
+
# @!method complex(cmplx, **opts)
|
148
148
|
# Perform a complex operation on an image.
|
149
149
|
# @param cmplx [Vips::OperationComplex] complex to perform
|
150
150
|
# @param opts [Hash] Set of options
|
151
151
|
# @return [Vips::Image] Output image
|
152
152
|
|
153
|
-
# @!method complexget(get, opts
|
153
|
+
# @!method complexget(get, **opts)
|
154
154
|
# Get a component from a complex image.
|
155
155
|
# @param get [Vips::OperationComplexget] complex to perform
|
156
156
|
# @param opts [Hash] Set of options
|
157
157
|
# @return [Vips::Image] Output image
|
158
158
|
|
159
|
-
# @!method avg(opts
|
159
|
+
# @!method avg(**opts)
|
160
160
|
# Find image average.
|
161
161
|
# @param opts [Hash] Set of options
|
162
162
|
# @return [Float] Output value
|
163
163
|
|
164
|
-
# @!method min(opts
|
164
|
+
# @!method min(**opts)
|
165
165
|
# Find image minimum.
|
166
166
|
# @param opts [Hash] Set of options
|
167
167
|
# @option opts [Integer] :size Number of minimum values to find
|
@@ -172,7 +172,7 @@ module Vips
|
|
172
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
|
-
# @!method max(opts
|
175
|
+
# @!method max(**opts)
|
176
176
|
# Find image maximum.
|
177
177
|
# @param opts [Hash] Set of options
|
178
178
|
# @option opts [Integer] :size Number of maximum values to find
|
@@ -183,43 +183,43 @@ module Vips
|
|
183
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
|
-
# @!method deviate(opts
|
186
|
+
# @!method deviate(**opts)
|
187
187
|
# Find image standard deviation.
|
188
188
|
# @param opts [Hash] Set of options
|
189
189
|
# @return [Float] Output value
|
190
190
|
|
191
|
-
# @!method stats(opts
|
191
|
+
# @!method stats(**opts)
|
192
192
|
# Find many image stats.
|
193
193
|
# @param opts [Hash] Set of options
|
194
194
|
# @return [Vips::Image] Output array of statistics
|
195
195
|
|
196
|
-
# @!method hist_find(opts
|
196
|
+
# @!method hist_find(**opts)
|
197
197
|
# Find image histogram.
|
198
198
|
# @param opts [Hash] Set of options
|
199
199
|
# @option opts [Integer] :band Find histogram of band
|
200
200
|
# @return [Vips::Image] Output histogram
|
201
201
|
|
202
|
-
# @!method hist_find_ndim(opts
|
202
|
+
# @!method hist_find_ndim(**opts)
|
203
203
|
# Find n-dimensional image histogram.
|
204
204
|
# @param opts [Hash] Set of options
|
205
205
|
# @option opts [Integer] :bins Number of bins in each dimension
|
206
206
|
# @return [Vips::Image] Output histogram
|
207
207
|
|
208
|
-
# @!method hist_find_indexed(index, opts
|
208
|
+
# @!method hist_find_indexed(index, **opts)
|
209
209
|
# Find indexed image histogram.
|
210
210
|
# @param index [Vips::Image] Index image
|
211
211
|
# @param opts [Hash] Set of options
|
212
212
|
# @option opts [Vips::Combine] :combine Combine bins like this
|
213
213
|
# @return [Vips::Image] Output histogram
|
214
214
|
|
215
|
-
# @!method hough_line(opts
|
215
|
+
# @!method hough_line(**opts)
|
216
216
|
# Find hough line transform.
|
217
217
|
# @param opts [Hash] Set of options
|
218
218
|
# @option opts [Integer] :width horizontal size of parameter space
|
219
219
|
# @option opts [Integer] :height Vertical size of parameter space
|
220
220
|
# @return [Vips::Image] Output image
|
221
221
|
|
222
|
-
# @!method hough_circle(opts
|
222
|
+
# @!method hough_circle(**opts)
|
223
223
|
# Find hough circle transform.
|
224
224
|
# @param opts [Hash] Set of options
|
225
225
|
# @option opts [Integer] :scale Scale down dimensions by this factor
|
@@ -227,17 +227,17 @@ module Vips
|
|
227
227
|
# @option opts [Integer] :max_radius Largest radius to search for
|
228
228
|
# @return [Vips::Image] Output image
|
229
229
|
|
230
|
-
# @!method project(opts
|
230
|
+
# @!method project(**opts)
|
231
231
|
# Find image projections.
|
232
232
|
# @param opts [Hash] Set of options
|
233
233
|
# @return [Array<] Sums of columns, Sums of rows
|
234
234
|
|
235
|
-
# @!method profile(opts
|
235
|
+
# @!method profile(**opts)
|
236
236
|
# Find image profiles.
|
237
237
|
# @param opts [Hash] Set of options
|
238
238
|
# @return [Array<] First non-zero pixel in column, First non-zero pixel in row
|
239
239
|
|
240
|
-
# @!method measure(h, v, opts
|
240
|
+
# @!method measure(h, v, **opts)
|
241
241
|
# Measure a set of patches on a color chart.
|
242
242
|
# @param h [Integer] Number of patches across chart
|
243
243
|
# @param v [Integer] Number of patches down chart
|
@@ -248,21 +248,21 @@ module Vips
|
|
248
248
|
# @option opts [Integer] :height Height of extract area
|
249
249
|
# @return [Vips::Image] Output array of statistics
|
250
250
|
|
251
|
-
# @!method getpoint(x, y, opts
|
251
|
+
# @!method getpoint(x, y, **opts)
|
252
252
|
# Read a point from an image.
|
253
253
|
# @param x [Integer] Point to read
|
254
254
|
# @param y [Integer] Point to read
|
255
255
|
# @param opts [Hash] Set of options
|
256
256
|
# @return [Array<Double>] Array of output values
|
257
257
|
|
258
|
-
# @!method find_trim(opts
|
258
|
+
# @!method find_trim(**opts)
|
259
259
|
# Search an image for non-edge areas.
|
260
260
|
# @param opts [Hash] Set of options
|
261
261
|
# @option opts [Float] :threshold Object threshold
|
262
262
|
# @option opts [Array<Double>] :background Color for background pixels
|
263
263
|
# @return [Array<] Left edge of image, Top edge of extract area, Width of extract area, Height of extract area
|
264
264
|
|
265
|
-
# @!method copy(opts
|
265
|
+
# @!method copy(**opts)
|
266
266
|
# Copy an image.
|
267
267
|
# @param opts [Hash] Set of options
|
268
268
|
# @option opts [Integer] :width Image width in pixels
|
@@ -277,7 +277,7 @@ module Vips
|
|
277
277
|
# @option opts [Integer] :yoffset Vertical offset of origin
|
278
278
|
# @return [Vips::Image] Output image
|
279
279
|
|
280
|
-
# @!method tilecache(opts
|
280
|
+
# @!method tilecache(**opts)
|
281
281
|
# Cache an image as a set of tiles.
|
282
282
|
# @param opts [Hash] Set of options
|
283
283
|
# @option opts [Integer] :tile_width Tile width in pixels
|
@@ -288,7 +288,7 @@ module Vips
|
|
288
288
|
# @option opts [Boolean] :persistent Keep cache between evaluations
|
289
289
|
# @return [Vips::Image] Output image
|
290
290
|
|
291
|
-
# @!method linecache(opts
|
291
|
+
# @!method linecache(**opts)
|
292
292
|
# Cache an image as a set of lines.
|
293
293
|
# @param opts [Hash] Set of options
|
294
294
|
# @option opts [Integer] :tile_height Tile height in pixels
|
@@ -297,13 +297,13 @@ module Vips
|
|
297
297
|
# @option opts [Boolean] :persistent Keep cache between evaluations
|
298
298
|
# @return [Vips::Image] Output image
|
299
299
|
|
300
|
-
# @!method sequential(opts
|
300
|
+
# @!method sequential(**opts)
|
301
301
|
# Check sequential access.
|
302
302
|
# @param opts [Hash] Set of options
|
303
303
|
# @option opts [Integer] :tile_height Tile height in pixels
|
304
304
|
# @return [Vips::Image] Output image
|
305
305
|
|
306
|
-
# @!method cache(opts
|
306
|
+
# @!method cache(**opts)
|
307
307
|
# Cache an image.
|
308
308
|
# @param opts [Hash] Set of options
|
309
309
|
# @option opts [Integer] :max_tiles Maximum number of tiles to cache
|
@@ -311,7 +311,7 @@ module Vips
|
|
311
311
|
# @option opts [Integer] :tile_width Tile width in pixels
|
312
312
|
# @return [Vips::Image] Output image
|
313
313
|
|
314
|
-
# @!method embed(x, y, width, height, opts
|
314
|
+
# @!method embed(x, y, width, height, **opts)
|
315
315
|
# Embed an image in a larger image.
|
316
316
|
# @param x [Integer] Left edge of input in output
|
317
317
|
# @param y [Integer] Top edge of input in output
|
@@ -322,7 +322,7 @@ module Vips
|
|
322
322
|
# @option opts [Array<Double>] :background Color for background pixels
|
323
323
|
# @return [Vips::Image] Output image
|
324
324
|
|
325
|
-
# @!method gravity(direction, width, height, opts
|
325
|
+
# @!method gravity(direction, width, height, **opts)
|
326
326
|
# Place an image within a larger image with a certain gravity.
|
327
327
|
# @param direction [Vips::CompassDirection] direction to place image within width/height
|
328
328
|
# @param width [Integer] Image width in pixels
|
@@ -332,13 +332,13 @@ module Vips
|
|
332
332
|
# @option opts [Array<Double>] :background Color for background pixels
|
333
333
|
# @return [Vips::Image] Output image
|
334
334
|
|
335
|
-
# @!method flip(direction, opts
|
335
|
+
# @!method flip(direction, **opts)
|
336
336
|
# Flip an image.
|
337
337
|
# @param direction [Vips::Direction] Direction to flip image
|
338
338
|
# @param opts [Hash] Set of options
|
339
339
|
# @return [Vips::Image] Output image
|
340
340
|
|
341
|
-
# @!method insert(sub, x, y, opts
|
341
|
+
# @!method insert(sub, x, y, **opts)
|
342
342
|
# Insert image @sub into @main at @x, @y.
|
343
343
|
# @param sub [Vips::Image] Sub-image to insert into main image
|
344
344
|
# @param x [Integer] Left edge of sub in main
|
@@ -348,7 +348,7 @@ module Vips
|
|
348
348
|
# @option opts [Array<Double>] :background Color for new pixels
|
349
349
|
# @return [Vips::Image] Output image
|
350
350
|
|
351
|
-
# @!method join(in2, direction, opts
|
351
|
+
# @!method join(in2, direction, **opts)
|
352
352
|
# Join a pair of images.
|
353
353
|
# @param in2 [Vips::Image] Second input image
|
354
354
|
# @param direction [Vips::Direction] Join left-right or up-down
|
@@ -359,7 +359,7 @@ module Vips
|
|
359
359
|
# @option opts [Vips::Align] :align Align on the low, centre or high coordinate edge
|
360
360
|
# @return [Vips::Image] Output image
|
361
361
|
|
362
|
-
# @!method self.arrayjoin(im, opts
|
362
|
+
# @!method self.arrayjoin(im, **opts)
|
363
363
|
# Join an array of images.
|
364
364
|
# @param im [Array<Image>] Array of input images
|
365
365
|
# @param opts [Hash] Set of options
|
@@ -372,7 +372,7 @@ module Vips
|
|
372
372
|
# @option opts [Integer] :vspacing Vertical spacing between images
|
373
373
|
# @return [Vips::Image] Output image
|
374
374
|
|
375
|
-
# @!method extract_area(left, top, width, height, opts
|
375
|
+
# @!method extract_area(left, top, width, height, **opts)
|
376
376
|
# Extract an area from an image.
|
377
377
|
# @param left [Integer] Left edge of extract area
|
378
378
|
# @param top [Integer] Top edge of extract area
|
@@ -381,7 +381,7 @@ module Vips
|
|
381
381
|
# @param opts [Hash] Set of options
|
382
382
|
# @return [Vips::Image] Output image
|
383
383
|
|
384
|
-
# @!method extract_area(left, top, width, height, opts
|
384
|
+
# @!method extract_area(left, top, width, height, **opts)
|
385
385
|
# Extract an area from an image.
|
386
386
|
# @param left [Integer] Left edge of extract area
|
387
387
|
# @param top [Integer] Top edge of extract area
|
@@ -390,7 +390,7 @@ module Vips
|
|
390
390
|
# @param opts [Hash] Set of options
|
391
391
|
# @return [Vips::Image] Output image
|
392
392
|
|
393
|
-
# @!method smartcrop(width, height, opts
|
393
|
+
# @!method smartcrop(width, height, **opts)
|
394
394
|
# Extract an area from an image.
|
395
395
|
# @param width [Integer] Width of extract area
|
396
396
|
# @param height [Integer] Height of extract area
|
@@ -398,107 +398,107 @@ module Vips
|
|
398
398
|
# @option opts [Vips::Interesting] :interesting How to measure interestingness
|
399
399
|
# @return [Vips::Image] Output image
|
400
400
|
|
401
|
-
# @!method extract_band(band, opts
|
401
|
+
# @!method extract_band(band, **opts)
|
402
402
|
# Extract band from an image.
|
403
403
|
# @param band [Integer] Band to extract
|
404
404
|
# @param opts [Hash] Set of options
|
405
405
|
# @option opts [Integer] :n Number of bands to extract
|
406
406
|
# @return [Vips::Image] Output image
|
407
407
|
|
408
|
-
# @!method bandjoin_const(c, opts
|
408
|
+
# @!method bandjoin_const(c, **opts)
|
409
409
|
# Append a constant band to an image.
|
410
410
|
# @param c [Array<Double>] Array of constants to add
|
411
411
|
# @param opts [Hash] Set of options
|
412
412
|
# @return [Vips::Image] Output image
|
413
413
|
|
414
|
-
# @!method self.bandrank(im, opts
|
414
|
+
# @!method self.bandrank(im, **opts)
|
415
415
|
# Band-wise rank of a set of images.
|
416
416
|
# @param im [Array<Image>] Array of input images
|
417
417
|
# @param opts [Hash] Set of options
|
418
418
|
# @option opts [Integer] :index Select this band element from sorted list
|
419
419
|
# @return [Vips::Image] Output image
|
420
420
|
|
421
|
-
# @!method bandmean(opts
|
421
|
+
# @!method bandmean(**opts)
|
422
422
|
# Band-wise average.
|
423
423
|
# @param opts [Hash] Set of options
|
424
424
|
# @return [Vips::Image] Output image
|
425
425
|
|
426
|
-
# @!method bandbool(boolean, opts
|
426
|
+
# @!method bandbool(boolean, **opts)
|
427
427
|
# Boolean operation across image bands.
|
428
428
|
# @param boolean [Vips::OperationBoolean] boolean to perform
|
429
429
|
# @param opts [Hash] Set of options
|
430
430
|
# @return [Vips::Image] Output image
|
431
431
|
|
432
|
-
# @!method replicate(across, down, opts
|
432
|
+
# @!method replicate(across, down, **opts)
|
433
433
|
# Replicate an image.
|
434
434
|
# @param across [Integer] Repeat this many times horizontally
|
435
435
|
# @param down [Integer] Repeat this many times vertically
|
436
436
|
# @param opts [Hash] Set of options
|
437
437
|
# @return [Vips::Image] Output image
|
438
438
|
|
439
|
-
# @!method cast(format, opts
|
439
|
+
# @!method cast(format, **opts)
|
440
440
|
# Cast an image.
|
441
441
|
# @param format [Vips::BandFormat] Format to cast to
|
442
442
|
# @param opts [Hash] Set of options
|
443
443
|
# @option opts [Boolean] :shift Shift integer values up and down
|
444
444
|
# @return [Vips::Image] Output image
|
445
445
|
|
446
|
-
# @!method rot(angle, opts
|
446
|
+
# @!method rot(angle, **opts)
|
447
447
|
# Rotate an image.
|
448
448
|
# @param angle [Vips::Angle] Angle to rotate image
|
449
449
|
# @param opts [Hash] Set of options
|
450
450
|
# @return [Vips::Image] Output image
|
451
451
|
|
452
|
-
# @!method rot45(opts
|
452
|
+
# @!method rot45(**opts)
|
453
453
|
# Rotate an image.
|
454
454
|
# @param opts [Hash] Set of options
|
455
455
|
# @option opts [Vips::Angle45] :angle Angle to rotate image
|
456
456
|
# @return [Vips::Image] Output image
|
457
457
|
|
458
|
-
# @!method autorot(opts
|
458
|
+
# @!method autorot(**opts)
|
459
459
|
# Autorotate image by exif tag.
|
460
460
|
# @param opts [Hash] Set of options
|
461
461
|
# @option opts [Vips::Angle] :angle Output Angle image was rotated by
|
462
462
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
463
463
|
|
464
|
-
# @!method recomb(m, opts
|
464
|
+
# @!method recomb(m, **opts)
|
465
465
|
# Linear recombination with matrix.
|
466
466
|
# @param m [Vips::Image] matrix of coefficients
|
467
467
|
# @param opts [Hash] Set of options
|
468
468
|
# @return [Vips::Image] Output image
|
469
469
|
|
470
|
-
# @!method bandfold(opts
|
470
|
+
# @!method bandfold(**opts)
|
471
471
|
# Fold up x axis into bands.
|
472
472
|
# @param opts [Hash] Set of options
|
473
473
|
# @option opts [Integer] :factor Fold by this factor
|
474
474
|
# @return [Vips::Image] Output image
|
475
475
|
|
476
|
-
# @!method bandunfold(opts
|
476
|
+
# @!method bandunfold(**opts)
|
477
477
|
# Unfold image bands into x axis.
|
478
478
|
# @param opts [Hash] Set of options
|
479
479
|
# @option opts [Integer] :factor Unfold by this factor
|
480
480
|
# @return [Vips::Image] Output image
|
481
481
|
|
482
|
-
# @!method flatten(opts
|
482
|
+
# @!method flatten(**opts)
|
483
483
|
# Flatten alpha out of an image.
|
484
484
|
# @param opts [Hash] Set of options
|
485
485
|
# @option opts [Array<Double>] :background Background value
|
486
486
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
487
487
|
# @return [Vips::Image] Output image
|
488
488
|
|
489
|
-
# @!method premultiply(opts
|
489
|
+
# @!method premultiply(**opts)
|
490
490
|
# Premultiply image alpha.
|
491
491
|
# @param opts [Hash] Set of options
|
492
492
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
493
493
|
# @return [Vips::Image] Output image
|
494
494
|
|
495
|
-
# @!method unpremultiply(opts
|
495
|
+
# @!method unpremultiply(**opts)
|
496
496
|
# Unpremultiply image alpha.
|
497
497
|
# @param opts [Hash] Set of options
|
498
498
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
499
499
|
# @return [Vips::Image] Output image
|
500
500
|
|
501
|
-
# @!method grid(tile_height, across, down, opts
|
501
|
+
# @!method grid(tile_height, across, down, **opts)
|
502
502
|
# Grid an image.
|
503
503
|
# @param tile_height [Integer] chop into tiles this high
|
504
504
|
# @param across [Integer] number of tiles across
|
@@ -506,27 +506,27 @@ module Vips
|
|
506
506
|
# @param opts [Hash] Set of options
|
507
507
|
# @return [Vips::Image] Output image
|
508
508
|
|
509
|
-
# @!method transpose3d(opts
|
509
|
+
# @!method transpose3d(**opts)
|
510
510
|
# Transpose3d an image.
|
511
511
|
# @param opts [Hash] Set of options
|
512
512
|
# @option opts [Integer] :page_height Height of each input page
|
513
513
|
# @return [Vips::Image] Output image
|
514
514
|
|
515
|
-
# @!method wrap(opts
|
515
|
+
# @!method wrap(**opts)
|
516
516
|
# Wrap image origin.
|
517
517
|
# @param opts [Hash] Set of options
|
518
518
|
# @option opts [Integer] :x Left edge of input in output
|
519
519
|
# @option opts [Integer] :y Top edge of input in output
|
520
520
|
# @return [Vips::Image] Output image
|
521
521
|
|
522
|
-
# @!method zoom(xfac, yfac, opts
|
522
|
+
# @!method zoom(xfac, yfac, **opts)
|
523
523
|
# Zoom an image.
|
524
524
|
# @param xfac [Integer] Horizontal zoom factor
|
525
525
|
# @param yfac [Integer] Vertical zoom factor
|
526
526
|
# @param opts [Hash] Set of options
|
527
527
|
# @return [Vips::Image] Output image
|
528
528
|
|
529
|
-
# @!method subsample(xfac, yfac, opts
|
529
|
+
# @!method subsample(xfac, yfac, **opts)
|
530
530
|
# Subsample an image.
|
531
531
|
# @param xfac [Integer] Horizontal subsample factor
|
532
532
|
# @param yfac [Integer] Vertical subsample factor
|
@@ -534,29 +534,29 @@ module Vips
|
|
534
534
|
# @option opts [Boolean] :point Point sample
|
535
535
|
# @return [Vips::Image] Output image
|
536
536
|
|
537
|
-
# @!method msb(opts
|
537
|
+
# @!method msb(**opts)
|
538
538
|
# Pick most-significant byte from an image.
|
539
539
|
# @param opts [Hash] Set of options
|
540
540
|
# @option opts [Integer] :band Band to msb
|
541
541
|
# @return [Vips::Image] Output image
|
542
542
|
|
543
|
-
# @!method byteswap(opts
|
543
|
+
# @!method byteswap(**opts)
|
544
544
|
# Byteswap an image.
|
545
545
|
# @param opts [Hash] Set of options
|
546
546
|
# @return [Vips::Image] Output image
|
547
547
|
|
548
|
-
# @!method falsecolour(opts
|
548
|
+
# @!method falsecolour(**opts)
|
549
549
|
# False-color an image.
|
550
550
|
# @param opts [Hash] Set of options
|
551
551
|
# @return [Vips::Image] Output image
|
552
552
|
|
553
|
-
# @!method gamma(opts
|
553
|
+
# @!method gamma(**opts)
|
554
554
|
# Gamma an image.
|
555
555
|
# @param opts [Hash] Set of options
|
556
556
|
# @option opts [Float] :exponent Gamma factor
|
557
557
|
# @return [Vips::Image] Output image
|
558
558
|
|
559
|
-
# @!method composite2(overlay, mode, opts
|
559
|
+
# @!method composite2(overlay, mode, **opts)
|
560
560
|
# Blend a pair of images with a blend mode.
|
561
561
|
# @param overlay [Vips::Image] Overlay image
|
562
562
|
# @param mode [Vips::BlendMode] VipsBlendMode to join with
|
@@ -567,7 +567,7 @@ module Vips
|
|
567
567
|
# @option opts [Boolean] :premultiplied Images have premultiplied alpha
|
568
568
|
# @return [Vips::Image] Output image
|
569
569
|
|
570
|
-
# @!method self.black(width, height, opts
|
570
|
+
# @!method self.black(width, height, **opts)
|
571
571
|
# Make a black image.
|
572
572
|
# @param width [Integer] Image width in pixels
|
573
573
|
# @param height [Integer] Image height in pixels
|
@@ -575,7 +575,7 @@ module Vips
|
|
575
575
|
# @option opts [Integer] :bands Number of bands in image
|
576
576
|
# @return [Vips::Image] Output image
|
577
577
|
|
578
|
-
# @!method self.gaussnoise(width, height, opts
|
578
|
+
# @!method self.gaussnoise(width, height, **opts)
|
579
579
|
# Make a gaussnoise image.
|
580
580
|
# @param width [Integer] Image width in pixels
|
581
581
|
# @param height [Integer] Image height in pixels
|
@@ -584,7 +584,7 @@ module Vips
|
|
584
584
|
# @option opts [Float] :mean Mean of pixels in generated image
|
585
585
|
# @return [Vips::Image] Output image
|
586
586
|
|
587
|
-
# @!method self.text(text, opts
|
587
|
+
# @!method self.text(text, **opts)
|
588
588
|
# Make a text image.
|
589
589
|
# @param text [String] Text to render
|
590
590
|
# @param opts [Hash] Set of options
|
@@ -598,7 +598,7 @@ module Vips
|
|
598
598
|
# @option opts [Integer] :autofit_dpi Output DPI selected by autofit
|
599
599
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
600
600
|
|
601
|
-
# @!method self.xyz(width, height, opts
|
601
|
+
# @!method self.xyz(width, height, **opts)
|
602
602
|
# Make an image where pixel values are coordinates.
|
603
603
|
# @param width [Integer] Image width in pixels
|
604
604
|
# @param height [Integer] Image height in pixels
|
@@ -608,7 +608,7 @@ module Vips
|
|
608
608
|
# @option opts [Integer] :esize Size of fifth dimension
|
609
609
|
# @return [Vips::Image] Output image
|
610
610
|
|
611
|
-
# @!method self.gaussmat(sigma, min_ampl, opts
|
611
|
+
# @!method self.gaussmat(sigma, min_ampl, **opts)
|
612
612
|
# Make a gaussian image.
|
613
613
|
# @param sigma [Float] Sigma of Gaussian
|
614
614
|
# @param min_ampl [Float] Minimum amplitude of Gaussian
|
@@ -617,7 +617,7 @@ module Vips
|
|
617
617
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
618
618
|
# @return [Vips::Image] Output image
|
619
619
|
|
620
|
-
# @!method self.logmat(sigma, min_ampl, opts
|
620
|
+
# @!method self.logmat(sigma, min_ampl, **opts)
|
621
621
|
# Make a laplacian of gaussian image.
|
622
622
|
# @param sigma [Float] Radius of Logmatian
|
623
623
|
# @param min_ampl [Float] Minimum amplitude of Logmatian
|
@@ -626,7 +626,7 @@ module Vips
|
|
626
626
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
627
627
|
# @return [Vips::Image] Output image
|
628
628
|
|
629
|
-
# @!method self.eye(width, height, opts
|
629
|
+
# @!method self.eye(width, height, **opts)
|
630
630
|
# Make an image showing the eye's spatial response.
|
631
631
|
# @param width [Integer] Image width in pixels
|
632
632
|
# @param height [Integer] Image height in pixels
|
@@ -635,7 +635,7 @@ module Vips
|
|
635
635
|
# @option opts [Float] :factor Maximum spatial frequency
|
636
636
|
# @return [Vips::Image] Output image
|
637
637
|
|
638
|
-
# @!method self.grey(width, height, opts
|
638
|
+
# @!method self.grey(width, height, **opts)
|
639
639
|
# Make a grey ramp image.
|
640
640
|
# @param width [Integer] Image width in pixels
|
641
641
|
# @param height [Integer] Image height in pixels
|
@@ -643,7 +643,7 @@ module Vips
|
|
643
643
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
644
644
|
# @return [Vips::Image] Output image
|
645
645
|
|
646
|
-
# @!method self.zone(width, height, opts
|
646
|
+
# @!method self.zone(width, height, **opts)
|
647
647
|
# Make a zone plate.
|
648
648
|
# @param width [Integer] Image width in pixels
|
649
649
|
# @param height [Integer] Image height in pixels
|
@@ -651,7 +651,7 @@ module Vips
|
|
651
651
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
652
652
|
# @return [Vips::Image] Output image
|
653
653
|
|
654
|
-
# @!method self.sines(width, height, opts
|
654
|
+
# @!method self.sines(width, height, **opts)
|
655
655
|
# Make a 2d sine wave.
|
656
656
|
# @param width [Integer] Image width in pixels
|
657
657
|
# @param height [Integer] Image height in pixels
|
@@ -661,7 +661,7 @@ module Vips
|
|
661
661
|
# @option opts [Float] :vfreq Vertical spatial frequency
|
662
662
|
# @return [Vips::Image] Output image
|
663
663
|
|
664
|
-
# @!method self.mask_ideal(width, height, frequency_cutoff, opts
|
664
|
+
# @!method self.mask_ideal(width, height, frequency_cutoff, **opts)
|
665
665
|
# Make an ideal filter.
|
666
666
|
# @param width [Integer] Image width in pixels
|
667
667
|
# @param height [Integer] Image height in pixels
|
@@ -673,7 +673,7 @@ module Vips
|
|
673
673
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
674
674
|
# @return [Vips::Image] Output image
|
675
675
|
|
676
|
-
# @!method self.mask_ideal_ring(width, height, frequency_cutoff, ringwidth, opts
|
676
|
+
# @!method self.mask_ideal_ring(width, height, frequency_cutoff, ringwidth, **opts)
|
677
677
|
# Make an ideal ring filter.
|
678
678
|
# @param width [Integer] Image width in pixels
|
679
679
|
# @param height [Integer] Image height in pixels
|
@@ -686,7 +686,7 @@ module Vips
|
|
686
686
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
687
687
|
# @return [Vips::Image] Output image
|
688
688
|
|
689
|
-
# @!method self.mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, opts
|
689
|
+
# @!method self.mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, **opts)
|
690
690
|
# Make an ideal band filter.
|
691
691
|
# @param width [Integer] Image width in pixels
|
692
692
|
# @param height [Integer] Image height in pixels
|
@@ -700,7 +700,7 @@ module Vips
|
|
700
700
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
701
701
|
# @return [Vips::Image] Output image
|
702
702
|
|
703
|
-
# @!method self.mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, opts
|
703
|
+
# @!method self.mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, **opts)
|
704
704
|
# Make a butterworth filter.
|
705
705
|
# @param width [Integer] Image width in pixels
|
706
706
|
# @param height [Integer] Image height in pixels
|
@@ -714,7 +714,7 @@ module Vips
|
|
714
714
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
715
715
|
# @return [Vips::Image] Output image
|
716
716
|
|
717
|
-
# @!method self.mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, opts
|
717
|
+
# @!method self.mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, **opts)
|
718
718
|
# Make a butterworth ring filter.
|
719
719
|
# @param width [Integer] Image width in pixels
|
720
720
|
# @param height [Integer] Image height in pixels
|
@@ -729,7 +729,7 @@ module Vips
|
|
729
729
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
730
730
|
# @return [Vips::Image] Output image
|
731
731
|
|
732
|
-
# @!method self.mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts
|
732
|
+
# @!method self.mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, **opts)
|
733
733
|
# Make a butterworth_band filter.
|
734
734
|
# @param width [Integer] Image width in pixels
|
735
735
|
# @param height [Integer] Image height in pixels
|
@@ -745,7 +745,7 @@ module Vips
|
|
745
745
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
746
746
|
# @return [Vips::Image] Output image
|
747
747
|
|
748
|
-
# @!method self.mask_gaussian(width, height, frequency_cutoff, amplitude_cutoff, opts
|
748
|
+
# @!method self.mask_gaussian(width, height, frequency_cutoff, amplitude_cutoff, **opts)
|
749
749
|
# Make a gaussian filter.
|
750
750
|
# @param width [Integer] Image width in pixels
|
751
751
|
# @param height [Integer] Image height in pixels
|
@@ -758,7 +758,7 @@ module Vips
|
|
758
758
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
759
759
|
# @return [Vips::Image] Output image
|
760
760
|
|
761
|
-
# @!method self.mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, opts
|
761
|
+
# @!method self.mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, **opts)
|
762
762
|
# Make a gaussian ring filter.
|
763
763
|
# @param width [Integer] Image width in pixels
|
764
764
|
# @param height [Integer] Image height in pixels
|
@@ -772,7 +772,7 @@ module Vips
|
|
772
772
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
773
773
|
# @return [Vips::Image] Output image
|
774
774
|
|
775
|
-
# @!method self.mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts
|
775
|
+
# @!method self.mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, **opts)
|
776
776
|
# Make a gaussian filter.
|
777
777
|
# @param width [Integer] Image width in pixels
|
778
778
|
# @param height [Integer] Image height in pixels
|
@@ -787,7 +787,7 @@ module Vips
|
|
787
787
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
788
788
|
# @return [Vips::Image] Output image
|
789
789
|
|
790
|
-
# @!method self.mask_fractal(width, height, fractal_dimension, opts
|
790
|
+
# @!method self.mask_fractal(width, height, fractal_dimension, **opts)
|
791
791
|
# Make fractal filter.
|
792
792
|
# @param width [Integer] Image width in pixels
|
793
793
|
# @param height [Integer] Image height in pixels
|
@@ -799,18 +799,18 @@ module Vips
|
|
799
799
|
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
800
800
|
# @return [Vips::Image] Output image
|
801
801
|
|
802
|
-
# @!method buildlut(opts
|
802
|
+
# @!method buildlut(**opts)
|
803
803
|
# Build a look-up table.
|
804
804
|
# @param opts [Hash] Set of options
|
805
805
|
# @return [Vips::Image] Output image
|
806
806
|
|
807
|
-
# @!method invertlut(opts
|
807
|
+
# @!method invertlut(**opts)
|
808
808
|
# Build an inverted look-up table.
|
809
809
|
# @param opts [Hash] Set of options
|
810
810
|
# @option opts [Integer] :size LUT size to generate
|
811
811
|
# @return [Vips::Image] Output image
|
812
812
|
|
813
|
-
# @!method self.tonelut(opts
|
813
|
+
# @!method self.tonelut(**opts)
|
814
814
|
# Build a look-up table.
|
815
815
|
# @param opts [Hash] Set of options
|
816
816
|
# @option opts [Integer] :in_max Size of LUT to build
|
@@ -825,7 +825,7 @@ module Vips
|
|
825
825
|
# @option opts [Float] :H Adjust highlights by this much
|
826
826
|
# @return [Vips::Image] Output image
|
827
827
|
|
828
|
-
# @!method self.identity(opts
|
828
|
+
# @!method self.identity(**opts)
|
829
829
|
# Make a 1d image where pixel values are indexes.
|
830
830
|
# @param opts [Hash] Set of options
|
831
831
|
# @option opts [Integer] :bands Number of bands in LUT
|
@@ -833,7 +833,7 @@ module Vips
|
|
833
833
|
# @option opts [Integer] :size Size of 16-bit LUT
|
834
834
|
# @return [Vips::Image] Output image
|
835
835
|
|
836
|
-
# @!method self.fractsurf(width, height, fractal_dimension, opts
|
836
|
+
# @!method self.fractsurf(width, height, fractal_dimension, **opts)
|
837
837
|
# Make a fractal surface.
|
838
838
|
# @param width [Integer] Image width in pixels
|
839
839
|
# @param height [Integer] Image height in pixels
|
@@ -841,7 +841,7 @@ module Vips
|
|
841
841
|
# @param opts [Hash] Set of options
|
842
842
|
# @return [Vips::Image] Output image
|
843
843
|
|
844
|
-
# @!method self.worley(width, height, opts
|
844
|
+
# @!method self.worley(width, height, **opts)
|
845
845
|
# Make a worley noise image.
|
846
846
|
# @param width [Integer] Image width in pixels
|
847
847
|
# @param height [Integer] Image height in pixels
|
@@ -849,7 +849,7 @@ module Vips
|
|
849
849
|
# @option opts [Integer] :cell_size Size of Worley cells
|
850
850
|
# @return [Vips::Image] Output image
|
851
851
|
|
852
|
-
# @!method self.perlin(width, height, opts
|
852
|
+
# @!method self.perlin(width, height, **opts)
|
853
853
|
# Make a perlin noise image.
|
854
854
|
# @param width [Integer] Image width in pixels
|
855
855
|
# @param height [Integer] Image height in pixels
|
@@ -858,7 +858,7 @@ module Vips
|
|
858
858
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
859
859
|
# @return [Vips::Image] Output image
|
860
860
|
|
861
|
-
# @!method self.csvload(filename, opts
|
861
|
+
# @!method self.csvload(filename, **opts)
|
862
862
|
# Load csv from file.
|
863
863
|
# @param filename [String] Filename to load from
|
864
864
|
# @param opts [Hash] Set of options
|
@@ -872,7 +872,7 @@ module Vips
|
|
872
872
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
873
873
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
874
874
|
|
875
|
-
# @!method self.matrixload(filename, opts
|
875
|
+
# @!method self.matrixload(filename, **opts)
|
876
876
|
# Load matrix from file.
|
877
877
|
# @param filename [String] Filename to load from
|
878
878
|
# @param opts [Hash] Set of options
|
@@ -882,7 +882,7 @@ module Vips
|
|
882
882
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
883
883
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
884
884
|
|
885
|
-
# @!method self.rawload(filename, width, height, bands, opts
|
885
|
+
# @!method self.rawload(filename, width, height, bands, **opts)
|
886
886
|
# Load raw data from a file.
|
887
887
|
# @param filename [String] Filename to load from
|
888
888
|
# @param width [Integer] Image width in pixels
|
@@ -896,7 +896,7 @@ module Vips
|
|
896
896
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
897
897
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
898
898
|
|
899
|
-
# @!method self.vipsload(filename, opts
|
899
|
+
# @!method self.vipsload(filename, **opts)
|
900
900
|
# Load vips from file.
|
901
901
|
# @param filename [String] Filename to load from
|
902
902
|
# @param opts [Hash] Set of options
|
@@ -906,7 +906,7 @@ module Vips
|
|
906
906
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
907
907
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
908
908
|
|
909
|
-
# @!method self.analyzeload(filename, opts
|
909
|
+
# @!method self.analyzeload(filename, **opts)
|
910
910
|
# Load an analyze6 image.
|
911
911
|
# @param filename [String] Filename to load from
|
912
912
|
# @param opts [Hash] Set of options
|
@@ -916,7 +916,7 @@ module Vips
|
|
916
916
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
917
917
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
918
918
|
|
919
|
-
# @!method self.ppmload(filename, opts
|
919
|
+
# @!method self.ppmload(filename, **opts)
|
920
920
|
# Load ppm from file.
|
921
921
|
# @param filename [String] Filename to load from
|
922
922
|
# @param opts [Hash] Set of options
|
@@ -926,7 +926,7 @@ module Vips
|
|
926
926
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
927
927
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
928
928
|
|
929
|
-
# @!method self.radload(filename, opts
|
929
|
+
# @!method self.radload(filename, **opts)
|
930
930
|
# Load a radiance image from a file.
|
931
931
|
# @param filename [String] Filename to load from
|
932
932
|
# @param opts [Hash] Set of options
|
@@ -936,7 +936,7 @@ module Vips
|
|
936
936
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
937
937
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
938
938
|
|
939
|
-
# @!method self.pdfload(filename, opts
|
939
|
+
# @!method self.pdfload(filename, **opts)
|
940
940
|
# Load pdf with libpoppler.
|
941
941
|
# @param filename [String] Filename to load from
|
942
942
|
# @param opts [Hash] Set of options
|
@@ -951,7 +951,7 @@ module Vips
|
|
951
951
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
952
952
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
953
953
|
|
954
|
-
# @!method self.pdfload_buffer(buffer, opts
|
954
|
+
# @!method self.pdfload_buffer(buffer, **opts)
|
955
955
|
# Load pdf with libpoppler.
|
956
956
|
# @param buffer [VipsBlob] Buffer to load from
|
957
957
|
# @param opts [Hash] Set of options
|
@@ -966,7 +966,7 @@ module Vips
|
|
966
966
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
967
967
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
968
968
|
|
969
|
-
# @!method self.svgload(filename, opts
|
969
|
+
# @!method self.svgload(filename, **opts)
|
970
970
|
# Load svg with rsvg.
|
971
971
|
# @param filename [String] Filename to load from
|
972
972
|
# @param opts [Hash] Set of options
|
@@ -978,7 +978,7 @@ module Vips
|
|
978
978
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
979
979
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
980
980
|
|
981
|
-
# @!method self.svgload(filename, opts
|
981
|
+
# @!method self.svgload(filename, **opts)
|
982
982
|
# Load svg with rsvg.
|
983
983
|
# @param filename [String] Filename to load from
|
984
984
|
# @param opts [Hash] Set of options
|
@@ -990,7 +990,7 @@ module Vips
|
|
990
990
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
991
991
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
992
992
|
|
993
|
-
# @!method self.svgload_buffer(buffer, opts
|
993
|
+
# @!method self.svgload_buffer(buffer, **opts)
|
994
994
|
# Load svg with rsvg.
|
995
995
|
# @param buffer [VipsBlob] Buffer to load from
|
996
996
|
# @param opts [Hash] Set of options
|
@@ -1002,7 +1002,7 @@ module Vips
|
|
1002
1002
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1003
1003
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1004
1004
|
|
1005
|
-
# @!method self.gifload(filename, opts
|
1005
|
+
# @!method self.gifload(filename, **opts)
|
1006
1006
|
# Load gif with giflib.
|
1007
1007
|
# @param filename [String] Filename to load from
|
1008
1008
|
# @param opts [Hash] Set of options
|
@@ -1014,7 +1014,7 @@ module Vips
|
|
1014
1014
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1015
1015
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1016
1016
|
|
1017
|
-
# @!method self.gifload_buffer(buffer, opts
|
1017
|
+
# @!method self.gifload_buffer(buffer, **opts)
|
1018
1018
|
# Load gif with giflib.
|
1019
1019
|
# @param buffer [VipsBlob] Buffer to load from
|
1020
1020
|
# @param opts [Hash] Set of options
|
@@ -1026,7 +1026,7 @@ module Vips
|
|
1026
1026
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1027
1027
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1028
1028
|
|
1029
|
-
# @!method self.pngload(filename, opts
|
1029
|
+
# @!method self.pngload(filename, **opts)
|
1030
1030
|
# Load png from file.
|
1031
1031
|
# @param filename [String] Filename to load from
|
1032
1032
|
# @param opts [Hash] Set of options
|
@@ -1036,7 +1036,7 @@ module Vips
|
|
1036
1036
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1037
1037
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1038
1038
|
|
1039
|
-
# @!method self.pngload_buffer(buffer, opts
|
1039
|
+
# @!method self.pngload_buffer(buffer, **opts)
|
1040
1040
|
# Load png from buffer.
|
1041
1041
|
# @param buffer [VipsBlob] Buffer to load from
|
1042
1042
|
# @param opts [Hash] Set of options
|
@@ -1046,7 +1046,7 @@ module Vips
|
|
1046
1046
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1047
1047
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1048
1048
|
|
1049
|
-
# @!method self.matload(filename, opts
|
1049
|
+
# @!method self.matload(filename, **opts)
|
1050
1050
|
# Load mat from file.
|
1051
1051
|
# @param filename [String] Filename to load from
|
1052
1052
|
# @param opts [Hash] Set of options
|
@@ -1056,7 +1056,7 @@ module Vips
|
|
1056
1056
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1057
1057
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1058
1058
|
|
1059
|
-
# @!method self.jpegload(filename, opts
|
1059
|
+
# @!method self.jpegload(filename, **opts)
|
1060
1060
|
# Load jpeg from file.
|
1061
1061
|
# @param filename [String] Filename to load from
|
1062
1062
|
# @param opts [Hash] Set of options
|
@@ -1068,7 +1068,7 @@ module Vips
|
|
1068
1068
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1069
1069
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1070
1070
|
|
1071
|
-
# @!method self.jpegload_buffer(buffer, opts
|
1071
|
+
# @!method self.jpegload_buffer(buffer, **opts)
|
1072
1072
|
# Load jpeg from buffer.
|
1073
1073
|
# @param buffer [VipsBlob] Buffer to load from
|
1074
1074
|
# @param opts [Hash] Set of options
|
@@ -1080,7 +1080,7 @@ module Vips
|
|
1080
1080
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1081
1081
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1082
1082
|
|
1083
|
-
# @!method self.webpload(filename, opts
|
1083
|
+
# @!method self.webpload(filename, **opts)
|
1084
1084
|
# Load webp from file.
|
1085
1085
|
# @param filename [String] Filename to load from
|
1086
1086
|
# @param opts [Hash] Set of options
|
@@ -1091,7 +1091,7 @@ module Vips
|
|
1091
1091
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1092
1092
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1093
1093
|
|
1094
|
-
# @!method self.webpload_buffer(buffer, opts
|
1094
|
+
# @!method self.webpload_buffer(buffer, **opts)
|
1095
1095
|
# Load webp from buffer.
|
1096
1096
|
# @param buffer [VipsBlob] Buffer to load from
|
1097
1097
|
# @param opts [Hash] Set of options
|
@@ -1102,7 +1102,7 @@ module Vips
|
|
1102
1102
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1103
1103
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1104
1104
|
|
1105
|
-
# @!method self.tiffload(filename, opts
|
1105
|
+
# @!method self.tiffload(filename, **opts)
|
1106
1106
|
# Load tiff from file.
|
1107
1107
|
# @param filename [String] Filename to load from
|
1108
1108
|
# @param opts [Hash] Set of options
|
@@ -1115,7 +1115,7 @@ module Vips
|
|
1115
1115
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1116
1116
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1117
1117
|
|
1118
|
-
# @!method self.tiffload_buffer(buffer, opts
|
1118
|
+
# @!method self.tiffload_buffer(buffer, **opts)
|
1119
1119
|
# Load tiff from buffer.
|
1120
1120
|
# @param buffer [VipsBlob] Buffer to load from
|
1121
1121
|
# @param opts [Hash] Set of options
|
@@ -1128,7 +1128,7 @@ module Vips
|
|
1128
1128
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1129
1129
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1130
1130
|
|
1131
|
-
# @!method self.openslideload(filename, opts
|
1131
|
+
# @!method self.openslideload(filename, **opts)
|
1132
1132
|
# Load file with openslide.
|
1133
1133
|
# @param filename [String] Filename to load from
|
1134
1134
|
# @param opts [Hash] Set of options
|
@@ -1141,7 +1141,7 @@ module Vips
|
|
1141
1141
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1142
1142
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1143
1143
|
|
1144
|
-
# @!method self.magickload(filename, opts
|
1144
|
+
# @!method self.magickload(filename, **opts)
|
1145
1145
|
# Load file with imagemagick.
|
1146
1146
|
# @param filename [String] Filename to load from
|
1147
1147
|
# @param opts [Hash] Set of options
|
@@ -1154,7 +1154,7 @@ module Vips
|
|
1154
1154
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1155
1155
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1156
1156
|
|
1157
|
-
# @!method self.magickload_buffer(buffer, opts
|
1157
|
+
# @!method self.magickload_buffer(buffer, **opts)
|
1158
1158
|
# Load buffer with imagemagick.
|
1159
1159
|
# @param buffer [VipsBlob] Buffer to load from
|
1160
1160
|
# @param opts [Hash] Set of options
|
@@ -1167,7 +1167,7 @@ module Vips
|
|
1167
1167
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1168
1168
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1169
1169
|
|
1170
|
-
# @!method self.fitsload(filename, opts
|
1170
|
+
# @!method self.fitsload(filename, **opts)
|
1171
1171
|
# Load a fits image.
|
1172
1172
|
# @param filename [String] Filename to load from
|
1173
1173
|
# @param opts [Hash] Set of options
|
@@ -1177,7 +1177,7 @@ module Vips
|
|
1177
1177
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1178
1178
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1179
1179
|
|
1180
|
-
# @!method self.openexrload(filename, opts
|
1180
|
+
# @!method self.openexrload(filename, **opts)
|
1181
1181
|
# Load an openexr image.
|
1182
1182
|
# @param filename [String] Filename to load from
|
1183
1183
|
# @param opts [Hash] Set of options
|
@@ -1187,7 +1187,7 @@ module Vips
|
|
1187
1187
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1188
1188
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1189
1189
|
|
1190
|
-
# @!method self.niftiload(filename, opts
|
1190
|
+
# @!method self.niftiload(filename, **opts)
|
1191
1191
|
# Load a nifti image.
|
1192
1192
|
# @param filename [String] Filename to load from
|
1193
1193
|
# @param opts [Hash] Set of options
|
@@ -1197,7 +1197,7 @@ module Vips
|
|
1197
1197
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1198
1198
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1199
1199
|
|
1200
|
-
# @!method csvsave(filename, opts
|
1200
|
+
# @!method csvsave(filename, **opts)
|
1201
1201
|
# Save image to csv file.
|
1202
1202
|
# @param filename [String] Filename to save to
|
1203
1203
|
# @param opts [Hash] Set of options
|
@@ -1207,7 +1207,7 @@ module Vips
|
|
1207
1207
|
# @option opts [Array<Double>] :background Background value
|
1208
1208
|
# @return [nil]
|
1209
1209
|
|
1210
|
-
# @!method matrixsave(filename, opts
|
1210
|
+
# @!method matrixsave(filename, **opts)
|
1211
1211
|
# Save image to matrix file.
|
1212
1212
|
# @param filename [String] Filename to save to
|
1213
1213
|
# @param opts [Hash] Set of options
|
@@ -1216,7 +1216,7 @@ module Vips
|
|
1216
1216
|
# @option opts [Array<Double>] :background Background value
|
1217
1217
|
# @return [nil]
|
1218
1218
|
|
1219
|
-
# @!method matrixprint(opts
|
1219
|
+
# @!method matrixprint(**opts)
|
1220
1220
|
# Print matrix.
|
1221
1221
|
# @param opts [Hash] Set of options
|
1222
1222
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1224,7 +1224,7 @@ module Vips
|
|
1224
1224
|
# @option opts [Array<Double>] :background Background value
|
1225
1225
|
# @return [nil]
|
1226
1226
|
|
1227
|
-
# @!method rawsave(filename, opts
|
1227
|
+
# @!method rawsave(filename, **opts)
|
1228
1228
|
# Save image to raw file.
|
1229
1229
|
# @param filename [String] Filename to save to
|
1230
1230
|
# @param opts [Hash] Set of options
|
@@ -1233,7 +1233,7 @@ module Vips
|
|
1233
1233
|
# @option opts [Array<Double>] :background Background value
|
1234
1234
|
# @return [nil]
|
1235
1235
|
|
1236
|
-
# @!method rawsave_fd(fd, opts
|
1236
|
+
# @!method rawsave_fd(fd, **opts)
|
1237
1237
|
# Write raw image to file descriptor.
|
1238
1238
|
# @param fd [Integer] File descriptor to write to
|
1239
1239
|
# @param opts [Hash] Set of options
|
@@ -1242,7 +1242,7 @@ module Vips
|
|
1242
1242
|
# @option opts [Array<Double>] :background Background value
|
1243
1243
|
# @return [nil]
|
1244
1244
|
|
1245
|
-
# @!method vipssave(filename, opts
|
1245
|
+
# @!method vipssave(filename, **opts)
|
1246
1246
|
# Save image to vips file.
|
1247
1247
|
# @param filename [String] Filename to save to
|
1248
1248
|
# @param opts [Hash] Set of options
|
@@ -1251,7 +1251,7 @@ module Vips
|
|
1251
1251
|
# @option opts [Array<Double>] :background Background value
|
1252
1252
|
# @return [nil]
|
1253
1253
|
|
1254
|
-
# @!method ppmsave(filename, opts
|
1254
|
+
# @!method ppmsave(filename, **opts)
|
1255
1255
|
# Save image to ppm file.
|
1256
1256
|
# @param filename [String] Filename to save to
|
1257
1257
|
# @param opts [Hash] Set of options
|
@@ -1262,7 +1262,7 @@ module Vips
|
|
1262
1262
|
# @option opts [Array<Double>] :background Background value
|
1263
1263
|
# @return [nil]
|
1264
1264
|
|
1265
|
-
# @!method radsave(filename, opts
|
1265
|
+
# @!method radsave(filename, **opts)
|
1266
1266
|
# Save image to radiance file.
|
1267
1267
|
# @param filename [String] Filename to save to
|
1268
1268
|
# @param opts [Hash] Set of options
|
@@ -1271,7 +1271,7 @@ module Vips
|
|
1271
1271
|
# @option opts [Array<Double>] :background Background value
|
1272
1272
|
# @return [nil]
|
1273
1273
|
|
1274
|
-
# @!method radsave_buffer(opts
|
1274
|
+
# @!method radsave_buffer(**opts)
|
1275
1275
|
# Save image to radiance buffer.
|
1276
1276
|
# @param opts [Hash] Set of options
|
1277
1277
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1279,7 +1279,7 @@ module Vips
|
|
1279
1279
|
# @option opts [Array<Double>] :background Background value
|
1280
1280
|
# @return [VipsBlob] Buffer to save to
|
1281
1281
|
|
1282
|
-
# @!method dzsave(filename, opts
|
1282
|
+
# @!method dzsave(filename, **opts)
|
1283
1283
|
# Save image to deepzoom file.
|
1284
1284
|
# @param filename [String] Filename to save to
|
1285
1285
|
# @param opts [Hash] Set of options
|
@@ -1300,7 +1300,7 @@ module Vips
|
|
1300
1300
|
# @option opts [Array<Double>] :background Background value
|
1301
1301
|
# @return [nil]
|
1302
1302
|
|
1303
|
-
# @!method dzsave_buffer(opts
|
1303
|
+
# @!method dzsave_buffer(**opts)
|
1304
1304
|
# Save image to dz buffer.
|
1305
1305
|
# @param opts [Hash] Set of options
|
1306
1306
|
# @option opts [String] :basename Base name to save to
|
@@ -1320,7 +1320,7 @@ module Vips
|
|
1320
1320
|
# @option opts [Array<Double>] :background Background value
|
1321
1321
|
# @return [VipsBlob] Buffer to save to
|
1322
1322
|
|
1323
|
-
# @!method pngsave(filename, opts
|
1323
|
+
# @!method pngsave(filename, **opts)
|
1324
1324
|
# Save image to png file.
|
1325
1325
|
# @param filename [String] Filename to save to
|
1326
1326
|
# @param opts [Hash] Set of options
|
@@ -1337,7 +1337,7 @@ module Vips
|
|
1337
1337
|
# @option opts [Array<Double>] :background Background value
|
1338
1338
|
# @return [nil]
|
1339
1339
|
|
1340
|
-
# @!method pngsave_buffer(opts
|
1340
|
+
# @!method pngsave_buffer(**opts)
|
1341
1341
|
# Save image to png buffer.
|
1342
1342
|
# @param opts [Hash] Set of options
|
1343
1343
|
# @option opts [Integer] :compression Compression factor
|
@@ -1353,7 +1353,7 @@ module Vips
|
|
1353
1353
|
# @option opts [Array<Double>] :background Background value
|
1354
1354
|
# @return [VipsBlob] Buffer to save to
|
1355
1355
|
|
1356
|
-
# @!method jpegsave(filename, opts
|
1356
|
+
# @!method jpegsave(filename, **opts)
|
1357
1357
|
# Save image to jpeg file.
|
1358
1358
|
# @param filename [String] Filename to save to
|
1359
1359
|
# @param opts [Hash] Set of options
|
@@ -1371,7 +1371,7 @@ module Vips
|
|
1371
1371
|
# @option opts [Array<Double>] :background Background value
|
1372
1372
|
# @return [nil]
|
1373
1373
|
|
1374
|
-
# @!method jpegsave_buffer(opts
|
1374
|
+
# @!method jpegsave_buffer(**opts)
|
1375
1375
|
# Save image to jpeg buffer.
|
1376
1376
|
# @param opts [Hash] Set of options
|
1377
1377
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1388,7 +1388,7 @@ module Vips
|
|
1388
1388
|
# @option opts [Array<Double>] :background Background value
|
1389
1389
|
# @return [VipsBlob] Buffer to save to
|
1390
1390
|
|
1391
|
-
# @!method jpegsave_mime(opts
|
1391
|
+
# @!method jpegsave_mime(**opts)
|
1392
1392
|
# Save image to jpeg mime.
|
1393
1393
|
# @param opts [Hash] Set of options
|
1394
1394
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1405,7 +1405,7 @@ module Vips
|
|
1405
1405
|
# @option opts [Array<Double>] :background Background value
|
1406
1406
|
# @return [nil]
|
1407
1407
|
|
1408
|
-
# @!method webpsave(filename, opts
|
1408
|
+
# @!method webpsave(filename, **opts)
|
1409
1409
|
# Save image to webp file.
|
1410
1410
|
# @param filename [String] Filename to save to
|
1411
1411
|
# @param opts [Hash] Set of options
|
@@ -1420,7 +1420,7 @@ module Vips
|
|
1420
1420
|
# @option opts [Array<Double>] :background Background value
|
1421
1421
|
# @return [nil]
|
1422
1422
|
|
1423
|
-
# @!method webpsave_buffer(opts
|
1423
|
+
# @!method webpsave_buffer(**opts)
|
1424
1424
|
# Save image to webp buffer.
|
1425
1425
|
# @param opts [Hash] Set of options
|
1426
1426
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1434,7 +1434,7 @@ module Vips
|
|
1434
1434
|
# @option opts [Array<Double>] :background Background value
|
1435
1435
|
# @return [VipsBlob] Buffer to save to
|
1436
1436
|
|
1437
|
-
# @!method tiffsave(filename, opts
|
1437
|
+
# @!method tiffsave(filename, **opts)
|
1438
1438
|
# Save image to tiff file.
|
1439
1439
|
# @param filename [String] Filename to save to
|
1440
1440
|
# @param opts [Hash] Set of options
|
@@ -1459,7 +1459,7 @@ module Vips
|
|
1459
1459
|
# @option opts [Array<Double>] :background Background value
|
1460
1460
|
# @return [nil]
|
1461
1461
|
|
1462
|
-
# @!method tiffsave_buffer(opts
|
1462
|
+
# @!method tiffsave_buffer(**opts)
|
1463
1463
|
# Save image to tiff buffer.
|
1464
1464
|
# @param opts [Hash] Set of options
|
1465
1465
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
@@ -1483,7 +1483,7 @@ module Vips
|
|
1483
1483
|
# @option opts [Array<Double>] :background Background value
|
1484
1484
|
# @return [VipsBlob] Buffer to save to
|
1485
1485
|
|
1486
|
-
# @!method magicksave(filename, opts
|
1486
|
+
# @!method magicksave(filename, **opts)
|
1487
1487
|
# Save file with imagemagick.
|
1488
1488
|
# @param filename [String] Filename to save to
|
1489
1489
|
# @param opts [Hash] Set of options
|
@@ -1494,7 +1494,7 @@ module Vips
|
|
1494
1494
|
# @option opts [Array<Double>] :background Background value
|
1495
1495
|
# @return [nil]
|
1496
1496
|
|
1497
|
-
# @!method magicksave_buffer(opts
|
1497
|
+
# @!method magicksave_buffer(**opts)
|
1498
1498
|
# Save image to magick buffer.
|
1499
1499
|
# @param opts [Hash] Set of options
|
1500
1500
|
# @option opts [String] :format Format to save in
|
@@ -1504,7 +1504,7 @@ module Vips
|
|
1504
1504
|
# @option opts [Array<Double>] :background Background value
|
1505
1505
|
# @return [VipsBlob] Buffer to save to
|
1506
1506
|
|
1507
|
-
# @!method fitssave(filename, opts
|
1507
|
+
# @!method fitssave(filename, **opts)
|
1508
1508
|
# Save image to fits file.
|
1509
1509
|
# @param filename [String] Filename to save to
|
1510
1510
|
# @param opts [Hash] Set of options
|
@@ -1513,7 +1513,7 @@ module Vips
|
|
1513
1513
|
# @option opts [Array<Double>] :background Background value
|
1514
1514
|
# @return [nil]
|
1515
1515
|
|
1516
|
-
# @!method niftisave(filename, opts
|
1516
|
+
# @!method niftisave(filename, **opts)
|
1517
1517
|
# Save image to nifti file.
|
1518
1518
|
# @param filename [String] Filename to save to
|
1519
1519
|
# @param opts [Hash] Set of options
|
@@ -1522,7 +1522,7 @@ module Vips
|
|
1522
1522
|
# @option opts [Array<Double>] :background Background value
|
1523
1523
|
# @return [nil]
|
1524
1524
|
|
1525
|
-
# @!method self.thumbnail(filename, width, opts
|
1525
|
+
# @!method self.thumbnail(filename, width, **opts)
|
1526
1526
|
# Generate thumbnail from file.
|
1527
1527
|
# @param filename [String] Filename to read from
|
1528
1528
|
# @param width [Integer] Size to this width
|
@@ -1537,7 +1537,7 @@ module Vips
|
|
1537
1537
|
# @option opts [Vips::Intent] :intent Rendering intent
|
1538
1538
|
# @return [Vips::Image] Output image
|
1539
1539
|
|
1540
|
-
# @!method self.thumbnail_buffer(buffer, width, opts
|
1540
|
+
# @!method self.thumbnail_buffer(buffer, width, **opts)
|
1541
1541
|
# Generate thumbnail from buffer.
|
1542
1542
|
# @param buffer [VipsBlob] Buffer to load from
|
1543
1543
|
# @param width [Integer] Size to this width
|
@@ -1552,7 +1552,7 @@ module Vips
|
|
1552
1552
|
# @option opts [Vips::Intent] :intent Rendering intent
|
1553
1553
|
# @return [Vips::Image] Output image
|
1554
1554
|
|
1555
|
-
# @!method thumbnail_image(width, opts
|
1555
|
+
# @!method thumbnail_image(width, **opts)
|
1556
1556
|
# Generate thumbnail from image.
|
1557
1557
|
# @param width [Integer] Size to this width
|
1558
1558
|
# @param opts [Hash] Set of options
|
@@ -1566,33 +1566,33 @@ module Vips
|
|
1566
1566
|
# @option opts [Vips::Intent] :intent Rendering intent
|
1567
1567
|
# @return [Vips::Image] Output image
|
1568
1568
|
|
1569
|
-
# @!method mapim(index, opts
|
1569
|
+
# @!method mapim(index, **opts)
|
1570
1570
|
# Resample with an mapim image.
|
1571
1571
|
# @param index [Vips::Image] Index pixels with this
|
1572
1572
|
# @param opts [Hash] Set of options
|
1573
1573
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
1574
1574
|
# @return [Vips::Image] Output image
|
1575
1575
|
|
1576
|
-
# @!method shrink(hshrink, vshrink, opts
|
1576
|
+
# @!method shrink(hshrink, vshrink, **opts)
|
1577
1577
|
# Shrink an image.
|
1578
1578
|
# @param hshrink [Float] Horizontal shrink factor
|
1579
1579
|
# @param vshrink [Float] Vertical shrink factor
|
1580
1580
|
# @param opts [Hash] Set of options
|
1581
1581
|
# @return [Vips::Image] Output image
|
1582
1582
|
|
1583
|
-
# @!method shrinkh(hshrink, opts
|
1583
|
+
# @!method shrinkh(hshrink, **opts)
|
1584
1584
|
# Shrink an image horizontally.
|
1585
1585
|
# @param hshrink [Integer] Horizontal shrink factor
|
1586
1586
|
# @param opts [Hash] Set of options
|
1587
1587
|
# @return [Vips::Image] Output image
|
1588
1588
|
|
1589
|
-
# @!method shrinkv(vshrink, opts
|
1589
|
+
# @!method shrinkv(vshrink, **opts)
|
1590
1590
|
# Shrink an image vertically.
|
1591
1591
|
# @param vshrink [Integer] Vertical shrink factor
|
1592
1592
|
# @param opts [Hash] Set of options
|
1593
1593
|
# @return [Vips::Image] Output image
|
1594
1594
|
|
1595
|
-
# @!method reduceh(hshrink, opts
|
1595
|
+
# @!method reduceh(hshrink, **opts)
|
1596
1596
|
# Shrink an image horizontally.
|
1597
1597
|
# @param hshrink [Float] Horizontal shrink factor
|
1598
1598
|
# @param opts [Hash] Set of options
|
@@ -1600,7 +1600,7 @@ module Vips
|
|
1600
1600
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1601
1601
|
# @return [Vips::Image] Output image
|
1602
1602
|
|
1603
|
-
# @!method reducev(vshrink, opts
|
1603
|
+
# @!method reducev(vshrink, **opts)
|
1604
1604
|
# Shrink an image vertically.
|
1605
1605
|
# @param vshrink [Float] Vertical shrink factor
|
1606
1606
|
# @param opts [Hash] Set of options
|
@@ -1608,7 +1608,7 @@ module Vips
|
|
1608
1608
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1609
1609
|
# @return [Vips::Image] Output image
|
1610
1610
|
|
1611
|
-
# @!method reduce(hshrink, vshrink, opts
|
1611
|
+
# @!method reduce(hshrink, vshrink, **opts)
|
1612
1612
|
# Reduce an image.
|
1613
1613
|
# @param hshrink [Float] Horizontal shrink factor
|
1614
1614
|
# @param vshrink [Float] Vertical shrink factor
|
@@ -1617,14 +1617,14 @@ module Vips
|
|
1617
1617
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1618
1618
|
# @return [Vips::Image] Output image
|
1619
1619
|
|
1620
|
-
# @!method quadratic(coeff, opts
|
1620
|
+
# @!method quadratic(coeff, **opts)
|
1621
1621
|
# Resample an image with a quadratic transform.
|
1622
1622
|
# @param coeff [Vips::Image] Coefficient matrix
|
1623
1623
|
# @param opts [Hash] Set of options
|
1624
1624
|
# @option opts [Vips::Interpolate] :interpolate Interpolate values with this
|
1625
1625
|
# @return [Vips::Image] Output image
|
1626
1626
|
|
1627
|
-
# @!method affine(matrix, opts
|
1627
|
+
# @!method affine(matrix, **opts)
|
1628
1628
|
# Affine transform of an image.
|
1629
1629
|
# @param matrix [Array<Double>] Transformation matrix
|
1630
1630
|
# @param opts [Hash] Set of options
|
@@ -1638,7 +1638,7 @@ module Vips
|
|
1638
1638
|
# @option opts [Vips::Extend] :extend How to generate the extra pixels
|
1639
1639
|
# @return [Vips::Image] Output image
|
1640
1640
|
|
1641
|
-
# @!method similarity(opts
|
1641
|
+
# @!method similarity(**opts)
|
1642
1642
|
# Similarity transform of an image.
|
1643
1643
|
# @param opts [Hash] Set of options
|
1644
1644
|
# @option opts [Float] :scale Scale by this factor
|
@@ -1651,7 +1651,7 @@ module Vips
|
|
1651
1651
|
# @option opts [Float] :idy Vertical input displacement
|
1652
1652
|
# @return [Vips::Image] Output image
|
1653
1653
|
|
1654
|
-
# @!method rotate(angle, opts
|
1654
|
+
# @!method rotate(angle, **opts)
|
1655
1655
|
# Rotate an image by a number of degrees.
|
1656
1656
|
# @param angle [Float] Rotate anticlockwise by this many degrees
|
1657
1657
|
# @param opts [Hash] Set of options
|
@@ -1663,7 +1663,7 @@ module Vips
|
|
1663
1663
|
# @option opts [Float] :idy Vertical input displacement
|
1664
1664
|
# @return [Vips::Image] Output image
|
1665
1665
|
|
1666
|
-
# @!method resize(scale, opts
|
1666
|
+
# @!method resize(scale, **opts)
|
1667
1667
|
# Resize an image.
|
1668
1668
|
# @param scale [Float] Scale image by this factor
|
1669
1669
|
# @param opts [Hash] Set of options
|
@@ -1671,121 +1671,121 @@ module Vips
|
|
1671
1671
|
# @option opts [Float] :vscale Vertical scale image by this factor
|
1672
1672
|
# @return [Vips::Image] Output image
|
1673
1673
|
|
1674
|
-
# @!method colourspace(space, opts
|
1674
|
+
# @!method colourspace(space, **opts)
|
1675
1675
|
# Convert to a new colorspace.
|
1676
1676
|
# @param space [Vips::Interpretation] Destination color space
|
1677
1677
|
# @param opts [Hash] Set of options
|
1678
1678
|
# @option opts [Vips::Interpretation] :source_space Source color space
|
1679
1679
|
# @return [Vips::Image] Output image
|
1680
1680
|
|
1681
|
-
# @!method Lab2XYZ(opts
|
1681
|
+
# @!method Lab2XYZ(**opts)
|
1682
1682
|
# Transform cielab to xyz.
|
1683
1683
|
# @param opts [Hash] Set of options
|
1684
1684
|
# @option opts [Array<Double>] :temp Color temperature
|
1685
1685
|
# @return [Vips::Image] Output image
|
1686
1686
|
|
1687
|
-
# @!method XYZ2Lab(opts
|
1687
|
+
# @!method XYZ2Lab(**opts)
|
1688
1688
|
# Transform xyz to lab.
|
1689
1689
|
# @param opts [Hash] Set of options
|
1690
1690
|
# @option opts [Array<Double>] :temp Colour temperature
|
1691
1691
|
# @return [Vips::Image] Output image
|
1692
1692
|
|
1693
|
-
# @!method Lab2LCh(opts
|
1693
|
+
# @!method Lab2LCh(**opts)
|
1694
1694
|
# Transform lab to lch.
|
1695
1695
|
# @param opts [Hash] Set of options
|
1696
1696
|
# @return [Vips::Image] Output image
|
1697
1697
|
|
1698
|
-
# @!method LCh2Lab(opts
|
1698
|
+
# @!method LCh2Lab(**opts)
|
1699
1699
|
# Transform lch to lab.
|
1700
1700
|
# @param opts [Hash] Set of options
|
1701
1701
|
# @return [Vips::Image] Output image
|
1702
1702
|
|
1703
|
-
# @!method LCh2CMC(opts
|
1703
|
+
# @!method LCh2CMC(**opts)
|
1704
1704
|
# Transform lch to cmc.
|
1705
1705
|
# @param opts [Hash] Set of options
|
1706
1706
|
# @return [Vips::Image] Output image
|
1707
1707
|
|
1708
|
-
# @!method CMC2LCh(opts
|
1708
|
+
# @!method CMC2LCh(**opts)
|
1709
1709
|
# Transform lch to cmc.
|
1710
1710
|
# @param opts [Hash] Set of options
|
1711
1711
|
# @return [Vips::Image] Output image
|
1712
1712
|
|
1713
|
-
# @!method XYZ2Yxy(opts
|
1713
|
+
# @!method XYZ2Yxy(**opts)
|
1714
1714
|
# Transform xyz to yxy.
|
1715
1715
|
# @param opts [Hash] Set of options
|
1716
1716
|
# @return [Vips::Image] Output image
|
1717
1717
|
|
1718
|
-
# @!method Yxy2XYZ(opts
|
1718
|
+
# @!method Yxy2XYZ(**opts)
|
1719
1719
|
# Transform yxy to xyz.
|
1720
1720
|
# @param opts [Hash] Set of options
|
1721
1721
|
# @return [Vips::Image] Output image
|
1722
1722
|
|
1723
|
-
# @!method scRGB2XYZ(opts
|
1723
|
+
# @!method scRGB2XYZ(**opts)
|
1724
1724
|
# Transform scrgb to xyz.
|
1725
1725
|
# @param opts [Hash] Set of options
|
1726
1726
|
# @return [Vips::Image] Output image
|
1727
1727
|
|
1728
|
-
# @!method XYZ2scRGB(opts
|
1728
|
+
# @!method XYZ2scRGB(**opts)
|
1729
1729
|
# Transform xyz to scrgb.
|
1730
1730
|
# @param opts [Hash] Set of options
|
1731
1731
|
# @return [Vips::Image] Output image
|
1732
1732
|
|
1733
|
-
# @!method LabQ2Lab(opts
|
1733
|
+
# @!method LabQ2Lab(**opts)
|
1734
1734
|
# Unpack a labq image to float lab.
|
1735
1735
|
# @param opts [Hash] Set of options
|
1736
1736
|
# @return [Vips::Image] Output image
|
1737
1737
|
|
1738
|
-
# @!method Lab2LabQ(opts
|
1738
|
+
# @!method Lab2LabQ(**opts)
|
1739
1739
|
# Transform float lab to labq coding.
|
1740
1740
|
# @param opts [Hash] Set of options
|
1741
1741
|
# @return [Vips::Image] Output image
|
1742
1742
|
|
1743
|
-
# @!method LabQ2LabS(opts
|
1743
|
+
# @!method LabQ2LabS(**opts)
|
1744
1744
|
# Unpack a labq image to short lab.
|
1745
1745
|
# @param opts [Hash] Set of options
|
1746
1746
|
# @return [Vips::Image] Output image
|
1747
1747
|
|
1748
|
-
# @!method LabS2LabQ(opts
|
1748
|
+
# @!method LabS2LabQ(**opts)
|
1749
1749
|
# Transform short lab to labq coding.
|
1750
1750
|
# @param opts [Hash] Set of options
|
1751
1751
|
# @return [Vips::Image] Output image
|
1752
1752
|
|
1753
|
-
# @!method LabS2Lab(opts
|
1753
|
+
# @!method LabS2Lab(**opts)
|
1754
1754
|
# Transform signed short lab to float.
|
1755
1755
|
# @param opts [Hash] Set of options
|
1756
1756
|
# @return [Vips::Image] Output image
|
1757
1757
|
|
1758
|
-
# @!method Lab2LabS(opts
|
1758
|
+
# @!method Lab2LabS(**opts)
|
1759
1759
|
# Transform float lab to signed short.
|
1760
1760
|
# @param opts [Hash] Set of options
|
1761
1761
|
# @return [Vips::Image] Output image
|
1762
1762
|
|
1763
|
-
# @!method rad2float(opts
|
1763
|
+
# @!method rad2float(**opts)
|
1764
1764
|
# Unpack radiance coding to float rgb.
|
1765
1765
|
# @param opts [Hash] Set of options
|
1766
1766
|
# @return [Vips::Image] Output image
|
1767
1767
|
|
1768
|
-
# @!method float2rad(opts
|
1768
|
+
# @!method float2rad(**opts)
|
1769
1769
|
# Transform float rgb to radiance coding.
|
1770
1770
|
# @param opts [Hash] Set of options
|
1771
1771
|
# @return [Vips::Image] Output image
|
1772
1772
|
|
1773
|
-
# @!method LabQ2sRGB(opts
|
1773
|
+
# @!method LabQ2sRGB(**opts)
|
1774
1774
|
# Convert a labq image to srgb.
|
1775
1775
|
# @param opts [Hash] Set of options
|
1776
1776
|
# @return [Vips::Image] Output image
|
1777
1777
|
|
1778
|
-
# @!method sRGB2HSV(opts
|
1778
|
+
# @!method sRGB2HSV(**opts)
|
1779
1779
|
# Transform srgb to hsv.
|
1780
1780
|
# @param opts [Hash] Set of options
|
1781
1781
|
# @return [Vips::Image] Output image
|
1782
1782
|
|
1783
|
-
# @!method HSV2sRGB(opts
|
1783
|
+
# @!method HSV2sRGB(**opts)
|
1784
1784
|
# Transform hsv to srgb.
|
1785
1785
|
# @param opts [Hash] Set of options
|
1786
1786
|
# @return [Vips::Image] Output image
|
1787
1787
|
|
1788
|
-
# @!method icc_import(opts
|
1788
|
+
# @!method icc_import(**opts)
|
1789
1789
|
# Import from device with icc profile.
|
1790
1790
|
# @param opts [Hash] Set of options
|
1791
1791
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
@@ -1794,7 +1794,7 @@ module Vips
|
|
1794
1794
|
# @option opts [String] :input_profile Filename to load input profile from
|
1795
1795
|
# @return [Vips::Image] Output image
|
1796
1796
|
|
1797
|
-
# @!method icc_export(opts
|
1797
|
+
# @!method icc_export(**opts)
|
1798
1798
|
# Output to device with icc profile.
|
1799
1799
|
# @param opts [Hash] Set of options
|
1800
1800
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
@@ -1803,7 +1803,7 @@ module Vips
|
|
1803
1803
|
# @option opts [Integer] :depth Output device space depth in bits
|
1804
1804
|
# @return [Vips::Image] Output image
|
1805
1805
|
|
1806
|
-
# @!method icc_transform(output_profile, opts
|
1806
|
+
# @!method icc_transform(output_profile, **opts)
|
1807
1807
|
# Transform between devices with icc profiles.
|
1808
1808
|
# @param output_profile [String] Filename to load output profile from
|
1809
1809
|
# @param opts [Hash] Set of options
|
@@ -1814,55 +1814,55 @@ module Vips
|
|
1814
1814
|
# @option opts [Integer] :depth Output device space depth in bits
|
1815
1815
|
# @return [Vips::Image] Output image
|
1816
1816
|
|
1817
|
-
# @!method dE76(right, opts
|
1817
|
+
# @!method dE76(right, **opts)
|
1818
1818
|
# Calculate de76.
|
1819
1819
|
# @param right [Vips::Image] Right-hand input image
|
1820
1820
|
# @param opts [Hash] Set of options
|
1821
1821
|
# @return [Vips::Image] Output image
|
1822
1822
|
|
1823
|
-
# @!method dE00(right, opts
|
1823
|
+
# @!method dE00(right, **opts)
|
1824
1824
|
# Calculate de00.
|
1825
1825
|
# @param right [Vips::Image] Right-hand input image
|
1826
1826
|
# @param opts [Hash] Set of options
|
1827
1827
|
# @return [Vips::Image] Output image
|
1828
1828
|
|
1829
|
-
# @!method dECMC(right, opts
|
1829
|
+
# @!method dECMC(right, **opts)
|
1830
1830
|
# Calculate decmc.
|
1831
1831
|
# @param right [Vips::Image] Right-hand input image
|
1832
1832
|
# @param opts [Hash] Set of options
|
1833
1833
|
# @return [Vips::Image] Output image
|
1834
1834
|
|
1835
|
-
# @!method sRGB2scRGB(opts
|
1835
|
+
# @!method sRGB2scRGB(**opts)
|
1836
1836
|
# Convert an srgb image to scrgb.
|
1837
1837
|
# @param opts [Hash] Set of options
|
1838
1838
|
# @return [Vips::Image] Output image
|
1839
1839
|
|
1840
|
-
# @!method scRGB2BW(opts
|
1840
|
+
# @!method scRGB2BW(**opts)
|
1841
1841
|
# Convert scrgb to bw.
|
1842
1842
|
# @param opts [Hash] Set of options
|
1843
1843
|
# @option opts [Integer] :depth Output device space depth in bits
|
1844
1844
|
# @return [Vips::Image] Output image
|
1845
1845
|
|
1846
|
-
# @!method scRGB2sRGB(opts
|
1846
|
+
# @!method scRGB2sRGB(**opts)
|
1847
1847
|
# Convert an scrgb image to srgb.
|
1848
1848
|
# @param opts [Hash] Set of options
|
1849
1849
|
# @option opts [Integer] :depth Output device space depth in bits
|
1850
1850
|
# @return [Vips::Image] Output image
|
1851
1851
|
|
1852
|
-
# @!method maplut(lut, opts
|
1852
|
+
# @!method maplut(lut, **opts)
|
1853
1853
|
# Map an image though a lut.
|
1854
1854
|
# @param lut [Vips::Image] Look-up table image
|
1855
1855
|
# @param opts [Hash] Set of options
|
1856
1856
|
# @option opts [Integer] :band apply one-band lut to this band of in
|
1857
1857
|
# @return [Vips::Image] Output image
|
1858
1858
|
|
1859
|
-
# @!method percent(percent, opts
|
1859
|
+
# @!method percent(percent, **opts)
|
1860
1860
|
# Find threshold for percent of pixels.
|
1861
1861
|
# @param percent [Float] Percent of pixels
|
1862
1862
|
# @param opts [Hash] Set of options
|
1863
1863
|
# @return [Integer] Threshold above which lie percent of pixels
|
1864
1864
|
|
1865
|
-
# @!method stdif(width, height, opts
|
1865
|
+
# @!method stdif(width, height, **opts)
|
1866
1866
|
# Statistical difference.
|
1867
1867
|
# @param width [Integer] Window width in pixels
|
1868
1868
|
# @param height [Integer] Window height in pixels
|
@@ -1873,34 +1873,34 @@ module Vips
|
|
1873
1873
|
# @option opts [Float] :a Weight of new mean
|
1874
1874
|
# @return [Vips::Image] Output image
|
1875
1875
|
|
1876
|
-
# @!method hist_cum(opts
|
1876
|
+
# @!method hist_cum(**opts)
|
1877
1877
|
# Form cumulative histogram.
|
1878
1878
|
# @param opts [Hash] Set of options
|
1879
1879
|
# @return [Vips::Image] Output image
|
1880
1880
|
|
1881
|
-
# @!method hist_match(ref, opts
|
1881
|
+
# @!method hist_match(ref, **opts)
|
1882
1882
|
# Match two histograms.
|
1883
1883
|
# @param ref [Vips::Image] Reference histogram
|
1884
1884
|
# @param opts [Hash] Set of options
|
1885
1885
|
# @return [Vips::Image] Output image
|
1886
1886
|
|
1887
|
-
# @!method hist_norm(opts
|
1887
|
+
# @!method hist_norm(**opts)
|
1888
1888
|
# Normalise histogram.
|
1889
1889
|
# @param opts [Hash] Set of options
|
1890
1890
|
# @return [Vips::Image] Output image
|
1891
1891
|
|
1892
|
-
# @!method hist_equal(opts
|
1892
|
+
# @!method hist_equal(**opts)
|
1893
1893
|
# Histogram equalisation.
|
1894
1894
|
# @param opts [Hash] Set of options
|
1895
1895
|
# @option opts [Integer] :band Equalise with this band
|
1896
1896
|
# @return [Vips::Image] Output image
|
1897
1897
|
|
1898
|
-
# @!method hist_plot(opts
|
1898
|
+
# @!method hist_plot(**opts)
|
1899
1899
|
# Plot histogram.
|
1900
1900
|
# @param opts [Hash] Set of options
|
1901
1901
|
# @return [Vips::Image] Output image
|
1902
1902
|
|
1903
|
-
# @!method hist_local(width, height, opts
|
1903
|
+
# @!method hist_local(width, height, **opts)
|
1904
1904
|
# Local histogram equalisation.
|
1905
1905
|
# @param width [Integer] Window width in pixels
|
1906
1906
|
# @param height [Integer] Window height in pixels
|
@@ -1908,17 +1908,17 @@ module Vips
|
|
1908
1908
|
# @option opts [Integer] :max_slope Maximum slope (CLAHE)
|
1909
1909
|
# @return [Vips::Image] Output image
|
1910
1910
|
|
1911
|
-
# @!method hist_ismonotonic(opts
|
1911
|
+
# @!method hist_ismonotonic(**opts)
|
1912
1912
|
# Test for monotonicity.
|
1913
1913
|
# @param opts [Hash] Set of options
|
1914
1914
|
# @return [Boolean] true if in is monotonic
|
1915
1915
|
|
1916
|
-
# @!method hist_entropy(opts
|
1916
|
+
# @!method hist_entropy(**opts)
|
1917
1917
|
# Estimate image entropy.
|
1918
1918
|
# @param opts [Hash] Set of options
|
1919
1919
|
# @return [Float] Output value
|
1920
1920
|
|
1921
|
-
# @!method conv(mask, opts
|
1921
|
+
# @!method conv(mask, **opts)
|
1922
1922
|
# Convolution operation.
|
1923
1923
|
# @param mask [Vips::Image] Input matrix image
|
1924
1924
|
# @param opts [Hash] Set of options
|
@@ -1927,7 +1927,7 @@ module Vips
|
|
1927
1927
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1928
1928
|
# @return [Vips::Image] Output image
|
1929
1929
|
|
1930
|
-
# @!method conva(mask, opts
|
1930
|
+
# @!method conva(mask, **opts)
|
1931
1931
|
# Approximate integer convolution.
|
1932
1932
|
# @param mask [Vips::Image] Input matrix image
|
1933
1933
|
# @param opts [Hash] Set of options
|
@@ -1935,19 +1935,19 @@ module Vips
|
|
1935
1935
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1936
1936
|
# @return [Vips::Image] Output image
|
1937
1937
|
|
1938
|
-
# @!method convf(mask, opts
|
1938
|
+
# @!method convf(mask, **opts)
|
1939
1939
|
# Float convolution operation.
|
1940
1940
|
# @param mask [Vips::Image] Input matrix image
|
1941
1941
|
# @param opts [Hash] Set of options
|
1942
1942
|
# @return [Vips::Image] Output image
|
1943
1943
|
|
1944
|
-
# @!method convi(mask, opts
|
1944
|
+
# @!method convi(mask, **opts)
|
1945
1945
|
# Int convolution operation.
|
1946
1946
|
# @param mask [Vips::Image] Input matrix image
|
1947
1947
|
# @param opts [Hash] Set of options
|
1948
1948
|
# @return [Vips::Image] Output image
|
1949
1949
|
|
1950
|
-
# @!method compass(mask, opts
|
1950
|
+
# @!method compass(mask, **opts)
|
1951
1951
|
# Convolve with rotating mask.
|
1952
1952
|
# @param mask [Vips::Image] Input matrix image
|
1953
1953
|
# @param opts [Hash] Set of options
|
@@ -1959,7 +1959,7 @@ module Vips
|
|
1959
1959
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1960
1960
|
# @return [Vips::Image] Output image
|
1961
1961
|
|
1962
|
-
# @!method convsep(mask, opts
|
1962
|
+
# @!method convsep(mask, **opts)
|
1963
1963
|
# Seperable convolution operation.
|
1964
1964
|
# @param mask [Vips::Image] Input matrix image
|
1965
1965
|
# @param opts [Hash] Set of options
|
@@ -1968,26 +1968,26 @@ module Vips
|
|
1968
1968
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1969
1969
|
# @return [Vips::Image] Output image
|
1970
1970
|
|
1971
|
-
# @!method convasep(mask, opts
|
1971
|
+
# @!method convasep(mask, **opts)
|
1972
1972
|
# Approximate separable integer convolution.
|
1973
1973
|
# @param mask [Vips::Image] Input matrix image
|
1974
1974
|
# @param opts [Hash] Set of options
|
1975
1975
|
# @option opts [Integer] :layers Use this many layers in approximation
|
1976
1976
|
# @return [Vips::Image] Output image
|
1977
1977
|
|
1978
|
-
# @!method fastcor(ref, opts
|
1978
|
+
# @!method fastcor(ref, **opts)
|
1979
1979
|
# Fast correlation.
|
1980
1980
|
# @param ref [Vips::Image] Input reference image
|
1981
1981
|
# @param opts [Hash] Set of options
|
1982
1982
|
# @return [Vips::Image] Output image
|
1983
1983
|
|
1984
|
-
# @!method spcor(ref, opts
|
1984
|
+
# @!method spcor(ref, **opts)
|
1985
1985
|
# Spatial correlation.
|
1986
1986
|
# @param ref [Vips::Image] Input reference image
|
1987
1987
|
# @param opts [Hash] Set of options
|
1988
1988
|
# @return [Vips::Image] Output image
|
1989
1989
|
|
1990
|
-
# @!method sharpen(opts
|
1990
|
+
# @!method sharpen(**opts)
|
1991
1991
|
# Unsharp masking for print.
|
1992
1992
|
# @param opts [Hash] Set of options
|
1993
1993
|
# @option opts [Float] :sigma Sigma of Gaussian
|
@@ -1998,7 +1998,7 @@ module Vips
|
|
1998
1998
|
# @option opts [Float] :m2 Slope for jaggy areas
|
1999
1999
|
# @return [Vips::Image] Output image
|
2000
2000
|
|
2001
|
-
# @!method gaussblur(sigma, opts
|
2001
|
+
# @!method gaussblur(sigma, **opts)
|
2002
2002
|
# Gaussian blur.
|
2003
2003
|
# @param sigma [Float] Sigma of Gaussian
|
2004
2004
|
# @param opts [Hash] Set of options
|
@@ -2006,54 +2006,54 @@ module Vips
|
|
2006
2006
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
2007
2007
|
# @return [Vips::Image] Output image
|
2008
2008
|
|
2009
|
-
# @!method canny(opts
|
2009
|
+
# @!method canny(**opts)
|
2010
2010
|
# Canny edge detector.
|
2011
2011
|
# @param opts [Hash] Set of options
|
2012
2012
|
# @option opts [Float] :sigma Sigma of Gaussian
|
2013
2013
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
2014
2014
|
# @return [Vips::Image] Output image
|
2015
2015
|
|
2016
|
-
# @!method sobel(opts
|
2016
|
+
# @!method sobel(**opts)
|
2017
2017
|
# Sobel edge detector.
|
2018
2018
|
# @param opts [Hash] Set of options
|
2019
2019
|
# @return [Vips::Image] Output image
|
2020
2020
|
|
2021
|
-
# @!method fwfft(opts
|
2021
|
+
# @!method fwfft(**opts)
|
2022
2022
|
# Forward fft.
|
2023
2023
|
# @param opts [Hash] Set of options
|
2024
2024
|
# @return [Vips::Image] Output image
|
2025
2025
|
|
2026
|
-
# @!method invfft(opts
|
2026
|
+
# @!method invfft(**opts)
|
2027
2027
|
# Inverse fft.
|
2028
2028
|
# @param opts [Hash] Set of options
|
2029
2029
|
# @option opts [Boolean] :real Output only the real part of the transform
|
2030
2030
|
# @return [Vips::Image] Output image
|
2031
2031
|
|
2032
|
-
# @!method freqmult(mask, opts
|
2032
|
+
# @!method freqmult(mask, **opts)
|
2033
2033
|
# Frequency-domain filtering.
|
2034
2034
|
# @param mask [Vips::Image] Input mask image
|
2035
2035
|
# @param opts [Hash] Set of options
|
2036
2036
|
# @return [Vips::Image] Output image
|
2037
2037
|
|
2038
|
-
# @!method spectrum(opts
|
2038
|
+
# @!method spectrum(**opts)
|
2039
2039
|
# Make displayable power spectrum.
|
2040
2040
|
# @param opts [Hash] Set of options
|
2041
2041
|
# @return [Vips::Image] Output image
|
2042
2042
|
|
2043
|
-
# @!method phasecor(in2, opts
|
2043
|
+
# @!method phasecor(in2, **opts)
|
2044
2044
|
# Calculate phase correlation.
|
2045
2045
|
# @param in2 [Vips::Image] Second input image
|
2046
2046
|
# @param opts [Hash] Set of options
|
2047
2047
|
# @return [Vips::Image] Output image
|
2048
2048
|
|
2049
|
-
# @!method morph(mask, morph, opts
|
2049
|
+
# @!method morph(mask, morph, **opts)
|
2050
2050
|
# Morphology operation.
|
2051
2051
|
# @param mask [Vips::Image] Input matrix image
|
2052
2052
|
# @param morph [Vips::OperationMorphology] Morphological operation to perform
|
2053
2053
|
# @param opts [Hash] Set of options
|
2054
2054
|
# @return [Vips::Image] Output image
|
2055
2055
|
|
2056
|
-
# @!method rank(width, height, index, opts
|
2056
|
+
# @!method rank(width, height, index, **opts)
|
2057
2057
|
# Rank filter.
|
2058
2058
|
# @param width [Integer] Window width in pixels
|
2059
2059
|
# @param height [Integer] Window height in pixels
|
@@ -2061,25 +2061,25 @@ module Vips
|
|
2061
2061
|
# @param opts [Hash] Set of options
|
2062
2062
|
# @return [Vips::Image] Output image
|
2063
2063
|
|
2064
|
-
# @!method countlines(direction, opts
|
2064
|
+
# @!method countlines(direction, **opts)
|
2065
2065
|
# Count lines in an image.
|
2066
2066
|
# @param direction [Vips::Direction] Countlines left-right or up-down
|
2067
2067
|
# @param opts [Hash] Set of options
|
2068
2068
|
# @return [Float] Number of lines
|
2069
2069
|
|
2070
|
-
# @!method labelregions(opts
|
2070
|
+
# @!method labelregions(**opts)
|
2071
2071
|
# Label regions in an image.
|
2072
2072
|
# @param opts [Hash] Set of options
|
2073
2073
|
# @option opts [Integer] :segments Output Number of discrete contigious regions
|
2074
2074
|
# @return [Vips::Image, Hash<Symbol => Object>] Mask of region labels, Hash of optional output items
|
2075
2075
|
|
2076
|
-
# @!method fill_nearest(opts
|
2076
|
+
# @!method fill_nearest(**opts)
|
2077
2077
|
# Fill image zeros with nearest non-zero pixel.
|
2078
2078
|
# @param opts [Hash] Set of options
|
2079
2079
|
# @option opts [Vips::Image] :distance Output Distance to nearest non-zero pixel
|
2080
2080
|
# @return [Vips::Image, Hash<Symbol => Object>] Value of nearest non-zero pixel, Hash of optional output items
|
2081
2081
|
|
2082
|
-
# @!method draw_rect(ink, left, top, width, height, opts
|
2082
|
+
# @!method draw_rect(ink, left, top, width, height, **opts)
|
2083
2083
|
# Paint a rectangle on an image.
|
2084
2084
|
# @param ink [Array<Double>] Color for pixels
|
2085
2085
|
# @param left [Integer] Rect to fill
|
@@ -2090,7 +2090,7 @@ module Vips
|
|
2090
2090
|
# @option opts [Boolean] :fill Draw a solid object
|
2091
2091
|
# @return [Vips::Image] Image to draw on
|
2092
2092
|
|
2093
|
-
# @!method draw_mask(ink, mask, x, y, opts
|
2093
|
+
# @!method draw_mask(ink, mask, x, y, **opts)
|
2094
2094
|
# Draw a mask on an image.
|
2095
2095
|
# @param ink [Array<Double>] Color for pixels
|
2096
2096
|
# @param mask [Vips::Image] Mask of pixels to draw
|
@@ -2099,7 +2099,7 @@ module Vips
|
|
2099
2099
|
# @param opts [Hash] Set of options
|
2100
2100
|
# @return [Vips::Image] Image to draw on
|
2101
2101
|
|
2102
|
-
# @!method draw_line(ink, x1, y1, x2, y2, opts
|
2102
|
+
# @!method draw_line(ink, x1, y1, x2, y2, **opts)
|
2103
2103
|
# Draw a line on an image.
|
2104
2104
|
# @param ink [Array<Double>] Color for pixels
|
2105
2105
|
# @param x1 [Integer] Start of draw_line
|
@@ -2109,7 +2109,7 @@ module Vips
|
|
2109
2109
|
# @param opts [Hash] Set of options
|
2110
2110
|
# @return [Vips::Image] Image to draw on
|
2111
2111
|
|
2112
|
-
# @!method draw_circle(ink, cx, cy, radius, opts
|
2112
|
+
# @!method draw_circle(ink, cx, cy, radius, **opts)
|
2113
2113
|
# Draw a circle on an image.
|
2114
2114
|
# @param ink [Array<Double>] Color for pixels
|
2115
2115
|
# @param cx [Integer] Centre of draw_circle
|
@@ -2119,7 +2119,7 @@ module Vips
|
|
2119
2119
|
# @option opts [Boolean] :fill Draw a solid object
|
2120
2120
|
# @return [Vips::Image] Image to draw on
|
2121
2121
|
|
2122
|
-
# @!method draw_flood(ink, x, y, opts
|
2122
|
+
# @!method draw_flood(ink, x, y, **opts)
|
2123
2123
|
# Flood-fill an area.
|
2124
2124
|
# @param ink [Array<Double>] Color for pixels
|
2125
2125
|
# @param x [Integer] DrawFlood start point
|
@@ -2133,7 +2133,7 @@ module Vips
|
|
2133
2133
|
# @option opts [Integer] :height Output height of modified area
|
2134
2134
|
# @return [Vips::Image, Hash<Symbol => Object>] Image to draw on, Hash of optional output items
|
2135
2135
|
|
2136
|
-
# @!method draw_image(sub, x, y, opts
|
2136
|
+
# @!method draw_image(sub, x, y, **opts)
|
2137
2137
|
# Paint an image into another image.
|
2138
2138
|
# @param sub [Vips::Image] Sub-image to insert into main image
|
2139
2139
|
# @param x [Integer] Draw image here
|
@@ -2142,7 +2142,7 @@ module Vips
|
|
2142
2142
|
# @option opts [Vips::CombineMode] :mode Combining mode
|
2143
2143
|
# @return [Vips::Image] Image to draw on
|
2144
2144
|
|
2145
|
-
# @!method draw_smudge(left, top, width, height, opts
|
2145
|
+
# @!method draw_smudge(left, top, width, height, **opts)
|
2146
2146
|
# Blur a rectangle on an image.
|
2147
2147
|
# @param left [Integer] Rect to fill
|
2148
2148
|
# @param top [Integer] Rect to fill
|
@@ -2151,7 +2151,7 @@ module Vips
|
|
2151
2151
|
# @param opts [Hash] Set of options
|
2152
2152
|
# @return [Vips::Image] Image to draw on
|
2153
2153
|
|
2154
|
-
# @!method merge(sec, direction, dx, dy, opts
|
2154
|
+
# @!method merge(sec, direction, dx, dy, **opts)
|
2155
2155
|
# Merge two images.
|
2156
2156
|
# @param sec [Vips::Image] Secondary image
|
2157
2157
|
# @param direction [Vips::Direction] Horizontal or vertcial merge
|
@@ -2161,7 +2161,7 @@ module Vips
|
|
2161
2161
|
# @option opts [Integer] :mblend Maximum blend size
|
2162
2162
|
# @return [Vips::Image] Output image
|
2163
2163
|
|
2164
|
-
# @!method mosaic(sec, direction, xref, yref, xsec, ysec, opts
|
2164
|
+
# @!method mosaic(sec, direction, xref, yref, xsec, ysec, **opts)
|
2165
2165
|
# Mosaic two images.
|
2166
2166
|
# @param sec [Vips::Image] Secondary image
|
2167
2167
|
# @param direction [Vips::Direction] Horizontal or vertcial mosaic
|
@@ -2182,7 +2182,7 @@ module Vips
|
|
2182
2182
|
# @option opts [Float] :dx1 Output Detected first-order displacement
|
2183
2183
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
2184
2184
|
|
2185
|
-
# @!method mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts
|
2185
|
+
# @!method mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, **opts)
|
2186
2186
|
# First-order mosaic of two images.
|
2187
2187
|
# @param sec [Vips::Image] Secondary image
|
2188
2188
|
# @param direction [Vips::Direction] Horizontal or vertcial mosaic
|
@@ -2203,7 +2203,7 @@ module Vips
|
|
2203
2203
|
# @option opts [Integer] :bandno Band to search for features on
|
2204
2204
|
# @return [Vips::Image] Output image
|
2205
2205
|
|
2206
|
-
# @!method match(sec, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts
|
2206
|
+
# @!method match(sec, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, **opts)
|
2207
2207
|
# First-order match of two images.
|
2208
2208
|
# @param sec [Vips::Image] Secondary image
|
2209
2209
|
# @param xr1 [Integer] Position of first reference tie-point
|
@@ -2221,7 +2221,7 @@ module Vips
|
|
2221
2221
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
2222
2222
|
# @return [Vips::Image] Output image
|
2223
2223
|
|
2224
|
-
# @!method globalbalance(opts
|
2224
|
+
# @!method globalbalance(**opts)
|
2225
2225
|
# Global balance an image mosaic.
|
2226
2226
|
# @param opts [Hash] Set of options
|
2227
2227
|
# @option opts [Float] :gamma Image gamma
|