ruby-vips 1.0.6 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +9 -12
- data/CHANGELOG.md +5 -1
- data/README.md +32 -115
- data/TODO +4 -6
- data/VERSION +1 -1
- data/example/inheritance_with_refcount.rb +286 -0
- data/lib/ruby-vips.rb +1 -0
- data/lib/vips.rb +425 -93
- data/lib/vips/access.rb +1 -4
- data/lib/vips/align.rb +2 -2
- data/lib/vips/angle.rb +2 -2
- data/lib/vips/angle45.rb +2 -2
- data/lib/vips/bandformat.rb +1 -1
- data/lib/vips/coding.rb +1 -1
- data/lib/vips/direction.rb +2 -2
- data/lib/vips/extend.rb +8 -13
- data/lib/vips/gobject.rb +121 -0
- data/lib/vips/gvalue.rb +251 -0
- data/lib/vips/image.rb +487 -585
- data/lib/vips/interesting.rb +1 -1
- data/lib/vips/interpolate.rb +31 -6
- data/lib/vips/interpretation.rb +1 -1
- data/lib/vips/kernel.rb +1 -1
- data/lib/vips/methods.rb +339 -334
- data/lib/vips/object.rb +204 -0
- data/lib/vips/operation.rb +358 -14
- data/lib/vips/operationboolean.rb +14 -0
- data/lib/vips/operationcomplex.rb +12 -0
- data/lib/vips/operationcomplex2.rb +10 -0
- data/lib/vips/operationcomplexget.rb +11 -0
- data/lib/vips/operationmath.rb +18 -0
- data/lib/vips/operationmath2.rb +10 -0
- data/lib/vips/operationrelational.rb +15 -0
- data/lib/vips/operationround.rb +11 -0
- data/lib/vips/size.rb +2 -1
- data/lib/vips/version.rb +1 -1
- data/ruby-vips.gemspec +2 -6
- metadata +19 -11
- data/lib/vips/argument.rb +0 -159
- data/lib/vips/call.rb +0 -370
- data/lib/vips/demandstyle.rb +0 -35
- data/lib/vips/error.rb +0 -30
- data/lib/vips/foreignflags.rb +0 -20
data/lib/vips/interesting.rb
CHANGED
data/lib/vips/interpolate.rb
CHANGED
@@ -1,5 +1,7 @@
|
|
1
1
|
module Vips
|
2
2
|
|
3
|
+
attach_function :vips_interpolate_new, [:string], :pointer
|
4
|
+
|
3
5
|
# An interpolator. One of these can be given to operations like
|
4
6
|
# {Image#affine} or {Image#mapim} to select the type of pixel interpolation
|
5
7
|
# to use.
|
@@ -23,15 +25,38 @@ module Vips
|
|
23
25
|
# For example:
|
24
26
|
#
|
25
27
|
# ```ruby
|
26
|
-
# im = im.affine [2, 0, 0, 2],
|
28
|
+
# im = im.affine [2, 0, 0, 2],
|
29
|
+
# :interpolate => Vips::Interpolate.new(:bicubic)
|
27
30
|
# ```
|
28
31
|
|
29
|
-
class Interpolate
|
32
|
+
class Interpolate < Vips::Object
|
33
|
+
|
34
|
+
# the layout of the VipsInterpolate struct
|
35
|
+
module InterpolateLayout
|
36
|
+
def self.included base
|
37
|
+
base.class_eval do
|
38
|
+
layout :parent, Vips::Object::Struct
|
39
|
+
# rest opaque
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
class Struct < Vips::Object::Struct
|
45
|
+
include InterpolateLayout
|
46
|
+
|
47
|
+
end
|
48
|
+
|
49
|
+
class ManagedStruct < Vips::Object::ManagedStruct
|
50
|
+
include InterpolateLayout
|
51
|
+
|
52
|
+
end
|
53
|
+
|
54
|
+
def initialize name
|
55
|
+
ptr = Vips::vips_interpolate_new name
|
56
|
+
raise Vips::Error if ptr == nil
|
30
57
|
|
31
|
-
|
32
|
-
|
33
|
-
# @param [Hash] opts Set of options
|
34
|
-
# @return [Interpolate] constructed interpolator
|
58
|
+
super ptr
|
59
|
+
end
|
35
60
|
|
36
61
|
end
|
37
62
|
end
|
data/lib/vips/interpretation.rb
CHANGED
data/lib/vips/kernel.rb
CHANGED
data/lib/vips/methods.rb
CHANGED
@@ -4,10 +4,10 @@ module Vips
|
|
4
4
|
# @!method self.system(cmd_format, opts = {})
|
5
5
|
# Run an external command.
|
6
6
|
# @param cmd_format [String] Command to run
|
7
|
-
# @param [Hash]
|
8
|
-
# @option opts [Array<Image>] :
|
9
|
-
# @option opts [String] :in_format Format for input filename
|
7
|
+
# @param opts [Hash] Set of options
|
8
|
+
# @option opts [Array<Image>] :im Array of input images
|
10
9
|
# @option opts [String] :out_format Format for output filename
|
10
|
+
# @option opts [String] :in_format Format for input filename
|
11
11
|
# @option opts [Vips::Image] :out Output Output image
|
12
12
|
# @option opts [String] :log Output Command log
|
13
13
|
# @return [nil, Hash<Symbol => Object>] Hash of optional output items
|
@@ -15,155 +15,155 @@ module Vips
|
|
15
15
|
# @!method add(right, opts = {})
|
16
16
|
# Add two images.
|
17
17
|
# @param right [Vips::Image] Right-hand image argument
|
18
|
-
# @param [Hash]
|
18
|
+
# @param opts [Hash] Set of options
|
19
19
|
# @return [Vips::Image] Output image
|
20
20
|
|
21
21
|
# @!method subtract(right, opts = {})
|
22
22
|
# Subtract two images.
|
23
23
|
# @param right [Vips::Image] Right-hand image argument
|
24
|
-
# @param [Hash]
|
24
|
+
# @param opts [Hash] Set of options
|
25
25
|
# @return [Vips::Image] Output image
|
26
26
|
|
27
27
|
# @!method multiply(right, opts = {})
|
28
28
|
# Multiply two images.
|
29
29
|
# @param right [Vips::Image] Right-hand image argument
|
30
|
-
# @param [Hash]
|
30
|
+
# @param opts [Hash] Set of options
|
31
31
|
# @return [Vips::Image] Output image
|
32
32
|
|
33
33
|
# @!method divide(right, opts = {})
|
34
34
|
# Divide two images.
|
35
35
|
# @param right [Vips::Image] Right-hand image argument
|
36
|
-
# @param [Hash]
|
36
|
+
# @param opts [Hash] Set of options
|
37
37
|
# @return [Vips::Image] Output image
|
38
38
|
|
39
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
|
-
# @param [Hash]
|
43
|
+
# @param opts [Hash] Set of options
|
44
44
|
# @return [Vips::Image] Output image
|
45
45
|
|
46
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
|
-
# @param [Hash]
|
49
|
+
# @param opts [Hash] Set of options
|
50
50
|
# @return [Vips::Image] Output image
|
51
51
|
|
52
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
|
-
# @param [Hash]
|
56
|
+
# @param opts [Hash] Set of options
|
57
57
|
# @return [Vips::Image] Output image
|
58
58
|
|
59
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
|
-
# @param [Hash]
|
63
|
+
# @param opts [Hash] Set of options
|
64
64
|
# @return [Vips::Image] Output image
|
65
65
|
|
66
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
|
-
# @param [Hash]
|
70
|
+
# @param opts [Hash] Set of options
|
71
71
|
# @return [Vips::Image] Output image
|
72
72
|
|
73
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
|
-
# @param [Hash]
|
76
|
+
# @param opts [Hash] Set of options
|
77
77
|
# @return [Vips::Image] Output image
|
78
78
|
|
79
|
-
# @!method self.sum(
|
79
|
+
# @!method self.sum(im, opts = {})
|
80
80
|
# Sum an array of images.
|
81
|
-
# @param
|
82
|
-
# @param [Hash]
|
81
|
+
# @param im [Array<Image>] Array of input images
|
82
|
+
# @param opts [Hash] Set of options
|
83
83
|
# @return [Vips::Image] Output image
|
84
84
|
|
85
85
|
# @!method invert(opts = {})
|
86
86
|
# Invert an image.
|
87
|
-
# @param [Hash]
|
87
|
+
# @param opts [Hash] Set of options
|
88
88
|
# @return [Vips::Image] Output image
|
89
89
|
|
90
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
|
94
|
-
# @param [Hash]
|
94
|
+
# @param opts [Hash] Set of options
|
95
95
|
# @option opts [Boolean] :uchar Output should be uchar
|
96
96
|
# @return [Vips::Image] Output image
|
97
97
|
|
98
98
|
# @!method math(math, opts = {})
|
99
99
|
# Apply a math operation to an image.
|
100
100
|
# @param math [Vips::OperationMath] math to perform
|
101
|
-
# @param [Hash]
|
101
|
+
# @param opts [Hash] Set of options
|
102
102
|
# @return [Vips::Image] Output image
|
103
103
|
|
104
104
|
# @!method abs(opts = {})
|
105
105
|
# Absolute value of an image.
|
106
|
-
# @param [Hash]
|
106
|
+
# @param opts [Hash] Set of options
|
107
107
|
# @return [Vips::Image] Output image
|
108
108
|
|
109
109
|
# @!method sign(opts = {})
|
110
110
|
# Unit vector of pixel.
|
111
|
-
# @param [Hash]
|
111
|
+
# @param opts [Hash] Set of options
|
112
112
|
# @return [Vips::Image] Output image
|
113
113
|
|
114
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
|
-
# @param [Hash]
|
117
|
+
# @param opts [Hash] Set of options
|
118
118
|
# @return [Vips::Image] Output image
|
119
119
|
|
120
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
|
-
# @param [Hash]
|
124
|
+
# @param opts [Hash] Set of options
|
125
125
|
# @return [Vips::Image] Output image
|
126
126
|
|
127
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
|
-
# @param [Hash]
|
130
|
+
# @param opts [Hash] Set of options
|
131
131
|
# @return [Vips::Image] Output image
|
132
132
|
|
133
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
|
-
# @param [Hash]
|
137
|
+
# @param opts [Hash] Set of options
|
138
138
|
# @return [Vips::Image] Output image
|
139
139
|
|
140
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
|
-
# @param [Hash]
|
144
|
+
# @param opts [Hash] Set of options
|
145
145
|
# @return [Vips::Image] Output image
|
146
146
|
|
147
147
|
# @!method complex(cmplx, opts = {})
|
148
148
|
# Perform a complex operation on an image.
|
149
149
|
# @param cmplx [Vips::OperationComplex] complex to perform
|
150
|
-
# @param [Hash]
|
150
|
+
# @param opts [Hash] Set of options
|
151
151
|
# @return [Vips::Image] Output image
|
152
152
|
|
153
153
|
# @!method complexget(get, opts = {})
|
154
154
|
# Get a component from a complex image.
|
155
155
|
# @param get [Vips::OperationComplexget] complex to perform
|
156
|
-
# @param [Hash]
|
156
|
+
# @param opts [Hash] Set of options
|
157
157
|
# @return [Vips::Image] Output image
|
158
158
|
|
159
159
|
# @!method avg(opts = {})
|
160
160
|
# Find image average.
|
161
|
-
# @param [Hash]
|
161
|
+
# @param opts [Hash] Set of options
|
162
162
|
# @return [Float] Output value
|
163
163
|
|
164
164
|
# @!method min(opts = {})
|
165
165
|
# Find image minimum.
|
166
|
-
# @param [Hash]
|
166
|
+
# @param opts [Hash] Set of options
|
167
167
|
# @option opts [Integer] :size Number of minimum values to find
|
168
168
|
# @option opts [Integer] :x Output Horizontal position of minimum
|
169
169
|
# @option opts [Integer] :y Output Vertical position of minimum
|
@@ -174,7 +174,7 @@ module Vips
|
|
174
174
|
|
175
175
|
# @!method max(opts = {})
|
176
176
|
# Find image maximum.
|
177
|
-
# @param [Hash]
|
177
|
+
# @param opts [Hash] Set of options
|
178
178
|
# @option opts [Integer] :size Number of maximum values to find
|
179
179
|
# @option opts [Integer] :x Output Horizontal position of maximum
|
180
180
|
# @option opts [Integer] :y Output Vertical position of maximum
|
@@ -185,42 +185,42 @@ module Vips
|
|
185
185
|
|
186
186
|
# @!method deviate(opts = {})
|
187
187
|
# Find image standard deviation.
|
188
|
-
# @param [Hash]
|
188
|
+
# @param opts [Hash] Set of options
|
189
189
|
# @return [Float] Output value
|
190
190
|
|
191
191
|
# @!method stats(opts = {})
|
192
192
|
# Find image average.
|
193
|
-
# @param [Hash]
|
193
|
+
# @param opts [Hash] Set of options
|
194
194
|
# @return [Vips::Image] Output array of statistics
|
195
195
|
|
196
196
|
# @!method hist_find(opts = {})
|
197
197
|
# Find image histogram.
|
198
|
-
# @param [Hash]
|
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
202
|
# @!method hist_find_ndim(opts = {})
|
203
203
|
# Find n-dimensional image histogram.
|
204
|
-
# @param [Hash]
|
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
208
|
# @!method hist_find_indexed(index, opts = {})
|
209
209
|
# Find indexed image histogram.
|
210
210
|
# @param index [Vips::Image] Index image
|
211
|
-
# @param [Hash]
|
211
|
+
# @param opts [Hash] Set of options
|
212
212
|
# @return [Vips::Image] Output histogram
|
213
213
|
|
214
214
|
# @!method hough_line(opts = {})
|
215
215
|
# Find hough line transform.
|
216
|
-
# @param [Hash]
|
216
|
+
# @param opts [Hash] Set of options
|
217
217
|
# @option opts [Integer] :width horizontal size of parameter space
|
218
218
|
# @option opts [Integer] :height Vertical size of parameter space
|
219
219
|
# @return [Vips::Image] Output image
|
220
220
|
|
221
221
|
# @!method hough_circle(opts = {})
|
222
222
|
# Find hough circle transform.
|
223
|
-
# @param [Hash]
|
223
|
+
# @param opts [Hash] Set of options
|
224
224
|
# @option opts [Integer] :scale Scale down dimensions by this factor
|
225
225
|
# @option opts [Integer] :min_radius Smallest radius to search for
|
226
226
|
# @option opts [Integer] :max_radius Largest radius to search for
|
@@ -228,19 +228,19 @@ module Vips
|
|
228
228
|
|
229
229
|
# @!method project(opts = {})
|
230
230
|
# Find image projections.
|
231
|
-
# @param [Hash]
|
231
|
+
# @param opts [Hash] Set of options
|
232
232
|
# @return [Array<] Sums of columns, Sums of rows
|
233
233
|
|
234
234
|
# @!method profile(opts = {})
|
235
235
|
# Find image profiles.
|
236
|
-
# @param [Hash]
|
236
|
+
# @param opts [Hash] Set of options
|
237
237
|
# @return [Array<] First non-zero pixel in column, First non-zero pixel in row
|
238
238
|
|
239
239
|
# @!method measure(h, v, opts = {})
|
240
|
-
# Measure a set of patches on a
|
240
|
+
# Measure a set of patches on a color chart.
|
241
241
|
# @param h [Integer] Number of patches across chart
|
242
242
|
# @param v [Integer] Number of patches down chart
|
243
|
-
# @param [Hash]
|
243
|
+
# @param opts [Hash] Set of options
|
244
244
|
# @option opts [Integer] :left Left edge of extract area
|
245
245
|
# @option opts [Integer] :top Top edge of extract area
|
246
246
|
# @option opts [Integer] :width Width of extract area
|
@@ -251,12 +251,12 @@ module Vips
|
|
251
251
|
# Read a point from an image.
|
252
252
|
# @param x [Integer] Point to read
|
253
253
|
# @param y [Integer] Point to read
|
254
|
-
# @param [Hash]
|
254
|
+
# @param opts [Hash] Set of options
|
255
255
|
# @return [Array<Double>] Array of output values
|
256
256
|
|
257
257
|
# @!method copy(opts = {})
|
258
258
|
# Copy an image.
|
259
|
-
# @param [Hash]
|
259
|
+
# @param opts [Hash] Set of options
|
260
260
|
# @option opts [Integer] :width Image width in pixels
|
261
261
|
# @option opts [Integer] :height Image height in pixels
|
262
262
|
# @option opts [Integer] :bands Number of bands in image
|
@@ -271,7 +271,7 @@ module Vips
|
|
271
271
|
|
272
272
|
# @!method tilecache(opts = {})
|
273
273
|
# Cache an image as a set of tiles.
|
274
|
-
# @param [Hash]
|
274
|
+
# @param opts [Hash] Set of options
|
275
275
|
# @option opts [Integer] :tile_width Tile width in pixels
|
276
276
|
# @option opts [Integer] :tile_height Tile height in pixels
|
277
277
|
# @option opts [Integer] :max_tiles Maximum number of tiles to cache
|
@@ -282,7 +282,7 @@ module Vips
|
|
282
282
|
|
283
283
|
# @!method linecache(opts = {})
|
284
284
|
# Cache an image as a set of lines.
|
285
|
-
# @param [Hash]
|
285
|
+
# @param opts [Hash] Set of options
|
286
286
|
# @option opts [Integer] :tile_height Tile height in pixels
|
287
287
|
# @option opts [Vips::Access] :access Expected access pattern
|
288
288
|
# @option opts [Boolean] :threaded Allow threaded access
|
@@ -291,16 +291,16 @@ module Vips
|
|
291
291
|
|
292
292
|
# @!method sequential(opts = {})
|
293
293
|
# Check sequential access.
|
294
|
-
# @param [Hash]
|
294
|
+
# @param opts [Hash] Set of options
|
295
295
|
# @option opts [Integer] :tile_height Tile height in pixels
|
296
296
|
# @return [Vips::Image] Output image
|
297
297
|
|
298
298
|
# @!method cache(opts = {})
|
299
299
|
# Cache an image.
|
300
|
-
# @param [Hash]
|
301
|
-
# @option opts [Integer] :tile_width Tile width in pixels
|
302
|
-
# @option opts [Integer] :tile_height Tile height in pixels
|
300
|
+
# @param opts [Hash] Set of options
|
303
301
|
# @option opts [Integer] :max_tiles Maximum number of tiles to cache
|
302
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
303
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
304
304
|
# @return [Vips::Image] Output image
|
305
305
|
|
306
306
|
# @!method embed(x, y, width, height, opts = {})
|
@@ -309,7 +309,7 @@ module Vips
|
|
309
309
|
# @param y [Integer] Top edge of input in output
|
310
310
|
# @param width [Integer] Image width in pixels
|
311
311
|
# @param height [Integer] Image height in pixels
|
312
|
-
# @param [Hash]
|
312
|
+
# @param opts [Hash] Set of options
|
313
313
|
# @option opts [Vips::Extend] :extend How to generate the extra pixels
|
314
314
|
# @option opts [Array<Double>] :background Color for background pixels
|
315
315
|
# @return [Vips::Image] Output image
|
@@ -317,7 +317,7 @@ module Vips
|
|
317
317
|
# @!method flip(direction, opts = {})
|
318
318
|
# Flip an image.
|
319
319
|
# @param direction [Vips::Direction] Direction to flip image
|
320
|
-
# @param [Hash]
|
320
|
+
# @param opts [Hash] Set of options
|
321
321
|
# @return [Vips::Image] Output image
|
322
322
|
|
323
323
|
# @!method insert(sub, x, y, opts = {})
|
@@ -325,7 +325,7 @@ module Vips
|
|
325
325
|
# @param sub [Vips::Image] Sub-image to insert into main image
|
326
326
|
# @param x [Integer] Left edge of sub in main
|
327
327
|
# @param y [Integer] Top edge of sub in main
|
328
|
-
# @param [Hash]
|
328
|
+
# @param opts [Hash] Set of options
|
329
329
|
# @option opts [Boolean] :expand Expand output to hold all of both inputs
|
330
330
|
# @option opts [Array<Double>] :background Color for new pixels
|
331
331
|
# @return [Vips::Image] Output image
|
@@ -334,17 +334,17 @@ module Vips
|
|
334
334
|
# Join a pair of images.
|
335
335
|
# @param in2 [Vips::Image] Second input image
|
336
336
|
# @param direction [Vips::Direction] Join left-right or up-down
|
337
|
-
# @param [Hash]
|
337
|
+
# @param opts [Hash] Set of options
|
338
338
|
# @option opts [Boolean] :expand Expand output to hold all of both inputs
|
339
339
|
# @option opts [Integer] :shim Pixels between images
|
340
340
|
# @option opts [Array<Double>] :background Colour for new pixels
|
341
341
|
# @option opts [Vips::Align] :align Align on the low, centre or high coordinate edge
|
342
342
|
# @return [Vips::Image] Output image
|
343
343
|
|
344
|
-
# @!method self.arrayjoin(
|
344
|
+
# @!method self.arrayjoin(im, opts = {})
|
345
345
|
# Join an array of images.
|
346
|
-
# @param
|
347
|
-
# @param [Hash]
|
346
|
+
# @param im [Array<Image>] Array of input images
|
347
|
+
# @param opts [Hash] Set of options
|
348
348
|
# @option opts [Integer] :across Number of images across grid
|
349
349
|
# @option opts [Integer] :shim Pixels between images
|
350
350
|
# @option opts [Array<Double>] :background Colour for new pixels
|
@@ -360,7 +360,7 @@ module Vips
|
|
360
360
|
# @param top [Integer] Top edge of extract area
|
361
361
|
# @param width [Integer] Width of extract area
|
362
362
|
# @param height [Integer] Height of extract area
|
363
|
-
# @param [Hash]
|
363
|
+
# @param opts [Hash] Set of options
|
364
364
|
# @return [Vips::Image] Output image
|
365
365
|
|
366
366
|
# @!method extract_area(left, top, width, height, opts = {})
|
@@ -369,114 +369,114 @@ module Vips
|
|
369
369
|
# @param top [Integer] Top edge of extract area
|
370
370
|
# @param width [Integer] Width of extract area
|
371
371
|
# @param height [Integer] Height of extract area
|
372
|
-
# @param [Hash]
|
372
|
+
# @param opts [Hash] Set of options
|
373
373
|
# @return [Vips::Image] Output image
|
374
374
|
|
375
375
|
# @!method smartcrop(width, height, opts = {})
|
376
376
|
# Extract an area from an image.
|
377
377
|
# @param width [Integer] Width of extract area
|
378
378
|
# @param height [Integer] Height of extract area
|
379
|
-
# @param [Hash]
|
379
|
+
# @param opts [Hash] Set of options
|
380
380
|
# @option opts [Vips::Interesting] :interesting How to measure interestingness
|
381
381
|
# @return [Vips::Image] Output image
|
382
382
|
|
383
383
|
# @!method extract_band(band, opts = {})
|
384
384
|
# Extract band from an image.
|
385
385
|
# @param band [Integer] Band to extract
|
386
|
-
# @param [Hash]
|
386
|
+
# @param opts [Hash] Set of options
|
387
387
|
# @option opts [Integer] :n Number of bands to extract
|
388
388
|
# @return [Vips::Image] Output image
|
389
389
|
|
390
390
|
# @!method bandjoin_const(c, opts = {})
|
391
391
|
# Append a constant band to an image.
|
392
392
|
# @param c [Array<Double>] Array of constants to add
|
393
|
-
# @param [Hash]
|
393
|
+
# @param opts [Hash] Set of options
|
394
394
|
# @return [Vips::Image] Output image
|
395
395
|
|
396
|
-
# @!method self.bandrank(
|
396
|
+
# @!method self.bandrank(im, opts = {})
|
397
397
|
# Band-wise rank of a set of images.
|
398
|
-
# @param
|
399
|
-
# @param [Hash]
|
398
|
+
# @param im [Array<Image>] Array of input images
|
399
|
+
# @param opts [Hash] Set of options
|
400
400
|
# @option opts [Integer] :index Select this band element from sorted list
|
401
401
|
# @return [Vips::Image] Output image
|
402
402
|
|
403
403
|
# @!method bandmean(opts = {})
|
404
404
|
# Band-wise average.
|
405
|
-
# @param [Hash]
|
405
|
+
# @param opts [Hash] Set of options
|
406
406
|
# @return [Vips::Image] Output image
|
407
407
|
|
408
408
|
# @!method bandbool(boolean, opts = {})
|
409
409
|
# Boolean operation across image bands.
|
410
410
|
# @param boolean [Vips::OperationBoolean] boolean to perform
|
411
|
-
# @param [Hash]
|
411
|
+
# @param opts [Hash] Set of options
|
412
412
|
# @return [Vips::Image] Output image
|
413
413
|
|
414
414
|
# @!method replicate(across, down, opts = {})
|
415
415
|
# Replicate an image.
|
416
416
|
# @param across [Integer] Repeat this many times horizontally
|
417
417
|
# @param down [Integer] Repeat this many times vertically
|
418
|
-
# @param [Hash]
|
418
|
+
# @param opts [Hash] Set of options
|
419
419
|
# @return [Vips::Image] Output image
|
420
420
|
|
421
421
|
# @!method cast(format, opts = {})
|
422
422
|
# Cast an image.
|
423
423
|
# @param format [Vips::BandFormat] Format to cast to
|
424
|
-
# @param [Hash]
|
424
|
+
# @param opts [Hash] Set of options
|
425
425
|
# @option opts [Boolean] :shift Shift integer values up and down
|
426
426
|
# @return [Vips::Image] Output image
|
427
427
|
|
428
428
|
# @!method rot(angle, opts = {})
|
429
429
|
# Rotate an image.
|
430
430
|
# @param angle [Vips::Angle] Angle to rotate image
|
431
|
-
# @param [Hash]
|
431
|
+
# @param opts [Hash] Set of options
|
432
432
|
# @return [Vips::Image] Output image
|
433
433
|
|
434
434
|
# @!method rot45(opts = {})
|
435
435
|
# Rotate an image.
|
436
|
-
# @param [Hash]
|
436
|
+
# @param opts [Hash] Set of options
|
437
437
|
# @option opts [Vips::Angle45] :angle Angle to rotate image
|
438
438
|
# @return [Vips::Image] Output image
|
439
439
|
|
440
440
|
# @!method autorot(opts = {})
|
441
441
|
# Autorotate image by exif tag.
|
442
|
-
# @param [Hash]
|
442
|
+
# @param opts [Hash] Set of options
|
443
443
|
# @option opts [Vips::Angle] :angle Output Angle image was rotated by
|
444
444
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
445
445
|
|
446
446
|
# @!method recomb(m, opts = {})
|
447
447
|
# Linear recombination with matrix.
|
448
448
|
# @param m [Vips::Image] matrix of coefficients
|
449
|
-
# @param [Hash]
|
449
|
+
# @param opts [Hash] Set of options
|
450
450
|
# @return [Vips::Image] Output image
|
451
451
|
|
452
452
|
# @!method bandfold(opts = {})
|
453
453
|
# Fold up x axis into bands.
|
454
|
-
# @param [Hash]
|
454
|
+
# @param opts [Hash] Set of options
|
455
455
|
# @option opts [Integer] :factor Fold by this factor
|
456
456
|
# @return [Vips::Image] Output image
|
457
457
|
|
458
458
|
# @!method bandunfold(opts = {})
|
459
459
|
# Unfold image bands into x axis.
|
460
|
-
# @param [Hash]
|
460
|
+
# @param opts [Hash] Set of options
|
461
461
|
# @option opts [Integer] :factor Unfold by this factor
|
462
462
|
# @return [Vips::Image] Output image
|
463
463
|
|
464
464
|
# @!method flatten(opts = {})
|
465
465
|
# Flatten alpha out of an image.
|
466
|
-
# @param [Hash]
|
466
|
+
# @param opts [Hash] Set of options
|
467
467
|
# @option opts [Array<Double>] :background Background value
|
468
468
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
469
469
|
# @return [Vips::Image] Output image
|
470
470
|
|
471
471
|
# @!method premultiply(opts = {})
|
472
472
|
# Premultiply image alpha.
|
473
|
-
# @param [Hash]
|
473
|
+
# @param opts [Hash] Set of options
|
474
474
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
475
475
|
# @return [Vips::Image] Output image
|
476
476
|
|
477
477
|
# @!method unpremultiply(opts = {})
|
478
478
|
# Unpremultiply image alpha.
|
479
|
-
# @param [Hash]
|
479
|
+
# @param opts [Hash] Set of options
|
480
480
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
481
481
|
# @return [Vips::Image] Output image
|
482
482
|
|
@@ -485,19 +485,12 @@ module Vips
|
|
485
485
|
# @param tile_height [Integer] chop into tiles this high
|
486
486
|
# @param across [Integer] number of tiles across
|
487
487
|
# @param down [Integer] number of tiles down
|
488
|
-
# @param [Hash]
|
489
|
-
# @return [Vips::Image] Output image
|
490
|
-
|
491
|
-
# @!method scale(opts = {})
|
492
|
-
# Scale an image to uchar.
|
493
|
-
# @param [Hash] opts Set of options
|
494
|
-
# @option opts [Boolean] :log Log scale
|
495
|
-
# @option opts [Float] :exp Exponent for log scale
|
488
|
+
# @param opts [Hash] Set of options
|
496
489
|
# @return [Vips::Image] Output image
|
497
490
|
|
498
491
|
# @!method wrap(opts = {})
|
499
492
|
# Wrap image origin.
|
500
|
-
# @param [Hash]
|
493
|
+
# @param opts [Hash] Set of options
|
501
494
|
# @option opts [Integer] :x Left edge of input in output
|
502
495
|
# @option opts [Integer] :y Top edge of input in output
|
503
496
|
# @return [Vips::Image] Output image
|
@@ -506,36 +499,36 @@ module Vips
|
|
506
499
|
# Zoom an image.
|
507
500
|
# @param xfac [Integer] Horizontal zoom factor
|
508
501
|
# @param yfac [Integer] Vertical zoom factor
|
509
|
-
# @param [Hash]
|
502
|
+
# @param opts [Hash] Set of options
|
510
503
|
# @return [Vips::Image] Output image
|
511
504
|
|
512
505
|
# @!method subsample(xfac, yfac, opts = {})
|
513
506
|
# Subsample an image.
|
514
507
|
# @param xfac [Integer] Horizontal subsample factor
|
515
508
|
# @param yfac [Integer] Vertical subsample factor
|
516
|
-
# @param [Hash]
|
509
|
+
# @param opts [Hash] Set of options
|
517
510
|
# @option opts [Boolean] :point Point sample
|
518
511
|
# @return [Vips::Image] Output image
|
519
512
|
|
520
513
|
# @!method msb(opts = {})
|
521
514
|
# Pick most-significant byte from an image.
|
522
|
-
# @param [Hash]
|
515
|
+
# @param opts [Hash] Set of options
|
523
516
|
# @option opts [Integer] :band Band to msb
|
524
517
|
# @return [Vips::Image] Output image
|
525
518
|
|
526
519
|
# @!method byteswap(opts = {})
|
527
520
|
# Byteswap an image.
|
528
|
-
# @param [Hash]
|
521
|
+
# @param opts [Hash] Set of options
|
529
522
|
# @return [Vips::Image] Output image
|
530
523
|
|
531
524
|
# @!method falsecolour(opts = {})
|
532
|
-
# False-
|
533
|
-
# @param [Hash]
|
525
|
+
# False-color an image.
|
526
|
+
# @param opts [Hash] Set of options
|
534
527
|
# @return [Vips::Image] Output image
|
535
528
|
|
536
529
|
# @!method gamma(opts = {})
|
537
530
|
# Gamma an image.
|
538
|
-
# @param [Hash]
|
531
|
+
# @param opts [Hash] Set of options
|
539
532
|
# @option opts [Float] :exponent Gamma factor
|
540
533
|
# @return [Vips::Image] Output image
|
541
534
|
|
@@ -543,7 +536,7 @@ module Vips
|
|
543
536
|
# Make a black image.
|
544
537
|
# @param width [Integer] Image width in pixels
|
545
538
|
# @param height [Integer] Image height in pixels
|
546
|
-
# @param [Hash]
|
539
|
+
# @param opts [Hash] Set of options
|
547
540
|
# @option opts [Integer] :bands Number of bands in image
|
548
541
|
# @return [Vips::Image] Output image
|
549
542
|
|
@@ -551,15 +544,15 @@ module Vips
|
|
551
544
|
# Make a gaussnoise image.
|
552
545
|
# @param width [Integer] Image width in pixels
|
553
546
|
# @param height [Integer] Image height in pixels
|
554
|
-
# @param [Hash]
|
555
|
-
# @option opts [Float] :mean Mean of pixels in generated image
|
547
|
+
# @param opts [Hash] Set of options
|
556
548
|
# @option opts [Float] :sigma Standard deviation of pixels in generated image
|
549
|
+
# @option opts [Float] :mean Mean of pixels in generated image
|
557
550
|
# @return [Vips::Image] Output image
|
558
551
|
|
559
552
|
# @!method self.text(text, opts = {})
|
560
553
|
# Make a text image.
|
561
554
|
# @param text [String] Text to render
|
562
|
-
# @param [Hash]
|
555
|
+
# @param opts [Hash] Set of options
|
563
556
|
# @option opts [String] :font Font to render with
|
564
557
|
# @option opts [Integer] :width Maximum image width in pixels
|
565
558
|
# @option opts [Vips::Align] :align Align on the low, centre or high edge
|
@@ -571,7 +564,7 @@ module Vips
|
|
571
564
|
# Make an image where pixel values are coordinates.
|
572
565
|
# @param width [Integer] Image width in pixels
|
573
566
|
# @param height [Integer] Image height in pixels
|
574
|
-
# @param [Hash]
|
567
|
+
# @param opts [Hash] Set of options
|
575
568
|
# @option opts [Integer] :csize Size of third dimension
|
576
569
|
# @option opts [Integer] :dsize Size of fourth dimension
|
577
570
|
# @option opts [Integer] :esize Size of fifth dimension
|
@@ -581,7 +574,7 @@ module Vips
|
|
581
574
|
# Make a gaussian image.
|
582
575
|
# @param sigma [Float] Sigma of Gaussian
|
583
576
|
# @param min_ampl [Float] Minimum amplitude of Gaussian
|
584
|
-
# @param [Hash]
|
577
|
+
# @param opts [Hash] Set of options
|
585
578
|
# @option opts [Boolean] :separable Generate separable Gaussian
|
586
579
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
587
580
|
# @return [Vips::Image] Output image
|
@@ -590,7 +583,7 @@ module Vips
|
|
590
583
|
# Make a laplacian of gaussian image.
|
591
584
|
# @param sigma [Float] Radius of Logmatian
|
592
585
|
# @param min_ampl [Float] Minimum amplitude of Logmatian
|
593
|
-
# @param [Hash]
|
586
|
+
# @param opts [Hash] Set of options
|
594
587
|
# @option opts [Boolean] :separable Generate separable Logmatian
|
595
588
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
596
589
|
# @return [Vips::Image] Output image
|
@@ -599,7 +592,7 @@ module Vips
|
|
599
592
|
# Make an image showing the eye's spatial response.
|
600
593
|
# @param width [Integer] Image width in pixels
|
601
594
|
# @param height [Integer] Image height in pixels
|
602
|
-
# @param [Hash]
|
595
|
+
# @param opts [Hash] Set of options
|
603
596
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
604
597
|
# @option opts [Float] :factor Maximum spatial frequency
|
605
598
|
# @return [Vips::Image] Output image
|
@@ -608,7 +601,7 @@ module Vips
|
|
608
601
|
# Make a grey ramp image.
|
609
602
|
# @param width [Integer] Image width in pixels
|
610
603
|
# @param height [Integer] Image height in pixels
|
611
|
-
# @param [Hash]
|
604
|
+
# @param opts [Hash] Set of options
|
612
605
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
613
606
|
# @return [Vips::Image] Output image
|
614
607
|
|
@@ -616,7 +609,7 @@ module Vips
|
|
616
609
|
# Make a zone plate.
|
617
610
|
# @param width [Integer] Image width in pixels
|
618
611
|
# @param height [Integer] Image height in pixels
|
619
|
-
# @param [Hash]
|
612
|
+
# @param opts [Hash] Set of options
|
620
613
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
621
614
|
# @return [Vips::Image] Output image
|
622
615
|
|
@@ -624,7 +617,7 @@ module Vips
|
|
624
617
|
# Make a 2d sine wave.
|
625
618
|
# @param width [Integer] Image width in pixels
|
626
619
|
# @param height [Integer] Image height in pixels
|
627
|
-
# @param [Hash]
|
620
|
+
# @param opts [Hash] Set of options
|
628
621
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
629
622
|
# @option opts [Float] :hfreq Horizontal spatial frequency
|
630
623
|
# @option opts [Float] :vfreq Vertical spatial frequency
|
@@ -635,11 +628,11 @@ module Vips
|
|
635
628
|
# @param width [Integer] Image width in pixels
|
636
629
|
# @param height [Integer] Image height in pixels
|
637
630
|
# @param frequency_cutoff [Float] Frequency cutoff
|
638
|
-
# @param [Hash]
|
631
|
+
# @param opts [Hash] Set of options
|
639
632
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
640
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
641
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
642
633
|
# @option opts [Boolean] :nodc Remove DC component
|
634
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
635
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
643
636
|
# @return [Vips::Image] Output image
|
644
637
|
|
645
638
|
# @!method self.mask_ideal_ring(width, height, frequency_cutoff, ringwidth, opts = {})
|
@@ -648,11 +641,11 @@ module Vips
|
|
648
641
|
# @param height [Integer] Image height in pixels
|
649
642
|
# @param frequency_cutoff [Float] Frequency cutoff
|
650
643
|
# @param ringwidth [Float] Ringwidth
|
651
|
-
# @param [Hash]
|
644
|
+
# @param opts [Hash] Set of options
|
652
645
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
653
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
654
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
655
646
|
# @option opts [Boolean] :nodc Remove DC component
|
647
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
648
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
656
649
|
# @return [Vips::Image] Output image
|
657
650
|
|
658
651
|
# @!method self.mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, opts = {})
|
@@ -662,11 +655,11 @@ module Vips
|
|
662
655
|
# @param frequency_cutoff_x [Float] Frequency cutoff x
|
663
656
|
# @param frequency_cutoff_y [Float] Frequency cutoff y
|
664
657
|
# @param radius [Float] radius of circle
|
665
|
-
# @param [Hash]
|
658
|
+
# @param opts [Hash] Set of options
|
666
659
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
667
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
668
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
669
660
|
# @option opts [Boolean] :nodc Remove DC component
|
661
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
662
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
670
663
|
# @return [Vips::Image] Output image
|
671
664
|
|
672
665
|
# @!method self.mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, opts = {})
|
@@ -676,11 +669,11 @@ module Vips
|
|
676
669
|
# @param order [Float] Filter order
|
677
670
|
# @param frequency_cutoff [Float] Frequency cutoff
|
678
671
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
679
|
-
# @param [Hash]
|
672
|
+
# @param opts [Hash] Set of options
|
680
673
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
681
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
682
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
683
674
|
# @option opts [Boolean] :nodc Remove DC component
|
675
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
676
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
684
677
|
# @return [Vips::Image] Output image
|
685
678
|
|
686
679
|
# @!method self.mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {})
|
@@ -691,11 +684,11 @@ module Vips
|
|
691
684
|
# @param frequency_cutoff [Float] Frequency cutoff
|
692
685
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
693
686
|
# @param ringwidth [Float] Ringwidth
|
694
|
-
# @param [Hash]
|
687
|
+
# @param opts [Hash] Set of options
|
695
688
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
696
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
697
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
698
689
|
# @option opts [Boolean] :nodc Remove DC component
|
690
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
691
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
699
692
|
# @return [Vips::Image] Output image
|
700
693
|
|
701
694
|
# @!method self.mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {})
|
@@ -707,11 +700,11 @@ module Vips
|
|
707
700
|
# @param frequency_cutoff_y [Float] Frequency cutoff y
|
708
701
|
# @param radius [Float] radius of circle
|
709
702
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
710
|
-
# @param [Hash]
|
703
|
+
# @param opts [Hash] Set of options
|
711
704
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
712
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
713
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
714
705
|
# @option opts [Boolean] :nodc Remove DC component
|
706
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
707
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
715
708
|
# @return [Vips::Image] Output image
|
716
709
|
|
717
710
|
# @!method self.mask_gaussian(width, height, frequency_cutoff, amplitude_cutoff, opts = {})
|
@@ -720,11 +713,11 @@ module Vips
|
|
720
713
|
# @param height [Integer] Image height in pixels
|
721
714
|
# @param frequency_cutoff [Float] Frequency cutoff
|
722
715
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
723
|
-
# @param [Hash]
|
716
|
+
# @param opts [Hash] Set of options
|
724
717
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
725
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
726
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
727
718
|
# @option opts [Boolean] :nodc Remove DC component
|
719
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
720
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
728
721
|
# @return [Vips::Image] Output image
|
729
722
|
|
730
723
|
# @!method self.mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {})
|
@@ -734,11 +727,11 @@ module Vips
|
|
734
727
|
# @param frequency_cutoff [Float] Frequency cutoff
|
735
728
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
736
729
|
# @param ringwidth [Float] Ringwidth
|
737
|
-
# @param [Hash]
|
730
|
+
# @param opts [Hash] Set of options
|
738
731
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
739
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
740
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
741
732
|
# @option opts [Boolean] :nodc Remove DC component
|
733
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
734
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
742
735
|
# @return [Vips::Image] Output image
|
743
736
|
|
744
737
|
# @!method self.mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {})
|
@@ -749,11 +742,11 @@ module Vips
|
|
749
742
|
# @param frequency_cutoff_y [Float] Frequency cutoff y
|
750
743
|
# @param radius [Float] radius of circle
|
751
744
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
752
|
-
# @param [Hash]
|
745
|
+
# @param opts [Hash] Set of options
|
753
746
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
754
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
755
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
756
747
|
# @option opts [Boolean] :nodc Remove DC component
|
748
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
749
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
757
750
|
# @return [Vips::Image] Output image
|
758
751
|
|
759
752
|
# @!method self.mask_fractal(width, height, fractal_dimension, opts = {})
|
@@ -761,27 +754,27 @@ module Vips
|
|
761
754
|
# @param width [Integer] Image width in pixels
|
762
755
|
# @param height [Integer] Image height in pixels
|
763
756
|
# @param fractal_dimension [Float] Fractal dimension
|
764
|
-
# @param [Hash]
|
757
|
+
# @param opts [Hash] Set of options
|
765
758
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
766
|
-
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
767
|
-
# @option opts [Boolean] :reject Invert the sense of the filter
|
768
759
|
# @option opts [Boolean] :nodc Remove DC component
|
760
|
+
# @option opts [Boolean] :reject Invert the sense of the filter
|
761
|
+
# @option opts [Boolean] :optical Rotate quadrants to optical space
|
769
762
|
# @return [Vips::Image] Output image
|
770
763
|
|
771
764
|
# @!method buildlut(opts = {})
|
772
765
|
# Build a look-up table.
|
773
|
-
# @param [Hash]
|
766
|
+
# @param opts [Hash] Set of options
|
774
767
|
# @return [Vips::Image] Output image
|
775
768
|
|
776
769
|
# @!method invertlut(opts = {})
|
777
770
|
# Build an inverted look-up table.
|
778
|
-
# @param [Hash]
|
771
|
+
# @param opts [Hash] Set of options
|
779
772
|
# @option opts [Integer] :size LUT size to generate
|
780
773
|
# @return [Vips::Image] Output image
|
781
774
|
|
782
775
|
# @!method self.tonelut(opts = {})
|
783
776
|
# Build a look-up table.
|
784
|
-
# @param [Hash]
|
777
|
+
# @param opts [Hash] Set of options
|
785
778
|
# @option opts [Integer] :in_max Size of LUT to build
|
786
779
|
# @option opts [Integer] :out_max Maximum value in output LUT
|
787
780
|
# @option opts [Float] :Lb Lowest value in output
|
@@ -796,7 +789,7 @@ module Vips
|
|
796
789
|
|
797
790
|
# @!method self.identity(opts = {})
|
798
791
|
# Make a 1d image where pixel values are indexes.
|
799
|
-
# @param [Hash]
|
792
|
+
# @param opts [Hash] Set of options
|
800
793
|
# @option opts [Integer] :bands Number of bands in LUT
|
801
794
|
# @option opts [Boolean] :ushort Create a 16-bit LUT
|
802
795
|
# @option opts [Integer] :size Size of 16-bit LUT
|
@@ -807,14 +800,14 @@ module Vips
|
|
807
800
|
# @param width [Integer] Image width in pixels
|
808
801
|
# @param height [Integer] Image height in pixels
|
809
802
|
# @param fractal_dimension [Float] Fractal dimension
|
810
|
-
# @param [Hash]
|
803
|
+
# @param opts [Hash] Set of options
|
811
804
|
# @return [Vips::Image] Output image
|
812
805
|
|
813
806
|
# @!method self.worley(width, height, opts = {})
|
814
807
|
# Make a worley noise image.
|
815
808
|
# @param width [Integer] Image width in pixels
|
816
809
|
# @param height [Integer] Image height in pixels
|
817
|
-
# @param [Hash]
|
810
|
+
# @param opts [Hash] Set of options
|
818
811
|
# @option opts [Integer] :cell_size Size of Worley cells
|
819
812
|
# @return [Vips::Image] Output image
|
820
813
|
|
@@ -822,7 +815,7 @@ module Vips
|
|
822
815
|
# Make a perlin noise image.
|
823
816
|
# @param width [Integer] Image width in pixels
|
824
817
|
# @param height [Integer] Image height in pixels
|
825
|
-
# @param [Hash]
|
818
|
+
# @param opts [Hash] Set of options
|
826
819
|
# @option opts [Integer] :cell_size Size of Perlin cells
|
827
820
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
828
821
|
# @return [Vips::Image] Output image
|
@@ -830,12 +823,12 @@ module Vips
|
|
830
823
|
# @!method self.csvload(filename, opts = {})
|
831
824
|
# Load csv from file.
|
832
825
|
# @param filename [String] Filename to load from
|
833
|
-
# @param [Hash]
|
826
|
+
# @param opts [Hash] Set of options
|
834
827
|
# @option opts [Boolean] :disc Open to disc
|
835
828
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
836
829
|
# @option opts [Integer] :skip Skip this many lines at the start of the file
|
837
|
-
# @option opts [Boolean] :fail Fail on first warning
|
838
830
|
# @option opts [Integer] :lines Read this many lines from the file
|
831
|
+
# @option opts [Boolean] :fail Fail on first error
|
839
832
|
# @option opts [String] :whitespace Set of whitespace characters
|
840
833
|
# @option opts [String] :separator Set of separator characters
|
841
834
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
@@ -844,10 +837,10 @@ module Vips
|
|
844
837
|
# @!method self.matrixload(filename, opts = {})
|
845
838
|
# Load matrix from file.
|
846
839
|
# @param filename [String] Filename to load from
|
847
|
-
# @param [Hash]
|
840
|
+
# @param opts [Hash] Set of options
|
848
841
|
# @option opts [Boolean] :disc Open to disc
|
849
842
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
850
|
-
# @option opts [Boolean] :fail Fail on first
|
843
|
+
# @option opts [Boolean] :fail Fail on first error
|
851
844
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
852
845
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
853
846
|
|
@@ -857,63 +850,63 @@ module Vips
|
|
857
850
|
# @param width [Integer] Image width in pixels
|
858
851
|
# @param height [Integer] Image height in pixels
|
859
852
|
# @param bands [Integer] Number of bands in image
|
860
|
-
# @param [Hash]
|
853
|
+
# @param opts [Hash] Set of options
|
861
854
|
# @option opts [Boolean] :disc Open to disc
|
862
855
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
863
|
-
# @option opts [Boolean] :fail Fail on first
|
864
|
-
# @option opts [
|
856
|
+
# @option opts [Boolean] :fail Fail on first error
|
857
|
+
# @option opts [guint64] :offset Offset in bytes from start of file
|
865
858
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
866
859
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
867
860
|
|
868
861
|
# @!method self.vipsload(filename, opts = {})
|
869
862
|
# Load vips from file.
|
870
863
|
# @param filename [String] Filename to load from
|
871
|
-
# @param [Hash]
|
864
|
+
# @param opts [Hash] Set of options
|
872
865
|
# @option opts [Boolean] :disc Open to disc
|
873
866
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
874
|
-
# @option opts [Boolean] :fail Fail on first
|
867
|
+
# @option opts [Boolean] :fail Fail on first error
|
875
868
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
876
869
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
877
870
|
|
878
871
|
# @!method self.analyzeload(filename, opts = {})
|
879
872
|
# Load an analyze6 image.
|
880
873
|
# @param filename [String] Filename to load from
|
881
|
-
# @param [Hash]
|
874
|
+
# @param opts [Hash] Set of options
|
882
875
|
# @option opts [Boolean] :disc Open to disc
|
883
876
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
884
|
-
# @option opts [Boolean] :fail Fail on first
|
877
|
+
# @option opts [Boolean] :fail Fail on first error
|
885
878
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
886
879
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
887
880
|
|
888
881
|
# @!method self.ppmload(filename, opts = {})
|
889
882
|
# Load ppm from file.
|
890
883
|
# @param filename [String] Filename to load from
|
891
|
-
# @param [Hash]
|
884
|
+
# @param opts [Hash] Set of options
|
892
885
|
# @option opts [Boolean] :disc Open to disc
|
893
886
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
894
|
-
# @option opts [Boolean] :fail Fail on first
|
887
|
+
# @option opts [Boolean] :fail Fail on first error
|
895
888
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
896
889
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
897
890
|
|
898
891
|
# @!method self.radload(filename, opts = {})
|
899
892
|
# Load a radiance image from a file.
|
900
893
|
# @param filename [String] Filename to load from
|
901
|
-
# @param [Hash]
|
894
|
+
# @param opts [Hash] Set of options
|
902
895
|
# @option opts [Boolean] :disc Open to disc
|
903
896
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
904
|
-
# @option opts [Boolean] :fail Fail on first
|
897
|
+
# @option opts [Boolean] :fail Fail on first error
|
905
898
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
906
899
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
907
900
|
|
908
901
|
# @!method self.pdfload(filename, opts = {})
|
909
902
|
# Load pdf with libpoppler.
|
910
903
|
# @param filename [String] Filename to load from
|
911
|
-
# @param [Hash]
|
904
|
+
# @param opts [Hash] Set of options
|
912
905
|
# @option opts [Boolean] :disc Open to disc
|
913
906
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
914
907
|
# @option opts [Integer] :page Load this page from the file
|
915
|
-
# @option opts [Boolean] :fail Fail on first warning
|
916
908
|
# @option opts [Integer] :n Load this many pages
|
909
|
+
# @option opts [Boolean] :fail Fail on first error
|
917
910
|
# @option opts [Float] :dpi Render at this DPI
|
918
911
|
# @option opts [Float] :scale Scale output by this factor
|
919
912
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
@@ -921,13 +914,13 @@ module Vips
|
|
921
914
|
|
922
915
|
# @!method self.pdfload_buffer(buffer, opts = {})
|
923
916
|
# Load pdf with libpoppler.
|
924
|
-
# @param buffer [
|
925
|
-
# @param [Hash]
|
917
|
+
# @param buffer [VipsBlob] Buffer to load from
|
918
|
+
# @param opts [Hash] Set of options
|
926
919
|
# @option opts [Boolean] :disc Open to disc
|
927
920
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
928
921
|
# @option opts [Integer] :page Load this page from the file
|
929
|
-
# @option opts [Boolean] :fail Fail on first warning
|
930
922
|
# @option opts [Integer] :n Load this many pages
|
923
|
+
# @option opts [Boolean] :fail Fail on first error
|
931
924
|
# @option opts [Float] :dpi Render at this DPI
|
932
925
|
# @option opts [Float] :scale Scale output by this factor
|
933
926
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
@@ -936,23 +929,35 @@ module Vips
|
|
936
929
|
# @!method self.svgload(filename, opts = {})
|
937
930
|
# Load svg with rsvg.
|
938
931
|
# @param filename [String] Filename to load from
|
939
|
-
# @param [Hash]
|
932
|
+
# @param opts [Hash] Set of options
|
940
933
|
# @option opts [Boolean] :disc Open to disc
|
941
934
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
942
|
-
# @option opts [Boolean] :fail Fail on first warning
|
943
935
|
# @option opts [Float] :dpi Render at this DPI
|
936
|
+
# @option opts [Boolean] :fail Fail on first error
|
937
|
+
# @option opts [Float] :scale Scale output by this factor
|
938
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
939
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
940
|
+
|
941
|
+
# @!method self.svgload(filename, opts = {})
|
942
|
+
# Load svg with rsvg.
|
943
|
+
# @param filename [String] Filename to load from
|
944
|
+
# @param opts [Hash] Set of options
|
945
|
+
# @option opts [Boolean] :disc Open to disc
|
946
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
947
|
+
# @option opts [Float] :dpi Render at this DPI
|
948
|
+
# @option opts [Boolean] :fail Fail on first error
|
944
949
|
# @option opts [Float] :scale Scale output by this factor
|
945
950
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
946
951
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
947
952
|
|
948
953
|
# @!method self.svgload_buffer(buffer, opts = {})
|
949
954
|
# Load svg with rsvg.
|
950
|
-
# @param buffer [
|
951
|
-
# @param [Hash]
|
955
|
+
# @param buffer [VipsBlob] Buffer to load from
|
956
|
+
# @param opts [Hash] Set of options
|
952
957
|
# @option opts [Boolean] :disc Open to disc
|
953
958
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
954
|
-
# @option opts [Boolean] :fail Fail on first warning
|
955
959
|
# @option opts [Float] :dpi Render at this DPI
|
960
|
+
# @option opts [Boolean] :fail Fail on first error
|
956
961
|
# @option opts [Float] :scale Scale output by this factor
|
957
962
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
958
963
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
@@ -960,77 +965,77 @@ module Vips
|
|
960
965
|
# @!method self.gifload(filename, opts = {})
|
961
966
|
# Load gif with giflib.
|
962
967
|
# @param filename [String] Filename to load from
|
963
|
-
# @param [Hash]
|
968
|
+
# @param opts [Hash] Set of options
|
964
969
|
# @option opts [Integer] :n Load this many pages
|
965
970
|
# @option opts [Boolean] :disc Open to disc
|
966
971
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
967
972
|
# @option opts [Integer] :page Load this page from the file
|
968
|
-
# @option opts [Boolean] :fail Fail on first
|
973
|
+
# @option opts [Boolean] :fail Fail on first error
|
969
974
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
970
975
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
971
976
|
|
972
977
|
# @!method self.gifload_buffer(buffer, opts = {})
|
973
978
|
# Load gif with giflib.
|
974
|
-
# @param buffer [
|
975
|
-
# @param [Hash]
|
979
|
+
# @param buffer [VipsBlob] Buffer to load from
|
980
|
+
# @param opts [Hash] Set of options
|
976
981
|
# @option opts [Integer] :n Load this many pages
|
977
982
|
# @option opts [Boolean] :disc Open to disc
|
978
983
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
979
984
|
# @option opts [Integer] :page Load this page from the file
|
980
|
-
# @option opts [Boolean] :fail Fail on first
|
985
|
+
# @option opts [Boolean] :fail Fail on first error
|
981
986
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
982
987
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
983
988
|
|
984
989
|
# @!method self.pngload(filename, opts = {})
|
985
990
|
# Load png from file.
|
986
991
|
# @param filename [String] Filename to load from
|
987
|
-
# @param [Hash]
|
992
|
+
# @param opts [Hash] Set of options
|
988
993
|
# @option opts [Boolean] :disc Open to disc
|
989
994
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
990
|
-
# @option opts [Boolean] :fail Fail on first
|
995
|
+
# @option opts [Boolean] :fail Fail on first error
|
991
996
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
992
997
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
993
998
|
|
994
999
|
# @!method self.pngload_buffer(buffer, opts = {})
|
995
1000
|
# Load png from buffer.
|
996
|
-
# @param buffer [
|
997
|
-
# @param [Hash]
|
1001
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1002
|
+
# @param opts [Hash] Set of options
|
998
1003
|
# @option opts [Boolean] :disc Open to disc
|
999
1004
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1000
|
-
# @option opts [Boolean] :fail Fail on first
|
1005
|
+
# @option opts [Boolean] :fail Fail on first error
|
1001
1006
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1002
1007
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1003
1008
|
|
1004
1009
|
# @!method self.matload(filename, opts = {})
|
1005
1010
|
# Load mat from file.
|
1006
1011
|
# @param filename [String] Filename to load from
|
1007
|
-
# @param [Hash]
|
1012
|
+
# @param opts [Hash] Set of options
|
1008
1013
|
# @option opts [Boolean] :disc Open to disc
|
1009
1014
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1010
|
-
# @option opts [Boolean] :fail Fail on first
|
1015
|
+
# @option opts [Boolean] :fail Fail on first error
|
1011
1016
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1012
1017
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1013
1018
|
|
1014
1019
|
# @!method self.jpegload(filename, opts = {})
|
1015
1020
|
# Load jpeg from file.
|
1016
1021
|
# @param filename [String] Filename to load from
|
1017
|
-
# @param [Hash]
|
1022
|
+
# @param opts [Hash] Set of options
|
1018
1023
|
# @option opts [Boolean] :disc Open to disc
|
1019
1024
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1020
1025
|
# @option opts [Integer] :shrink Shrink factor on load
|
1021
|
-
# @option opts [Boolean] :fail Fail on first
|
1026
|
+
# @option opts [Boolean] :fail Fail on first error
|
1022
1027
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1023
1028
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1024
1029
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1025
1030
|
|
1026
1031
|
# @!method self.jpegload_buffer(buffer, opts = {})
|
1027
1032
|
# Load jpeg from buffer.
|
1028
|
-
# @param buffer [
|
1029
|
-
# @param [Hash]
|
1033
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1034
|
+
# @param opts [Hash] Set of options
|
1030
1035
|
# @option opts [Boolean] :disc Open to disc
|
1031
1036
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1032
1037
|
# @option opts [Integer] :shrink Shrink factor on load
|
1033
|
-
# @option opts [Boolean] :fail Fail on first
|
1038
|
+
# @option opts [Boolean] :fail Fail on first error
|
1034
1039
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1035
1040
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1036
1041
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
@@ -1038,47 +1043,47 @@ module Vips
|
|
1038
1043
|
# @!method self.webpload(filename, opts = {})
|
1039
1044
|
# Load webp from file.
|
1040
1045
|
# @param filename [String] Filename to load from
|
1041
|
-
# @param [Hash]
|
1046
|
+
# @param opts [Hash] Set of options
|
1042
1047
|
# @option opts [Boolean] :disc Open to disc
|
1043
1048
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1044
1049
|
# @option opts [Integer] :shrink Shrink factor on load
|
1045
|
-
# @option opts [Boolean] :fail Fail on first
|
1050
|
+
# @option opts [Boolean] :fail Fail on first error
|
1046
1051
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1047
1052
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1048
1053
|
|
1049
1054
|
# @!method self.webpload_buffer(buffer, opts = {})
|
1050
1055
|
# Load webp from buffer.
|
1051
|
-
# @param buffer [
|
1052
|
-
# @param [Hash]
|
1056
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1057
|
+
# @param opts [Hash] Set of options
|
1053
1058
|
# @option opts [Boolean] :disc Open to disc
|
1054
1059
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1055
1060
|
# @option opts [Integer] :shrink Shrink factor on load
|
1056
|
-
# @option opts [Boolean] :fail Fail on first
|
1061
|
+
# @option opts [Boolean] :fail Fail on first error
|
1057
1062
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1058
1063
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1059
1064
|
|
1060
1065
|
# @!method self.tiffload(filename, opts = {})
|
1061
1066
|
# Load tiff from file.
|
1062
1067
|
# @param filename [String] Filename to load from
|
1063
|
-
# @param [Hash]
|
1068
|
+
# @param opts [Hash] Set of options
|
1064
1069
|
# @option opts [Boolean] :disc Open to disc
|
1065
1070
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1066
1071
|
# @option opts [Integer] :page Load this page from the image
|
1067
|
-
# @option opts [Boolean] :fail Fail on first warning
|
1068
1072
|
# @option opts [Integer] :n Load this many pages
|
1073
|
+
# @option opts [Boolean] :fail Fail on first error
|
1069
1074
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1070
1075
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1071
1076
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1072
1077
|
|
1073
1078
|
# @!method self.tiffload_buffer(buffer, opts = {})
|
1074
1079
|
# Load tiff from buffer.
|
1075
|
-
# @param buffer [
|
1076
|
-
# @param [Hash]
|
1080
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1081
|
+
# @param opts [Hash] Set of options
|
1077
1082
|
# @option opts [Boolean] :disc Open to disc
|
1078
1083
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1079
1084
|
# @option opts [Integer] :page Load this page from the image
|
1080
|
-
# @option opts [Boolean] :fail Fail on first warning
|
1081
1085
|
# @option opts [Integer] :n Load this many pages
|
1086
|
+
# @option opts [Boolean] :fail Fail on first error
|
1082
1087
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1083
1088
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1084
1089
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
@@ -1086,12 +1091,12 @@ module Vips
|
|
1086
1091
|
# @!method self.openslideload(filename, opts = {})
|
1087
1092
|
# Load file with openslide.
|
1088
1093
|
# @param filename [String] Filename to load from
|
1089
|
-
# @param [Hash]
|
1094
|
+
# @param opts [Hash] Set of options
|
1090
1095
|
# @option opts [Boolean] :disc Open to disc
|
1091
1096
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1092
1097
|
# @option opts [Integer] :level Load this level from the file
|
1093
|
-
# @option opts [Boolean] :fail Fail on first warning
|
1094
1098
|
# @option opts [Boolean] :autocrop Crop to image bounds
|
1099
|
+
# @option opts [Boolean] :fail Fail on first error
|
1095
1100
|
# @option opts [String] :associated Load this associated image
|
1096
1101
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1097
1102
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
@@ -1099,53 +1104,53 @@ module Vips
|
|
1099
1104
|
# @!method self.magickload(filename, opts = {})
|
1100
1105
|
# Load file with imagemagick.
|
1101
1106
|
# @param filename [String] Filename to load from
|
1102
|
-
# @param [Hash]
|
1107
|
+
# @param opts [Hash] Set of options
|
1103
1108
|
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1104
1109
|
# @option opts [Integer] :page Load this page from the file
|
1105
1110
|
# @option opts [Integer] :n Load this many pages
|
1106
1111
|
# @option opts [Boolean] :disc Open to disc
|
1107
1112
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1108
|
-
# @option opts [Boolean] :fail Fail on first
|
1113
|
+
# @option opts [Boolean] :fail Fail on first error
|
1109
1114
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1110
1115
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1111
1116
|
|
1112
1117
|
# @!method self.magickload_buffer(buffer, opts = {})
|
1113
1118
|
# Load buffer with imagemagick.
|
1114
|
-
# @param buffer [
|
1115
|
-
# @param [Hash]
|
1119
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1120
|
+
# @param opts [Hash] Set of options
|
1116
1121
|
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1117
1122
|
# @option opts [Integer] :page Load this page from the file
|
1118
1123
|
# @option opts [Integer] :n Load this many pages
|
1119
1124
|
# @option opts [Boolean] :disc Open to disc
|
1120
1125
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1121
|
-
# @option opts [Boolean] :fail Fail on first
|
1126
|
+
# @option opts [Boolean] :fail Fail on first error
|
1122
1127
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1123
1128
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1124
1129
|
|
1125
1130
|
# @!method self.fitsload(filename, opts = {})
|
1126
1131
|
# Load a fits image.
|
1127
1132
|
# @param filename [String] Filename to load from
|
1128
|
-
# @param [Hash]
|
1133
|
+
# @param opts [Hash] Set of options
|
1129
1134
|
# @option opts [Boolean] :disc Open to disc
|
1130
1135
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1131
|
-
# @option opts [Boolean] :fail Fail on first
|
1136
|
+
# @option opts [Boolean] :fail Fail on first error
|
1132
1137
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1133
1138
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1134
1139
|
|
1135
1140
|
# @!method self.openexrload(filename, opts = {})
|
1136
1141
|
# Load an openexr image.
|
1137
1142
|
# @param filename [String] Filename to load from
|
1138
|
-
# @param [Hash]
|
1143
|
+
# @param opts [Hash] Set of options
|
1139
1144
|
# @option opts [Boolean] :disc Open to disc
|
1140
1145
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1141
|
-
# @option opts [Boolean] :fail Fail on first
|
1146
|
+
# @option opts [Boolean] :fail Fail on first error
|
1142
1147
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1143
1148
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1144
1149
|
|
1145
1150
|
# @!method csvsave(filename, opts = {})
|
1146
1151
|
# Save image to csv file.
|
1147
1152
|
# @param filename [String] Filename to save to
|
1148
|
-
# @param [Hash]
|
1153
|
+
# @param opts [Hash] Set of options
|
1149
1154
|
# @option opts [String] :separator Separator characters
|
1150
1155
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1151
1156
|
# @option opts [Array<Double>] :background Background value
|
@@ -1154,14 +1159,14 @@ module Vips
|
|
1154
1159
|
# @!method matrixsave(filename, opts = {})
|
1155
1160
|
# Save image to matrix file.
|
1156
1161
|
# @param filename [String] Filename to save to
|
1157
|
-
# @param [Hash]
|
1162
|
+
# @param opts [Hash] Set of options
|
1158
1163
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1159
1164
|
# @option opts [Array<Double>] :background Background value
|
1160
1165
|
# @return [nil]
|
1161
1166
|
|
1162
1167
|
# @!method matrixprint(opts = {})
|
1163
1168
|
# Print matrix.
|
1164
|
-
# @param [Hash]
|
1169
|
+
# @param opts [Hash] Set of options
|
1165
1170
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1166
1171
|
# @option opts [Array<Double>] :background Background value
|
1167
1172
|
# @return [nil]
|
@@ -1169,7 +1174,7 @@ module Vips
|
|
1169
1174
|
# @!method rawsave(filename, opts = {})
|
1170
1175
|
# Save image to raw file.
|
1171
1176
|
# @param filename [String] Filename to save to
|
1172
|
-
# @param [Hash]
|
1177
|
+
# @param opts [Hash] Set of options
|
1173
1178
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1174
1179
|
# @option opts [Array<Double>] :background Background value
|
1175
1180
|
# @return [nil]
|
@@ -1177,7 +1182,7 @@ module Vips
|
|
1177
1182
|
# @!method rawsave_fd(fd, opts = {})
|
1178
1183
|
# Write raw image to file descriptor.
|
1179
1184
|
# @param fd [Integer] File descriptor to write to
|
1180
|
-
# @param [Hash]
|
1185
|
+
# @param opts [Hash] Set of options
|
1181
1186
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1182
1187
|
# @option opts [Array<Double>] :background Background value
|
1183
1188
|
# @return [nil]
|
@@ -1185,7 +1190,7 @@ module Vips
|
|
1185
1190
|
# @!method vipssave(filename, opts = {})
|
1186
1191
|
# Save image to vips file.
|
1187
1192
|
# @param filename [String] Filename to save to
|
1188
|
-
# @param [Hash]
|
1193
|
+
# @param opts [Hash] Set of options
|
1189
1194
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1190
1195
|
# @option opts [Array<Double>] :background Background value
|
1191
1196
|
# @return [nil]
|
@@ -1193,7 +1198,7 @@ module Vips
|
|
1193
1198
|
# @!method ppmsave(filename, opts = {})
|
1194
1199
|
# Save image to ppm file.
|
1195
1200
|
# @param filename [String] Filename to save to
|
1196
|
-
# @param [Hash]
|
1201
|
+
# @param opts [Hash] Set of options
|
1197
1202
|
# @option opts [Boolean] :ascii save as ascii
|
1198
1203
|
# @option opts [Boolean] :squash save as one bit
|
1199
1204
|
# @option opts [Boolean] :strip Strip all metadata from image
|
@@ -1203,29 +1208,29 @@ module Vips
|
|
1203
1208
|
# @!method radsave(filename, opts = {})
|
1204
1209
|
# Save image to radiance file.
|
1205
1210
|
# @param filename [String] Filename to save to
|
1206
|
-
# @param [Hash]
|
1211
|
+
# @param opts [Hash] Set of options
|
1207
1212
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1208
1213
|
# @option opts [Array<Double>] :background Background value
|
1209
1214
|
# @return [nil]
|
1210
1215
|
|
1211
1216
|
# @!method radsave_buffer(opts = {})
|
1212
1217
|
# Save image to radiance buffer.
|
1213
|
-
# @param [Hash]
|
1218
|
+
# @param opts [Hash] Set of options
|
1214
1219
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1215
1220
|
# @option opts [Array<Double>] :background Background value
|
1216
|
-
# @return [
|
1221
|
+
# @return [VipsBlob] Buffer to save to
|
1217
1222
|
|
1218
1223
|
# @!method dzsave(filename, opts = {})
|
1219
1224
|
# Save image to deepzoom file.
|
1220
1225
|
# @param filename [String] Filename to save to
|
1221
|
-
# @param [Hash]
|
1226
|
+
# @param opts [Hash] Set of options
|
1222
1227
|
# @option opts [String] :basename Base name to save to
|
1223
1228
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1224
1229
|
# @option opts [String] :suffix Filename suffix for tiles
|
1225
1230
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1226
1231
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1227
|
-
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1228
1232
|
# @option opts [Boolean] :centre Center image in tile
|
1233
|
+
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1229
1234
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
1230
1235
|
# @option opts [Vips::ForeignDzContainer] :container Pyramid container type
|
1231
1236
|
# @option opts [Boolean] :properties Write a properties file to the output directory
|
@@ -1236,26 +1241,26 @@ module Vips
|
|
1236
1241
|
|
1237
1242
|
# @!method dzsave_buffer(opts = {})
|
1238
1243
|
# Save image to dz buffer.
|
1239
|
-
# @param [Hash]
|
1244
|
+
# @param opts [Hash] Set of options
|
1240
1245
|
# @option opts [String] :basename Base name to save to
|
1241
1246
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1242
1247
|
# @option opts [String] :suffix Filename suffix for tiles
|
1243
1248
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1244
1249
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1245
|
-
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1246
1250
|
# @option opts [Boolean] :centre Center image in tile
|
1251
|
+
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1247
1252
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
1248
1253
|
# @option opts [Vips::ForeignDzContainer] :container Pyramid container type
|
1249
1254
|
# @option opts [Boolean] :properties Write a properties file to the output directory
|
1250
1255
|
# @option opts [Integer] :compression ZIP deflate compression level
|
1251
1256
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1252
1257
|
# @option opts [Array<Double>] :background Background value
|
1253
|
-
# @return [
|
1258
|
+
# @return [VipsBlob] Buffer to save to
|
1254
1259
|
|
1255
1260
|
# @!method pngsave(filename, opts = {})
|
1256
1261
|
# Save image to png file.
|
1257
1262
|
# @param filename [String] Filename to save to
|
1258
|
-
# @param [Hash]
|
1263
|
+
# @param opts [Hash] Set of options
|
1259
1264
|
# @option opts [Integer] :compression Compression factor
|
1260
1265
|
# @option opts [Boolean] :interlace Interlace image
|
1261
1266
|
# @option opts [String] :profile ICC profile to embed
|
@@ -1266,19 +1271,19 @@ module Vips
|
|
1266
1271
|
|
1267
1272
|
# @!method pngsave_buffer(opts = {})
|
1268
1273
|
# Save image to png buffer.
|
1269
|
-
# @param [Hash]
|
1274
|
+
# @param opts [Hash] Set of options
|
1270
1275
|
# @option opts [Integer] :compression Compression factor
|
1271
1276
|
# @option opts [Boolean] :interlace Interlace image
|
1272
1277
|
# @option opts [String] :profile ICC profile to embed
|
1273
1278
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1274
1279
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1275
1280
|
# @option opts [Array<Double>] :background Background value
|
1276
|
-
# @return [
|
1281
|
+
# @return [VipsBlob] Buffer to save to
|
1277
1282
|
|
1278
1283
|
# @!method jpegsave(filename, opts = {})
|
1279
1284
|
# Save image to jpeg file.
|
1280
1285
|
# @param filename [String] Filename to save to
|
1281
|
-
# @param [Hash]
|
1286
|
+
# @param opts [Hash] Set of options
|
1282
1287
|
# @option opts [Integer] :Q Q factor
|
1283
1288
|
# @option opts [String] :profile ICC profile to embed
|
1284
1289
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
@@ -1294,7 +1299,7 @@ module Vips
|
|
1294
1299
|
|
1295
1300
|
# @!method jpegsave_buffer(opts = {})
|
1296
1301
|
# Save image to jpeg buffer.
|
1297
|
-
# @param [Hash]
|
1302
|
+
# @param opts [Hash] Set of options
|
1298
1303
|
# @option opts [Integer] :Q Q factor
|
1299
1304
|
# @option opts [String] :profile ICC profile to embed
|
1300
1305
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
@@ -1306,11 +1311,11 @@ module Vips
|
|
1306
1311
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1307
1312
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1308
1313
|
# @option opts [Array<Double>] :background Background value
|
1309
|
-
# @return [
|
1314
|
+
# @return [VipsBlob] Buffer to save to
|
1310
1315
|
|
1311
1316
|
# @!method jpegsave_mime(opts = {})
|
1312
1317
|
# Save image to jpeg mime.
|
1313
|
-
# @param [Hash]
|
1318
|
+
# @param opts [Hash] Set of options
|
1314
1319
|
# @option opts [Integer] :Q Q factor
|
1315
1320
|
# @option opts [String] :profile ICC profile to embed
|
1316
1321
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
@@ -1327,7 +1332,7 @@ module Vips
|
|
1327
1332
|
# @!method webpsave(filename, opts = {})
|
1328
1333
|
# Save image to webp file.
|
1329
1334
|
# @param filename [String] Filename to save to
|
1330
|
-
# @param [Hash]
|
1335
|
+
# @param opts [Hash] Set of options
|
1331
1336
|
# @option opts [Integer] :Q Q factor
|
1332
1337
|
# @option opts [Boolean] :lossless enable lossless compression
|
1333
1338
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
@@ -1340,7 +1345,7 @@ module Vips
|
|
1340
1345
|
|
1341
1346
|
# @!method webpsave_buffer(opts = {})
|
1342
1347
|
# Save image to webp buffer.
|
1343
|
-
# @param [Hash]
|
1348
|
+
# @param opts [Hash] Set of options
|
1344
1349
|
# @option opts [Integer] :Q Q factor
|
1345
1350
|
# @option opts [Boolean] :lossless enable lossless compression
|
1346
1351
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
@@ -1349,12 +1354,12 @@ module Vips
|
|
1349
1354
|
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
1350
1355
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1351
1356
|
# @option opts [Array<Double>] :background Background value
|
1352
|
-
# @return [
|
1357
|
+
# @return [VipsBlob] Buffer to save to
|
1353
1358
|
|
1354
1359
|
# @!method tiffsave(filename, opts = {})
|
1355
1360
|
# Save image to tiff file.
|
1356
1361
|
# @param filename [String] Filename to save to
|
1357
|
-
# @param [Hash]
|
1362
|
+
# @param opts [Hash] Set of options
|
1358
1363
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
1359
1364
|
# @option opts [Integer] :Q Q factor
|
1360
1365
|
# @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
|
@@ -1363,8 +1368,8 @@ module Vips
|
|
1363
1368
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1364
1369
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1365
1370
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1366
|
-
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1367
1371
|
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1372
|
+
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1368
1373
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1369
1374
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1370
1375
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
@@ -1376,7 +1381,7 @@ module Vips
|
|
1376
1381
|
|
1377
1382
|
# @!method tiffsave_buffer(opts = {})
|
1378
1383
|
# Save image to tiff buffer.
|
1379
|
-
# @param [Hash]
|
1384
|
+
# @param opts [Hash] Set of options
|
1380
1385
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
1381
1386
|
# @option opts [Integer] :Q Q factor
|
1382
1387
|
# @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
|
@@ -1385,8 +1390,8 @@ module Vips
|
|
1385
1390
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1386
1391
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1387
1392
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1388
|
-
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1389
1393
|
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1394
|
+
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1390
1395
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1391
1396
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1392
1397
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
@@ -1394,12 +1399,12 @@ module Vips
|
|
1394
1399
|
# @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
|
1395
1400
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1396
1401
|
# @option opts [Array<Double>] :background Background value
|
1397
|
-
# @return [
|
1402
|
+
# @return [VipsBlob] Buffer to save to
|
1398
1403
|
|
1399
1404
|
# @!method fitssave(filename, opts = {})
|
1400
1405
|
# Save image to fits file.
|
1401
1406
|
# @param filename [String] Filename to save to
|
1402
|
-
# @param [Hash]
|
1407
|
+
# @param opts [Hash] Set of options
|
1403
1408
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1404
1409
|
# @option opts [Array<Double>] :background Background value
|
1405
1410
|
# @return [nil]
|
@@ -1408,7 +1413,7 @@ module Vips
|
|
1408
1413
|
# Generate thumbnail from file.
|
1409
1414
|
# @param filename [String] Filename to read from
|
1410
1415
|
# @param width [Integer] Size to this width
|
1411
|
-
# @param [Hash]
|
1416
|
+
# @param opts [Hash] Set of options
|
1412
1417
|
# @option opts [Integer] :height Size to this height
|
1413
1418
|
# @option opts [Vips::Size] :size Only upsize, only downsize, or both
|
1414
1419
|
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
@@ -1420,9 +1425,9 @@ module Vips
|
|
1420
1425
|
|
1421
1426
|
# @!method self.thumbnail_buffer(buffer, width, opts = {})
|
1422
1427
|
# Generate thumbnail from buffer.
|
1423
|
-
# @param buffer [
|
1428
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1424
1429
|
# @param width [Integer] Size to this width
|
1425
|
-
# @param [Hash]
|
1430
|
+
# @param opts [Hash] Set of options
|
1426
1431
|
# @option opts [Integer] :height Size to this height
|
1427
1432
|
# @option opts [Vips::Size] :size Only upsize, only downsize, or both
|
1428
1433
|
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
@@ -1435,7 +1440,7 @@ module Vips
|
|
1435
1440
|
# @!method mapim(index, opts = {})
|
1436
1441
|
# Resample with an mapim image.
|
1437
1442
|
# @param index [Vips::Image] Index pixels with this
|
1438
|
-
# @param [Hash]
|
1443
|
+
# @param opts [Hash] Set of options
|
1439
1444
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
1440
1445
|
# @return [Vips::Image] Output image
|
1441
1446
|
|
@@ -1443,25 +1448,25 @@ module Vips
|
|
1443
1448
|
# Shrink an image.
|
1444
1449
|
# @param hshrink [Float] Horizontal shrink factor
|
1445
1450
|
# @param vshrink [Float] Vertical shrink factor
|
1446
|
-
# @param [Hash]
|
1451
|
+
# @param opts [Hash] Set of options
|
1447
1452
|
# @return [Vips::Image] Output image
|
1448
1453
|
|
1449
1454
|
# @!method shrinkh(hshrink, opts = {})
|
1450
1455
|
# Shrink an image horizontally.
|
1451
1456
|
# @param hshrink [Integer] Horizontal shrink factor
|
1452
|
-
# @param [Hash]
|
1457
|
+
# @param opts [Hash] Set of options
|
1453
1458
|
# @return [Vips::Image] Output image
|
1454
1459
|
|
1455
1460
|
# @!method shrinkv(vshrink, opts = {})
|
1456
1461
|
# Shrink an image vertically.
|
1457
1462
|
# @param vshrink [Integer] Vertical shrink factor
|
1458
|
-
# @param [Hash]
|
1463
|
+
# @param opts [Hash] Set of options
|
1459
1464
|
# @return [Vips::Image] Output image
|
1460
1465
|
|
1461
1466
|
# @!method reduceh(hshrink, opts = {})
|
1462
1467
|
# Shrink an image horizontally.
|
1463
1468
|
# @param hshrink [Float] Horizontal shrink factor
|
1464
|
-
# @param [Hash]
|
1469
|
+
# @param opts [Hash] Set of options
|
1465
1470
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1466
1471
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1467
1472
|
# @return [Vips::Image] Output image
|
@@ -1469,7 +1474,7 @@ module Vips
|
|
1469
1474
|
# @!method reducev(vshrink, opts = {})
|
1470
1475
|
# Shrink an image vertically.
|
1471
1476
|
# @param vshrink [Float] Vertical shrink factor
|
1472
|
-
# @param [Hash]
|
1477
|
+
# @param opts [Hash] Set of options
|
1473
1478
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1474
1479
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1475
1480
|
# @return [Vips::Image] Output image
|
@@ -1478,7 +1483,7 @@ module Vips
|
|
1478
1483
|
# Reduce an image.
|
1479
1484
|
# @param hshrink [Float] Horizontal shrink factor
|
1480
1485
|
# @param vshrink [Float] Vertical shrink factor
|
1481
|
-
# @param [Hash]
|
1486
|
+
# @param opts [Hash] Set of options
|
1482
1487
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1483
1488
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1484
1489
|
# @return [Vips::Image] Output image
|
@@ -1486,14 +1491,14 @@ module Vips
|
|
1486
1491
|
# @!method quadratic(coeff, opts = {})
|
1487
1492
|
# Resample an image with a quadratic transform.
|
1488
1493
|
# @param coeff [Vips::Image] Coefficient matrix
|
1489
|
-
# @param [Hash]
|
1494
|
+
# @param opts [Hash] Set of options
|
1490
1495
|
# @option opts [Vips::Interpolate] :interpolate Interpolate values with this
|
1491
1496
|
# @return [Vips::Image] Output image
|
1492
1497
|
|
1493
1498
|
# @!method affine(matrix, opts = {})
|
1494
1499
|
# Affine transform of an image.
|
1495
1500
|
# @param matrix [Array<Double>] Transformation matrix
|
1496
|
-
# @param [Hash]
|
1501
|
+
# @param opts [Hash] Set of options
|
1497
1502
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
1498
1503
|
# @option opts [Array<Integer>] :oarea Area of output to generate
|
1499
1504
|
# @option opts [Float] :odx Horizontal output displacement
|
@@ -1504,7 +1509,7 @@ module Vips
|
|
1504
1509
|
|
1505
1510
|
# @!method similarity(opts = {})
|
1506
1511
|
# Similarity transform of an image.
|
1507
|
-
# @param [Hash]
|
1512
|
+
# @param opts [Hash] Set of options
|
1508
1513
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
1509
1514
|
# @option opts [Float] :scale Scale by this factor
|
1510
1515
|
# @option opts [Float] :angle Rotate anticlockwise by this many degrees
|
@@ -1517,140 +1522,140 @@ module Vips
|
|
1517
1522
|
# @!method resize(scale, opts = {})
|
1518
1523
|
# Resize an image.
|
1519
1524
|
# @param scale [Float] Scale image by this factor
|
1520
|
-
# @param [Hash]
|
1525
|
+
# @param opts [Hash] Set of options
|
1521
1526
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1522
1527
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1523
1528
|
# @option opts [Float] :vscale Vertical scale image by this factor
|
1524
1529
|
# @return [Vips::Image] Output image
|
1525
1530
|
|
1526
1531
|
# @!method colourspace(space, opts = {})
|
1527
|
-
# Convert to a new
|
1528
|
-
# @param space [Vips::Interpretation] Destination
|
1529
|
-
# @param [Hash]
|
1530
|
-
# @option opts [Vips::Interpretation] :source_space Source
|
1532
|
+
# Convert to a new colorspace.
|
1533
|
+
# @param space [Vips::Interpretation] Destination color space
|
1534
|
+
# @param opts [Hash] Set of options
|
1535
|
+
# @option opts [Vips::Interpretation] :source_space Source color space
|
1531
1536
|
# @return [Vips::Image] Output image
|
1532
1537
|
|
1533
1538
|
# @!method Lab2XYZ(opts = {})
|
1534
1539
|
# Transform cielab to xyz.
|
1535
|
-
# @param [Hash]
|
1540
|
+
# @param opts [Hash] Set of options
|
1536
1541
|
# @option opts [Array<Double>] :temp Color temperature
|
1537
1542
|
# @return [Vips::Image] Output image
|
1538
1543
|
|
1539
1544
|
# @!method XYZ2Lab(opts = {})
|
1540
1545
|
# Transform xyz to lab.
|
1541
|
-
# @param [Hash]
|
1546
|
+
# @param opts [Hash] Set of options
|
1542
1547
|
# @option opts [Array<Double>] :temp Colour temperature
|
1543
1548
|
# @return [Vips::Image] Output image
|
1544
1549
|
|
1545
1550
|
# @!method Lab2LCh(opts = {})
|
1546
1551
|
# Transform lab to lch.
|
1547
|
-
# @param [Hash]
|
1552
|
+
# @param opts [Hash] Set of options
|
1548
1553
|
# @return [Vips::Image] Output image
|
1549
1554
|
|
1550
1555
|
# @!method LCh2Lab(opts = {})
|
1551
1556
|
# Transform lch to lab.
|
1552
|
-
# @param [Hash]
|
1557
|
+
# @param opts [Hash] Set of options
|
1553
1558
|
# @return [Vips::Image] Output image
|
1554
1559
|
|
1555
1560
|
# @!method LCh2CMC(opts = {})
|
1556
1561
|
# Transform lch to cmc.
|
1557
|
-
# @param [Hash]
|
1562
|
+
# @param opts [Hash] Set of options
|
1558
1563
|
# @return [Vips::Image] Output image
|
1559
1564
|
|
1560
1565
|
# @!method CMC2LCh(opts = {})
|
1561
1566
|
# Transform lch to cmc.
|
1562
|
-
# @param [Hash]
|
1567
|
+
# @param opts [Hash] Set of options
|
1563
1568
|
# @return [Vips::Image] Output image
|
1564
1569
|
|
1565
1570
|
# @!method XYZ2Yxy(opts = {})
|
1566
1571
|
# Transform xyz to yxy.
|
1567
|
-
# @param [Hash]
|
1572
|
+
# @param opts [Hash] Set of options
|
1568
1573
|
# @return [Vips::Image] Output image
|
1569
1574
|
|
1570
1575
|
# @!method Yxy2XYZ(opts = {})
|
1571
1576
|
# Transform yxy to xyz.
|
1572
|
-
# @param [Hash]
|
1577
|
+
# @param opts [Hash] Set of options
|
1573
1578
|
# @return [Vips::Image] Output image
|
1574
1579
|
|
1575
1580
|
# @!method scRGB2XYZ(opts = {})
|
1576
1581
|
# Transform scrgb to xyz.
|
1577
|
-
# @param [Hash]
|
1582
|
+
# @param opts [Hash] Set of options
|
1578
1583
|
# @return [Vips::Image] Output image
|
1579
1584
|
|
1580
1585
|
# @!method XYZ2scRGB(opts = {})
|
1581
1586
|
# Transform xyz to scrgb.
|
1582
|
-
# @param [Hash]
|
1587
|
+
# @param opts [Hash] Set of options
|
1583
1588
|
# @return [Vips::Image] Output image
|
1584
1589
|
|
1585
1590
|
# @!method LabQ2Lab(opts = {})
|
1586
1591
|
# Unpack a labq image to float lab.
|
1587
|
-
# @param [Hash]
|
1592
|
+
# @param opts [Hash] Set of options
|
1588
1593
|
# @return [Vips::Image] Output image
|
1589
1594
|
|
1590
1595
|
# @!method Lab2LabQ(opts = {})
|
1591
1596
|
# Transform float lab to labq coding.
|
1592
|
-
# @param [Hash]
|
1597
|
+
# @param opts [Hash] Set of options
|
1593
1598
|
# @return [Vips::Image] Output image
|
1594
1599
|
|
1595
1600
|
# @!method LabQ2LabS(opts = {})
|
1596
1601
|
# Unpack a labq image to short lab.
|
1597
|
-
# @param [Hash]
|
1602
|
+
# @param opts [Hash] Set of options
|
1598
1603
|
# @return [Vips::Image] Output image
|
1599
1604
|
|
1600
1605
|
# @!method LabS2LabQ(opts = {})
|
1601
1606
|
# Transform short lab to labq coding.
|
1602
|
-
# @param [Hash]
|
1607
|
+
# @param opts [Hash] Set of options
|
1603
1608
|
# @return [Vips::Image] Output image
|
1604
1609
|
|
1605
1610
|
# @!method LabS2Lab(opts = {})
|
1606
1611
|
# Transform signed short lab to float.
|
1607
|
-
# @param [Hash]
|
1612
|
+
# @param opts [Hash] Set of options
|
1608
1613
|
# @return [Vips::Image] Output image
|
1609
1614
|
|
1610
1615
|
# @!method Lab2LabS(opts = {})
|
1611
1616
|
# Transform float lab to signed short.
|
1612
|
-
# @param [Hash]
|
1617
|
+
# @param opts [Hash] Set of options
|
1613
1618
|
# @return [Vips::Image] Output image
|
1614
1619
|
|
1615
1620
|
# @!method rad2float(opts = {})
|
1616
1621
|
# Unpack radiance coding to float rgb.
|
1617
|
-
# @param [Hash]
|
1622
|
+
# @param opts [Hash] Set of options
|
1618
1623
|
# @return [Vips::Image] Output image
|
1619
1624
|
|
1620
1625
|
# @!method float2rad(opts = {})
|
1621
1626
|
# Transform float rgb to radiance coding.
|
1622
|
-
# @param [Hash]
|
1627
|
+
# @param opts [Hash] Set of options
|
1623
1628
|
# @return [Vips::Image] Output image
|
1624
1629
|
|
1625
1630
|
# @!method LabQ2sRGB(opts = {})
|
1626
1631
|
# Convert a labq image to srgb.
|
1627
|
-
# @param [Hash]
|
1632
|
+
# @param opts [Hash] Set of options
|
1628
1633
|
# @return [Vips::Image] Output image
|
1629
1634
|
|
1630
1635
|
# @!method sRGB2HSV(opts = {})
|
1631
1636
|
# Transform srgb to hsv.
|
1632
|
-
# @param [Hash]
|
1637
|
+
# @param opts [Hash] Set of options
|
1633
1638
|
# @return [Vips::Image] Output image
|
1634
1639
|
|
1635
1640
|
# @!method HSV2sRGB(opts = {})
|
1636
1641
|
# Transform hsv to srgb.
|
1637
|
-
# @param [Hash]
|
1642
|
+
# @param opts [Hash] Set of options
|
1638
1643
|
# @return [Vips::Image] Output image
|
1639
1644
|
|
1640
1645
|
# @!method icc_import(opts = {})
|
1641
1646
|
# Import from device with icc profile.
|
1642
|
-
# @param [Hash]
|
1643
|
-
# @option opts [Vips::Intent] :intent Rendering intent
|
1647
|
+
# @param opts [Hash] Set of options
|
1644
1648
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1649
|
+
# @option opts [Vips::Intent] :intent Rendering intent
|
1645
1650
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
1646
1651
|
# @option opts [String] :input_profile Filename to load input profile from
|
1647
1652
|
# @return [Vips::Image] Output image
|
1648
1653
|
|
1649
1654
|
# @!method icc_export(opts = {})
|
1650
1655
|
# Output to device with icc profile.
|
1651
|
-
# @param [Hash]
|
1652
|
-
# @option opts [Vips::Intent] :intent Rendering intent
|
1656
|
+
# @param opts [Hash] Set of options
|
1653
1657
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1658
|
+
# @option opts [Vips::Intent] :intent Rendering intent
|
1654
1659
|
# @option opts [String] :output_profile Filename to load output profile from
|
1655
1660
|
# @option opts [Integer] :depth Output device space depth in bits
|
1656
1661
|
# @return [Vips::Image] Output image
|
@@ -1658,9 +1663,9 @@ module Vips
|
|
1658
1663
|
# @!method icc_transform(output_profile, opts = {})
|
1659
1664
|
# Transform between devices with icc profiles.
|
1660
1665
|
# @param output_profile [String] Filename to load output profile from
|
1661
|
-
# @param [Hash]
|
1662
|
-
# @option opts [Vips::Intent] :intent Rendering intent
|
1666
|
+
# @param opts [Hash] Set of options
|
1663
1667
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1668
|
+
# @option opts [Vips::Intent] :intent Rendering intent
|
1664
1669
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
1665
1670
|
# @option opts [String] :input_profile Filename to load input profile from
|
1666
1671
|
# @option opts [Integer] :depth Output device space depth in bits
|
@@ -1669,111 +1674,111 @@ module Vips
|
|
1669
1674
|
# @!method dE76(right, opts = {})
|
1670
1675
|
# Calculate de76.
|
1671
1676
|
# @param right [Vips::Image] Right-hand input image
|
1672
|
-
# @param [Hash]
|
1677
|
+
# @param opts [Hash] Set of options
|
1673
1678
|
# @return [Vips::Image] Output image
|
1674
1679
|
|
1675
1680
|
# @!method dE00(right, opts = {})
|
1676
1681
|
# Calculate de00.
|
1677
1682
|
# @param right [Vips::Image] Right-hand input image
|
1678
|
-
# @param [Hash]
|
1683
|
+
# @param opts [Hash] Set of options
|
1679
1684
|
# @return [Vips::Image] Output image
|
1680
1685
|
|
1681
1686
|
# @!method dECMC(right, opts = {})
|
1682
1687
|
# Calculate decmc.
|
1683
1688
|
# @param right [Vips::Image] Right-hand input image
|
1684
|
-
# @param [Hash]
|
1689
|
+
# @param opts [Hash] Set of options
|
1685
1690
|
# @return [Vips::Image] Output image
|
1686
1691
|
|
1687
1692
|
# @!method sRGB2scRGB(opts = {})
|
1688
1693
|
# Convert an srgb image to scrgb.
|
1689
|
-
# @param [Hash]
|
1694
|
+
# @param opts [Hash] Set of options
|
1690
1695
|
# @return [Vips::Image] Output image
|
1691
1696
|
|
1692
1697
|
# @!method scRGB2BW(opts = {})
|
1693
1698
|
# Convert scrgb to bw.
|
1694
|
-
# @param [Hash]
|
1699
|
+
# @param opts [Hash] Set of options
|
1695
1700
|
# @option opts [Integer] :depth Output device space depth in bits
|
1696
1701
|
# @return [Vips::Image] Output image
|
1697
1702
|
|
1698
1703
|
# @!method scRGB2sRGB(opts = {})
|
1699
1704
|
# Convert an scrgb image to srgb.
|
1700
|
-
# @param [Hash]
|
1705
|
+
# @param opts [Hash] Set of options
|
1701
1706
|
# @option opts [Integer] :depth Output device space depth in bits
|
1702
1707
|
# @return [Vips::Image] Output image
|
1703
1708
|
|
1704
1709
|
# @!method maplut(lut, opts = {})
|
1705
1710
|
# Map an image though a lut.
|
1706
1711
|
# @param lut [Vips::Image] Look-up table image
|
1707
|
-
# @param [Hash]
|
1712
|
+
# @param opts [Hash] Set of options
|
1708
1713
|
# @option opts [Integer] :band apply one-band lut to this band of in
|
1709
1714
|
# @return [Vips::Image] Output image
|
1710
1715
|
|
1711
1716
|
# @!method percent(percent, opts = {})
|
1712
1717
|
# Find threshold for percent of pixels.
|
1713
1718
|
# @param percent [Float] Percent of pixels
|
1714
|
-
# @param [Hash]
|
1719
|
+
# @param opts [Hash] Set of options
|
1715
1720
|
# @return [Integer] Threshold above which lie percent of pixels
|
1716
1721
|
|
1717
1722
|
# @!method stdif(width, height, opts = {})
|
1718
1723
|
# Statistical difference.
|
1719
1724
|
# @param width [Integer] Window width in pixels
|
1720
1725
|
# @param height [Integer] Window height in pixels
|
1721
|
-
# @param [Hash]
|
1722
|
-
# @option opts [Float] :a Weight of new mean
|
1723
|
-
# @option opts [Float] :m0 New mean
|
1724
|
-
# @option opts [Float] :b Weight of new deviation
|
1726
|
+
# @param opts [Hash] Set of options
|
1725
1727
|
# @option opts [Float] :s0 New deviation
|
1728
|
+
# @option opts [Float] :b Weight of new deviation
|
1729
|
+
# @option opts [Float] :m0 New mean
|
1730
|
+
# @option opts [Float] :a Weight of new mean
|
1726
1731
|
# @return [Vips::Image] Output image
|
1727
1732
|
|
1728
1733
|
# @!method hist_cum(opts = {})
|
1729
1734
|
# Form cumulative histogram.
|
1730
|
-
# @param [Hash]
|
1735
|
+
# @param opts [Hash] Set of options
|
1731
1736
|
# @return [Vips::Image] Output image
|
1732
1737
|
|
1733
1738
|
# @!method hist_match(ref, opts = {})
|
1734
1739
|
# Match two histograms.
|
1735
1740
|
# @param ref [Vips::Image] Reference histogram
|
1736
|
-
# @param [Hash]
|
1741
|
+
# @param opts [Hash] Set of options
|
1737
1742
|
# @return [Vips::Image] Output image
|
1738
1743
|
|
1739
1744
|
# @!method hist_norm(opts = {})
|
1740
1745
|
# Normalise histogram.
|
1741
|
-
# @param [Hash]
|
1746
|
+
# @param opts [Hash] Set of options
|
1742
1747
|
# @return [Vips::Image] Output image
|
1743
1748
|
|
1744
1749
|
# @!method hist_equal(opts = {})
|
1745
1750
|
# Histogram equalisation.
|
1746
|
-
# @param [Hash]
|
1751
|
+
# @param opts [Hash] Set of options
|
1747
1752
|
# @option opts [Integer] :band Equalise with this band
|
1748
1753
|
# @return [Vips::Image] Output image
|
1749
1754
|
|
1750
1755
|
# @!method hist_plot(opts = {})
|
1751
1756
|
# Plot histogram.
|
1752
|
-
# @param [Hash]
|
1757
|
+
# @param opts [Hash] Set of options
|
1753
1758
|
# @return [Vips::Image] Output image
|
1754
1759
|
|
1755
1760
|
# @!method hist_local(width, height, opts = {})
|
1756
1761
|
# Local histogram equalisation.
|
1757
1762
|
# @param width [Integer] Window width in pixels
|
1758
1763
|
# @param height [Integer] Window height in pixels
|
1759
|
-
# @param [Hash]
|
1764
|
+
# @param opts [Hash] Set of options
|
1760
1765
|
# @option opts [Integer] :max_slope Maximum slope (CLAHE)
|
1761
1766
|
# @return [Vips::Image] Output image
|
1762
1767
|
|
1763
1768
|
# @!method hist_ismonotonic(opts = {})
|
1764
1769
|
# Test for monotonicity.
|
1765
|
-
# @param [Hash]
|
1770
|
+
# @param opts [Hash] Set of options
|
1766
1771
|
# @return [Boolean] true if in is monotonic
|
1767
1772
|
|
1768
1773
|
# @!method hist_entropy(opts = {})
|
1769
1774
|
# Estimate image entropy.
|
1770
|
-
# @param [Hash]
|
1775
|
+
# @param opts [Hash] Set of options
|
1771
1776
|
# @return [Float] Output value
|
1772
1777
|
|
1773
1778
|
# @!method conv(mask, opts = {})
|
1774
1779
|
# Convolution operation.
|
1775
1780
|
# @param mask [Vips::Image] Input matrix image
|
1776
|
-
# @param [Hash]
|
1781
|
+
# @param opts [Hash] Set of options
|
1777
1782
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
1778
1783
|
# @option opts [Integer] :layers Use this many layers in approximation
|
1779
1784
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
@@ -1782,7 +1787,7 @@ module Vips
|
|
1782
1787
|
# @!method conva(mask, opts = {})
|
1783
1788
|
# Approximate integer convolution.
|
1784
1789
|
# @param mask [Vips::Image] Input matrix image
|
1785
|
-
# @param [Hash]
|
1790
|
+
# @param opts [Hash] Set of options
|
1786
1791
|
# @option opts [Integer] :layers Use this many layers in approximation
|
1787
1792
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
1788
1793
|
# @return [Vips::Image] Output image
|
@@ -1790,19 +1795,19 @@ module Vips
|
|
1790
1795
|
# @!method convf(mask, opts = {})
|
1791
1796
|
# Float convolution operation.
|
1792
1797
|
# @param mask [Vips::Image] Input matrix image
|
1793
|
-
# @param [Hash]
|
1798
|
+
# @param opts [Hash] Set of options
|
1794
1799
|
# @return [Vips::Image] Output image
|
1795
1800
|
|
1796
1801
|
# @!method convi(mask, opts = {})
|
1797
1802
|
# Int convolution operation.
|
1798
1803
|
# @param mask [Vips::Image] Input matrix image
|
1799
|
-
# @param [Hash]
|
1804
|
+
# @param opts [Hash] Set of options
|
1800
1805
|
# @return [Vips::Image] Output image
|
1801
1806
|
|
1802
1807
|
# @!method compass(mask, opts = {})
|
1803
1808
|
# Convolve with rotating mask.
|
1804
1809
|
# @param mask [Vips::Image] Input matrix image
|
1805
|
-
# @param [Hash]
|
1810
|
+
# @param opts [Hash] Set of options
|
1806
1811
|
# @option opts [Integer] :times Rotate and convolve this many times
|
1807
1812
|
# @option opts [Vips::Angle45] :angle Rotate mask by this much between convolutions
|
1808
1813
|
# @option opts [Vips::Combine] :combine Combine convolution results like this
|
@@ -1814,7 +1819,7 @@ module Vips
|
|
1814
1819
|
# @!method convsep(mask, opts = {})
|
1815
1820
|
# Seperable convolution operation.
|
1816
1821
|
# @param mask [Vips::Image] Input matrix image
|
1817
|
-
# @param [Hash]
|
1822
|
+
# @param opts [Hash] Set of options
|
1818
1823
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
1819
1824
|
# @option opts [Integer] :layers Use this many layers in approximation
|
1820
1825
|
# @option opts [Integer] :cluster Cluster lines closer than this in approximation
|
@@ -1823,25 +1828,25 @@ module Vips
|
|
1823
1828
|
# @!method convasep(mask, opts = {})
|
1824
1829
|
# Approximate separable integer convolution.
|
1825
1830
|
# @param mask [Vips::Image] Input matrix image
|
1826
|
-
# @param [Hash]
|
1831
|
+
# @param opts [Hash] Set of options
|
1827
1832
|
# @option opts [Integer] :layers Use this many layers in approximation
|
1828
1833
|
# @return [Vips::Image] Output image
|
1829
1834
|
|
1830
1835
|
# @!method fastcor(ref, opts = {})
|
1831
1836
|
# Fast correlation.
|
1832
1837
|
# @param ref [Vips::Image] Input reference image
|
1833
|
-
# @param [Hash]
|
1838
|
+
# @param opts [Hash] Set of options
|
1834
1839
|
# @return [Vips::Image] Output image
|
1835
1840
|
|
1836
1841
|
# @!method spcor(ref, opts = {})
|
1837
1842
|
# Spatial correlation.
|
1838
1843
|
# @param ref [Vips::Image] Input reference image
|
1839
|
-
# @param [Hash]
|
1844
|
+
# @param opts [Hash] Set of options
|
1840
1845
|
# @return [Vips::Image] Output image
|
1841
1846
|
|
1842
1847
|
# @!method sharpen(opts = {})
|
1843
1848
|
# Unsharp masking for print.
|
1844
|
-
# @param [Hash]
|
1849
|
+
# @param opts [Hash] Set of options
|
1845
1850
|
# @option opts [Float] :sigma Sigma of Gaussian
|
1846
1851
|
# @option opts [Float] :x1 Flat/jaggy threshold
|
1847
1852
|
# @option opts [Float] :y2 Maximum brightening
|
@@ -1853,44 +1858,44 @@ module Vips
|
|
1853
1858
|
# @!method gaussblur(sigma, opts = {})
|
1854
1859
|
# Gaussian blur.
|
1855
1860
|
# @param sigma [Float] Sigma of Gaussian
|
1856
|
-
# @param [Hash]
|
1861
|
+
# @param opts [Hash] Set of options
|
1857
1862
|
# @option opts [Float] :min_ampl Minimum amplitude of Gaussian
|
1858
1863
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
1859
1864
|
# @return [Vips::Image] Output image
|
1860
1865
|
|
1861
1866
|
# @!method fwfft(opts = {})
|
1862
1867
|
# Forward fft.
|
1863
|
-
# @param [Hash]
|
1868
|
+
# @param opts [Hash] Set of options
|
1864
1869
|
# @return [Vips::Image] Output image
|
1865
1870
|
|
1866
1871
|
# @!method invfft(opts = {})
|
1867
1872
|
# Inverse fft.
|
1868
|
-
# @param [Hash]
|
1873
|
+
# @param opts [Hash] Set of options
|
1869
1874
|
# @option opts [Boolean] :real Output only the real part of the transform
|
1870
1875
|
# @return [Vips::Image] Output image
|
1871
1876
|
|
1872
1877
|
# @!method freqmult(mask, opts = {})
|
1873
1878
|
# Frequency-domain filtering.
|
1874
1879
|
# @param mask [Vips::Image] Input mask image
|
1875
|
-
# @param [Hash]
|
1880
|
+
# @param opts [Hash] Set of options
|
1876
1881
|
# @return [Vips::Image] Output image
|
1877
1882
|
|
1878
1883
|
# @!method spectrum(opts = {})
|
1879
1884
|
# Make displayable power spectrum.
|
1880
|
-
# @param [Hash]
|
1885
|
+
# @param opts [Hash] Set of options
|
1881
1886
|
# @return [Vips::Image] Output image
|
1882
1887
|
|
1883
1888
|
# @!method phasecor(in2, opts = {})
|
1884
1889
|
# Calculate phase correlation.
|
1885
1890
|
# @param in2 [Vips::Image] Second input image
|
1886
|
-
# @param [Hash]
|
1891
|
+
# @param opts [Hash] Set of options
|
1887
1892
|
# @return [Vips::Image] Output image
|
1888
1893
|
|
1889
1894
|
# @!method morph(mask, morph, opts = {})
|
1890
1895
|
# Morphology operation.
|
1891
1896
|
# @param mask [Vips::Image] Input matrix image
|
1892
1897
|
# @param morph [Vips::OperationMorphology] Morphological operation to perform
|
1893
|
-
# @param [Hash]
|
1898
|
+
# @param opts [Hash] Set of options
|
1894
1899
|
# @return [Vips::Image] Output image
|
1895
1900
|
|
1896
1901
|
# @!method rank(width, height, index, opts = {})
|
@@ -1898,18 +1903,18 @@ module Vips
|
|
1898
1903
|
# @param width [Integer] Window width in pixels
|
1899
1904
|
# @param height [Integer] Window height in pixels
|
1900
1905
|
# @param index [Integer] Select pixel at index
|
1901
|
-
# @param [Hash]
|
1906
|
+
# @param opts [Hash] Set of options
|
1902
1907
|
# @return [Vips::Image] Output image
|
1903
1908
|
|
1904
1909
|
# @!method countlines(direction, opts = {})
|
1905
1910
|
# Count lines in an image.
|
1906
1911
|
# @param direction [Vips::Direction] Countlines left-right or up-down
|
1907
|
-
# @param [Hash]
|
1912
|
+
# @param opts [Hash] Set of options
|
1908
1913
|
# @return [Float] Number of lines
|
1909
1914
|
|
1910
1915
|
# @!method labelregions(opts = {})
|
1911
1916
|
# Label regions in an image.
|
1912
|
-
# @param [Hash]
|
1917
|
+
# @param opts [Hash] Set of options
|
1913
1918
|
# @option opts [Integer] :segments Output Number of discrete contigious regions
|
1914
1919
|
# @return [Vips::Image, Hash<Symbol => Object>] Mask of region labels, Hash of optional output items
|
1915
1920
|
|
@@ -1920,7 +1925,7 @@ module Vips
|
|
1920
1925
|
# @param top [Integer] Rect to fill
|
1921
1926
|
# @param width [Integer] Rect to fill
|
1922
1927
|
# @param height [Integer] Rect to fill
|
1923
|
-
# @param [Hash]
|
1928
|
+
# @param opts [Hash] Set of options
|
1924
1929
|
# @option opts [Boolean] :fill Draw a solid object
|
1925
1930
|
# @return [Vips::Image] Image to draw on
|
1926
1931
|
|
@@ -1930,7 +1935,7 @@ module Vips
|
|
1930
1935
|
# @param mask [Vips::Image] Mask of pixels to draw
|
1931
1936
|
# @param x [Integer] Draw mask here
|
1932
1937
|
# @param y [Integer] Draw mask here
|
1933
|
-
# @param [Hash]
|
1938
|
+
# @param opts [Hash] Set of options
|
1934
1939
|
# @return [Vips::Image] Image to draw on
|
1935
1940
|
|
1936
1941
|
# @!method draw_line(ink, x1, y1, x2, y2, opts = {})
|
@@ -1940,7 +1945,7 @@ module Vips
|
|
1940
1945
|
# @param y1 [Integer] Start of draw_line
|
1941
1946
|
# @param x2 [Integer] End of draw_line
|
1942
1947
|
# @param y2 [Integer] End of draw_line
|
1943
|
-
# @param [Hash]
|
1948
|
+
# @param opts [Hash] Set of options
|
1944
1949
|
# @return [Vips::Image] Image to draw on
|
1945
1950
|
|
1946
1951
|
# @!method draw_circle(ink, cx, cy, radius, opts = {})
|
@@ -1949,7 +1954,7 @@ module Vips
|
|
1949
1954
|
# @param cx [Integer] Centre of draw_circle
|
1950
1955
|
# @param cy [Integer] Centre of draw_circle
|
1951
1956
|
# @param radius [Integer] Radius in pixels
|
1952
|
-
# @param [Hash]
|
1957
|
+
# @param opts [Hash] Set of options
|
1953
1958
|
# @option opts [Boolean] :fill Draw a solid object
|
1954
1959
|
# @return [Vips::Image] Image to draw on
|
1955
1960
|
|
@@ -1958,7 +1963,7 @@ module Vips
|
|
1958
1963
|
# @param ink [Array<Double>] Color for pixels
|
1959
1964
|
# @param x [Integer] DrawFlood start point
|
1960
1965
|
# @param y [Integer] DrawFlood start point
|
1961
|
-
# @param [Hash]
|
1966
|
+
# @param opts [Hash] Set of options
|
1962
1967
|
# @option opts [Vips::Image] :test Test pixels in this image
|
1963
1968
|
# @option opts [Boolean] :equal DrawFlood while equal to edge
|
1964
1969
|
# @option opts [Integer] :left Output Left edge of modified area
|
@@ -1972,7 +1977,7 @@ module Vips
|
|
1972
1977
|
# @param sub [Vips::Image] Sub-image to insert into main image
|
1973
1978
|
# @param x [Integer] Draw image here
|
1974
1979
|
# @param y [Integer] Draw image here
|
1975
|
-
# @param [Hash]
|
1980
|
+
# @param opts [Hash] Set of options
|
1976
1981
|
# @option opts [Vips::CombineMode] :mode Combining mode
|
1977
1982
|
# @return [Vips::Image] Image to draw on
|
1978
1983
|
|
@@ -1982,7 +1987,7 @@ module Vips
|
|
1982
1987
|
# @param top [Integer] Rect to fill
|
1983
1988
|
# @param width [Integer] Rect to fill
|
1984
1989
|
# @param height [Integer] Rect to fill
|
1985
|
-
# @param [Hash]
|
1990
|
+
# @param opts [Hash] Set of options
|
1986
1991
|
# @return [Vips::Image] Image to draw on
|
1987
1992
|
|
1988
1993
|
# @!method merge(sec, direction, dx, dy, opts = {})
|
@@ -1991,7 +1996,7 @@ module Vips
|
|
1991
1996
|
# @param direction [Vips::Direction] Horizontal or vertcial merge
|
1992
1997
|
# @param dx [Integer] Horizontal displacement from sec to ref
|
1993
1998
|
# @param dy [Integer] Vertical displacement from sec to ref
|
1994
|
-
# @param [Hash]
|
1999
|
+
# @param opts [Hash] Set of options
|
1995
2000
|
# @option opts [Integer] :mblend Maximum blend size
|
1996
2001
|
# @return [Vips::Image] Output image
|
1997
2002
|
|
@@ -2003,7 +2008,7 @@ module Vips
|
|
2003
2008
|
# @param yref [Integer] Position of reference tie-point
|
2004
2009
|
# @param xsec [Integer] Position of secondary tie-point
|
2005
2010
|
# @param ysec [Integer] Position of secondary tie-point
|
2006
|
-
# @param [Hash]
|
2011
|
+
# @param opts [Hash] Set of options
|
2007
2012
|
# @option opts [Integer] :hwindow Half window size
|
2008
2013
|
# @option opts [Integer] :harea Half area size
|
2009
2014
|
# @option opts [Integer] :mblend Maximum blend size
|
@@ -2012,8 +2017,8 @@ module Vips
|
|
2012
2017
|
# @option opts [Integer] :dy0 Output Detected integer offset
|
2013
2018
|
# @option opts [Float] :scale1 Output Detected scale
|
2014
2019
|
# @option opts [Float] :angle1 Output Detected rotation
|
2015
|
-
# @option opts [Float] :dx1 Output Detected first-order displacement
|
2016
2020
|
# @option opts [Float] :dy1 Output Detected first-order displacement
|
2021
|
+
# @option opts [Float] :dx1 Output Detected first-order displacement
|
2017
2022
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
2018
2023
|
|
2019
2024
|
# @!method mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {})
|
@@ -2028,7 +2033,7 @@ module Vips
|
|
2028
2033
|
# @param yr2 [Integer] Position of second reference tie-point
|
2029
2034
|
# @param xs2 [Integer] Position of second secondary tie-point
|
2030
2035
|
# @param ys2 [Integer] Position of second secondary tie-point
|
2031
|
-
# @param [Hash]
|
2036
|
+
# @param opts [Hash] Set of options
|
2032
2037
|
# @option opts [Integer] :hwindow Half window size
|
2033
2038
|
# @option opts [Integer] :harea Half area size
|
2034
2039
|
# @option opts [Boolean] :search Search to improve tie-points
|
@@ -2048,7 +2053,7 @@ module Vips
|
|
2048
2053
|
# @param yr2 [Integer] Position of second reference tie-point
|
2049
2054
|
# @param xs2 [Integer] Position of second secondary tie-point
|
2050
2055
|
# @param ys2 [Integer] Position of second secondary tie-point
|
2051
|
-
# @param [Hash]
|
2056
|
+
# @param opts [Hash] Set of options
|
2052
2057
|
# @option opts [Integer] :hwindow Half window size
|
2053
2058
|
# @option opts [Integer] :harea Half area size
|
2054
2059
|
# @option opts [Boolean] :search Search to improve tie-points
|
@@ -2057,7 +2062,7 @@ module Vips
|
|
2057
2062
|
|
2058
2063
|
# @!method globalbalance(opts = {})
|
2059
2064
|
# Global balance an image mosaic.
|
2060
|
-
# @param [Hash]
|
2065
|
+
# @param opts [Hash] Set of options
|
2061
2066
|
# @option opts [Float] :gamma Image gamma
|
2062
2067
|
# @option opts [Boolean] :int_output Integer output
|
2063
2068
|
# @return [Vips::Image] Output image
|