ruby-vips 2.0.15 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/ISSUE_TEMPLATE/bug_report.md +42 -0
- data/.github/workflows/test.yml +80 -0
- data/.standard.yml +17 -0
- data/.yardopts +0 -1
- data/CHANGELOG.md +39 -0
- data/Gemfile +3 -1
- data/README.md +42 -41
- data/Rakefile +13 -21
- data/TODO +14 -14
- data/VERSION +1 -1
- data/example/annotate.rb +6 -6
- data/example/connection.rb +26 -0
- data/example/daltonize8.rb +6 -6
- data/example/draw_lines.rb +30 -0
- data/example/example1.rb +4 -4
- data/example/example2.rb +6 -6
- data/example/example3.rb +5 -5
- data/example/example4.rb +2 -2
- data/example/example5.rb +4 -4
- data/example/inheritance_with_refcount.rb +35 -36
- data/example/progress.rb +30 -0
- data/example/thumb.rb +6 -6
- data/example/trim8.rb +1 -1
- data/example/watermark.rb +2 -2
- data/example/wobble.rb +1 -1
- data/lib/ruby-vips.rb +1 -1
- data/lib/vips.rb +191 -79
- data/lib/vips/blend_mode.rb +29 -25
- data/lib/vips/connection.rb +46 -0
- data/lib/vips/gobject.rb +27 -12
- data/lib/vips/gvalue.rb +62 -50
- data/lib/vips/image.rb +475 -256
- data/lib/vips/interpolate.rb +3 -2
- data/lib/vips/methods.rb +788 -121
- data/lib/vips/mutableimage.rb +173 -0
- data/lib/vips/object.rb +171 -54
- data/lib/vips/operation.rb +272 -117
- data/lib/vips/region.rb +73 -0
- data/lib/vips/source.rb +88 -0
- data/lib/vips/sourcecustom.rb +89 -0
- data/lib/vips/target.rb +86 -0
- data/lib/vips/targetcustom.rb +77 -0
- data/lib/vips/version.rb +1 -1
- data/ruby-vips.gemspec +26 -20
- metadata +39 -50
- data/.rubocop.yml +0 -22
- data/.rubocop_todo.yml +0 -515
- data/.travis.yml +0 -62
- data/install-vips.sh +0 -26
data/lib/vips/interpolate.rb
CHANGED
@@ -48,8 +48,9 @@ module Vips
|
|
48
48
|
end
|
49
49
|
|
50
50
|
def initialize name
|
51
|
-
|
52
|
-
|
51
|
+
name = name.to_s if name.is_a? Symbol
|
52
|
+
ptr = Vips.vips_interpolate_new name
|
53
|
+
raise Vips::Error if ptr.nil?
|
53
54
|
|
54
55
|
super ptr
|
55
56
|
end
|
data/lib/vips/methods.rb
CHANGED
@@ -265,6 +265,7 @@ module Vips
|
|
265
265
|
# @!method copy(**opts)
|
266
266
|
# Copy an image.
|
267
267
|
# @param opts [Hash] Set of options
|
268
|
+
# @option opts [Boolean] :swap Swap bytes in image between little and big-endian
|
268
269
|
# @option opts [Integer] :width Image width in pixels
|
269
270
|
# @option opts [Integer] :height Image height in pixels
|
270
271
|
# @option opts [Integer] :bands Number of bands in image
|
@@ -300,7 +301,9 @@ module Vips
|
|
300
301
|
# @!method sequential(**opts)
|
301
302
|
# Check sequential access.
|
302
303
|
# @param opts [Hash] Set of options
|
304
|
+
# @option opts [Boolean] :trace trace pixel requests
|
303
305
|
# @option opts [Integer] :tile_height Tile height in pixels
|
306
|
+
# @option opts [Vips::Access] :access Expected access pattern
|
304
307
|
# @return [Vips::Image] Output image
|
305
308
|
|
306
309
|
# @!method cache(**opts)
|
@@ -381,7 +384,7 @@ module Vips
|
|
381
384
|
# @param opts [Hash] Set of options
|
382
385
|
# @return [Vips::Image] Output image
|
383
386
|
|
384
|
-
# @!method
|
387
|
+
# @!method crop(left, top, width, height, **opts)
|
385
388
|
# Extract an area from an image.
|
386
389
|
# @param left [Integer] Left edge of extract area
|
387
390
|
# @param top [Integer] Top edge of extract area
|
@@ -459,6 +462,7 @@ module Vips
|
|
459
462
|
# Autorotate image by exif tag.
|
460
463
|
# @param opts [Hash] Set of options
|
461
464
|
# @option opts [Vips::Angle] :angle Output Angle image was rotated by
|
465
|
+
# @option opts [Boolean] :flip Output Whether the image was flipped or not
|
462
466
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
463
467
|
|
464
468
|
# @!method recomb(m, **opts)
|
@@ -496,6 +500,7 @@ module Vips
|
|
496
500
|
# Unpremultiply image alpha.
|
497
501
|
# @param opts [Hash] Set of options
|
498
502
|
# @option opts [Float] :max_alpha Maximum value of alpha channel
|
503
|
+
# @option opts [Integer] :alpha_band Unpremultiply with this alpha
|
499
504
|
# @return [Vips::Image] Output image
|
500
505
|
|
501
506
|
# @!method grid(tile_height, across, down, **opts)
|
@@ -582,23 +587,9 @@ module Vips
|
|
582
587
|
# @param opts [Hash] Set of options
|
583
588
|
# @option opts [Float] :sigma Standard deviation of pixels in generated image
|
584
589
|
# @option opts [Float] :mean Mean of pixels in generated image
|
590
|
+
# @option opts [Integer] :seed Random number seed
|
585
591
|
# @return [Vips::Image] Output image
|
586
592
|
|
587
|
-
# @!method self.text(text, **opts)
|
588
|
-
# Make a text image.
|
589
|
-
# @param text [String] Text to render
|
590
|
-
# @param opts [Hash] Set of options
|
591
|
-
# @option opts [String] :font Font to render with
|
592
|
-
# @option opts [Integer] :width Maximum image width in pixels
|
593
|
-
# @option opts [Integer] :height Maximum image height in pixels
|
594
|
-
# @option opts [Vips::Align] :align Align on the low, centre or high edge
|
595
|
-
# @option opts [Integer] :dpi DPI to render at
|
596
|
-
# @option opts [Boolean] :justify Justify lines
|
597
|
-
# @option opts [Integer] :spacing Line spacing
|
598
|
-
# @option opts [String] :fontfile Load this font file
|
599
|
-
# @option opts [Integer] :autofit_dpi Output DPI selected by autofit
|
600
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
601
|
-
|
602
593
|
# @!method self.xyz(width, height, **opts)
|
603
594
|
# Make an image where pixel values are coordinates.
|
604
595
|
# @param width [Integer] Image width in pixels
|
@@ -615,6 +606,7 @@ module Vips
|
|
615
606
|
# @param min_ampl [Float] Minimum amplitude of Gaussian
|
616
607
|
# @param opts [Hash] Set of options
|
617
608
|
# @option opts [Boolean] :separable Generate separable Gaussian
|
609
|
+
# @option opts [Boolean] :integer Generate integer Gaussian
|
618
610
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
619
611
|
# @return [Vips::Image] Output image
|
620
612
|
|
@@ -624,9 +616,26 @@ module Vips
|
|
624
616
|
# @param min_ampl [Float] Minimum amplitude of Logmatian
|
625
617
|
# @param opts [Hash] Set of options
|
626
618
|
# @option opts [Boolean] :separable Generate separable Logmatian
|
619
|
+
# @option opts [Boolean] :integer Generate integer Logmatian
|
627
620
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
628
621
|
# @return [Vips::Image] Output image
|
629
622
|
|
623
|
+
# @!method self.text(text, **opts)
|
624
|
+
# Make a text image.
|
625
|
+
# @param text [String] Text to render
|
626
|
+
# @param opts [Hash] Set of options
|
627
|
+
# @option opts [String] :font Font to render with
|
628
|
+
# @option opts [Integer] :width Maximum image width in pixels
|
629
|
+
# @option opts [Integer] :height Maximum image height in pixels
|
630
|
+
# @option opts [Vips::Align] :align Align on the low, centre or high edge
|
631
|
+
# @option opts [Boolean] :rgba Enable RGBA output
|
632
|
+
# @option opts [Integer] :dpi DPI to render at
|
633
|
+
# @option opts [Boolean] :justify Justify lines
|
634
|
+
# @option opts [Integer] :spacing Line spacing
|
635
|
+
# @option opts [String] :fontfile Load this font file
|
636
|
+
# @option opts [Integer] :autofit_dpi Output DPI selected by autofit
|
637
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
638
|
+
|
630
639
|
# @!method self.eye(width, height, **opts)
|
631
640
|
# Make an image showing the eye's spatial response.
|
632
641
|
# @param width [Integer] Image width in pixels
|
@@ -848,6 +857,7 @@ module Vips
|
|
848
857
|
# @param height [Integer] Image height in pixels
|
849
858
|
# @param opts [Hash] Set of options
|
850
859
|
# @option opts [Integer] :cell_size Size of Worley cells
|
860
|
+
# @option opts [Integer] :seed Random number seed
|
851
861
|
# @return [Vips::Image] Output image
|
852
862
|
|
853
863
|
# @!method self.perlin(width, height, **opts)
|
@@ -857,10 +867,17 @@ module Vips
|
|
857
867
|
# @param opts [Hash] Set of options
|
858
868
|
# @option opts [Integer] :cell_size Size of Perlin cells
|
859
869
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
870
|
+
# @option opts [Integer] :seed Random number seed
|
871
|
+
# @return [Vips::Image] Output image
|
872
|
+
|
873
|
+
# @!method self.switch(tests, **opts)
|
874
|
+
# Find the index of the first non-zero pixel in tests.
|
875
|
+
# @param tests [Array<Image>] Table of images to test
|
876
|
+
# @param opts [Hash] Set of options
|
860
877
|
# @return [Vips::Image] Output image
|
861
878
|
|
862
879
|
# @!method self.csvload(filename, **opts)
|
863
|
-
# Load csv
|
880
|
+
# Load csv.
|
864
881
|
# @param filename [String] Filename to load from
|
865
882
|
# @param opts [Hash] Set of options
|
866
883
|
# @option opts [Integer] :skip Skip this many lines at the start of the file
|
@@ -869,17 +886,49 @@ module Vips
|
|
869
886
|
# @option opts [String] :separator Set of separator characters
|
870
887
|
# @option opts [Boolean] :memory Force open via memory
|
871
888
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
889
|
+
# @option opts [Boolean] :sequential Sequential read only
|
872
890
|
# @option opts [Boolean] :fail Fail on first error
|
891
|
+
# @option opts [Boolean] :disc Open to disc
|
892
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
893
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
894
|
+
|
895
|
+
# @!method self.csvload_source(source, **opts)
|
896
|
+
# Load csv.
|
897
|
+
# @param source [Vips::Source] Source to load from
|
898
|
+
# @param opts [Hash] Set of options
|
899
|
+
# @option opts [Integer] :skip Skip this many lines at the start of the file
|
900
|
+
# @option opts [Integer] :lines Read this many lines from the file
|
901
|
+
# @option opts [String] :whitespace Set of whitespace characters
|
902
|
+
# @option opts [String] :separator Set of separator characters
|
903
|
+
# @option opts [Boolean] :memory Force open via memory
|
904
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
905
|
+
# @option opts [Boolean] :sequential Sequential read only
|
906
|
+
# @option opts [Boolean] :fail Fail on first error
|
907
|
+
# @option opts [Boolean] :disc Open to disc
|
873
908
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
874
909
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
875
910
|
|
876
911
|
# @!method self.matrixload(filename, **opts)
|
877
|
-
# Load matrix
|
912
|
+
# Load matrix.
|
878
913
|
# @param filename [String] Filename to load from
|
879
914
|
# @param opts [Hash] Set of options
|
880
915
|
# @option opts [Boolean] :memory Force open via memory
|
881
916
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
917
|
+
# @option opts [Boolean] :sequential Sequential read only
|
882
918
|
# @option opts [Boolean] :fail Fail on first error
|
919
|
+
# @option opts [Boolean] :disc Open to disc
|
920
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
921
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
922
|
+
|
923
|
+
# @!method self.matrixload_source(source, **opts)
|
924
|
+
# Load matrix.
|
925
|
+
# @param source [Vips::Source] Source to load from
|
926
|
+
# @param opts [Hash] Set of options
|
927
|
+
# @option opts [Boolean] :memory Force open via memory
|
928
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
929
|
+
# @option opts [Boolean] :sequential Sequential read only
|
930
|
+
# @option opts [Boolean] :fail Fail on first error
|
931
|
+
# @option opts [Boolean] :disc Open to disc
|
883
932
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
884
933
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
885
934
|
|
@@ -891,9 +940,13 @@ module Vips
|
|
891
940
|
# @param bands [Integer] Number of bands in image
|
892
941
|
# @param opts [Hash] Set of options
|
893
942
|
# @option opts [guint64] :offset Offset in bytes from start of file
|
943
|
+
# @option opts [Vips::BandFormat] :format Pixel format in image
|
944
|
+
# @option opts [Vips::Interpretation] :interpretation Pixel interpretation
|
894
945
|
# @option opts [Boolean] :memory Force open via memory
|
895
946
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
947
|
+
# @option opts [Boolean] :sequential Sequential read only
|
896
948
|
# @option opts [Boolean] :fail Fail on first error
|
949
|
+
# @option opts [Boolean] :disc Open to disc
|
897
950
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
898
951
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
899
952
|
|
@@ -903,7 +956,21 @@ module Vips
|
|
903
956
|
# @param opts [Hash] Set of options
|
904
957
|
# @option opts [Boolean] :memory Force open via memory
|
905
958
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
959
|
+
# @option opts [Boolean] :sequential Sequential read only
|
960
|
+
# @option opts [Boolean] :fail Fail on first error
|
961
|
+
# @option opts [Boolean] :disc Open to disc
|
962
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
963
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
964
|
+
|
965
|
+
# @!method self.vipsload_source(source, **opts)
|
966
|
+
# Load vips from source.
|
967
|
+
# @param source [Vips::Source] Source to load from
|
968
|
+
# @param opts [Hash] Set of options
|
969
|
+
# @option opts [Boolean] :memory Force open via memory
|
970
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
971
|
+
# @option opts [Boolean] :sequential Sequential read only
|
906
972
|
# @option opts [Boolean] :fail Fail on first error
|
973
|
+
# @option opts [Boolean] :disc Open to disc
|
907
974
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
908
975
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
909
976
|
|
@@ -913,7 +980,9 @@ module Vips
|
|
913
980
|
# @param opts [Hash] Set of options
|
914
981
|
# @option opts [Boolean] :memory Force open via memory
|
915
982
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
983
|
+
# @option opts [Boolean] :sequential Sequential read only
|
916
984
|
# @option opts [Boolean] :fail Fail on first error
|
985
|
+
# @option opts [Boolean] :disc Open to disc
|
917
986
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
918
987
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
919
988
|
|
@@ -923,7 +992,21 @@ module Vips
|
|
923
992
|
# @param opts [Hash] Set of options
|
924
993
|
# @option opts [Boolean] :memory Force open via memory
|
925
994
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
995
|
+
# @option opts [Boolean] :sequential Sequential read only
|
926
996
|
# @option opts [Boolean] :fail Fail on first error
|
997
|
+
# @option opts [Boolean] :disc Open to disc
|
998
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
999
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1000
|
+
|
1001
|
+
# @!method self.ppmload_source(source, **opts)
|
1002
|
+
# Load ppm base class.
|
1003
|
+
# @param source [Vips::Source] Source to load from
|
1004
|
+
# @param opts [Hash] Set of options
|
1005
|
+
# @option opts [Boolean] :memory Force open via memory
|
1006
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1007
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1008
|
+
# @option opts [Boolean] :fail Fail on first error
|
1009
|
+
# @option opts [Boolean] :disc Open to disc
|
927
1010
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
928
1011
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
929
1012
|
|
@@ -933,37 +1016,33 @@ module Vips
|
|
933
1016
|
# @param opts [Hash] Set of options
|
934
1017
|
# @option opts [Boolean] :memory Force open via memory
|
935
1018
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1019
|
+
# @option opts [Boolean] :sequential Sequential read only
|
936
1020
|
# @option opts [Boolean] :fail Fail on first error
|
1021
|
+
# @option opts [Boolean] :disc Open to disc
|
937
1022
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
938
1023
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
939
1024
|
|
940
|
-
# @!method self.
|
941
|
-
# Load
|
942
|
-
# @param
|
1025
|
+
# @!method self.radload_buffer(buffer, **opts)
|
1026
|
+
# Load rad from buffer.
|
1027
|
+
# @param buffer [VipsBlob] Buffer to load from
|
943
1028
|
# @param opts [Hash] Set of options
|
944
|
-
# @option opts [Integer] :page Load this page from the file
|
945
|
-
# @option opts [Integer] :n Load this many pages
|
946
|
-
# @option opts [Float] :dpi Render at this DPI
|
947
|
-
# @option opts [Float] :scale Scale output by this factor
|
948
|
-
# @option opts [Array<Double>] :background Background value
|
949
1029
|
# @option opts [Boolean] :memory Force open via memory
|
950
1030
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1031
|
+
# @option opts [Boolean] :sequential Sequential read only
|
951
1032
|
# @option opts [Boolean] :fail Fail on first error
|
1033
|
+
# @option opts [Boolean] :disc Open to disc
|
952
1034
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
953
1035
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
954
1036
|
|
955
|
-
# @!method self.
|
956
|
-
# Load
|
957
|
-
# @param
|
1037
|
+
# @!method self.radload_source(source, **opts)
|
1038
|
+
# Load rad from source.
|
1039
|
+
# @param source [Vips::Source] Source to load from
|
958
1040
|
# @param opts [Hash] Set of options
|
959
|
-
# @option opts [Integer] :page Load this page from the file
|
960
|
-
# @option opts [Integer] :n Load this many pages
|
961
|
-
# @option opts [Float] :dpi Render at this DPI
|
962
|
-
# @option opts [Float] :scale Scale output by this factor
|
963
|
-
# @option opts [Array<Double>] :background Background value
|
964
1041
|
# @option opts [Boolean] :memory Force open via memory
|
965
1042
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1043
|
+
# @option opts [Boolean] :sequential Sequential read only
|
966
1044
|
# @option opts [Boolean] :fail Fail on first error
|
1045
|
+
# @option opts [Boolean] :disc Open to disc
|
967
1046
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
968
1047
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
969
1048
|
|
@@ -973,57 +1052,159 @@ module Vips
|
|
973
1052
|
# @param opts [Hash] Set of options
|
974
1053
|
# @option opts [Float] :dpi Render at this DPI
|
975
1054
|
# @option opts [Float] :scale Scale output by this factor
|
1055
|
+
# @option opts [Boolean] :unlimited Allow SVG of any size
|
976
1056
|
# @option opts [Boolean] :memory Force open via memory
|
977
1057
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1058
|
+
# @option opts [Boolean] :sequential Sequential read only
|
978
1059
|
# @option opts [Boolean] :fail Fail on first error
|
1060
|
+
# @option opts [Boolean] :disc Open to disc
|
979
1061
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
980
1062
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
981
1063
|
|
982
|
-
# @!method self.
|
1064
|
+
# @!method self.svgload_buffer(buffer, **opts)
|
983
1065
|
# Load svg with rsvg.
|
984
|
-
# @param
|
1066
|
+
# @param buffer [VipsBlob] Buffer to load from
|
985
1067
|
# @param opts [Hash] Set of options
|
986
1068
|
# @option opts [Float] :dpi Render at this DPI
|
987
1069
|
# @option opts [Float] :scale Scale output by this factor
|
1070
|
+
# @option opts [Boolean] :unlimited Allow SVG of any size
|
988
1071
|
# @option opts [Boolean] :memory Force open via memory
|
989
1072
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1073
|
+
# @option opts [Boolean] :sequential Sequential read only
|
990
1074
|
# @option opts [Boolean] :fail Fail on first error
|
1075
|
+
# @option opts [Boolean] :disc Open to disc
|
991
1076
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
992
1077
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
993
1078
|
|
994
|
-
# @!method self.
|
995
|
-
# Load svg
|
996
|
-
# @param
|
1079
|
+
# @!method self.svgload_source(source, **opts)
|
1080
|
+
# Load svg from source.
|
1081
|
+
# @param source [Vips::Source] Source to load from
|
997
1082
|
# @param opts [Hash] Set of options
|
998
1083
|
# @option opts [Float] :dpi Render at this DPI
|
999
1084
|
# @option opts [Float] :scale Scale output by this factor
|
1085
|
+
# @option opts [Boolean] :unlimited Allow SVG of any size
|
1086
|
+
# @option opts [Boolean] :memory Force open via memory
|
1087
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1088
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1089
|
+
# @option opts [Boolean] :fail Fail on first error
|
1090
|
+
# @option opts [Boolean] :disc Open to disc
|
1091
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1092
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1093
|
+
|
1094
|
+
# @!method self.jxlload(filename, **opts)
|
1095
|
+
# Load jpeg-xl image.
|
1096
|
+
# @param filename [String] Filename to load from
|
1097
|
+
# @param opts [Hash] Set of options
|
1098
|
+
# @option opts [Boolean] :memory Force open via memory
|
1099
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1100
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1101
|
+
# @option opts [Boolean] :fail Fail on first error
|
1102
|
+
# @option opts [Boolean] :disc Open to disc
|
1103
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1104
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1105
|
+
|
1106
|
+
# @!method self.jxlload_buffer(buffer, **opts)
|
1107
|
+
# Load jpeg-xl image.
|
1108
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1109
|
+
# @param opts [Hash] Set of options
|
1110
|
+
# @option opts [Boolean] :memory Force open via memory
|
1111
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1112
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1113
|
+
# @option opts [Boolean] :fail Fail on first error
|
1114
|
+
# @option opts [Boolean] :disc Open to disc
|
1115
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1116
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1117
|
+
|
1118
|
+
# @!method self.jxlload_source(source, **opts)
|
1119
|
+
# Load jpeg-xl image.
|
1120
|
+
# @param source [Vips::Source] Source to load from
|
1121
|
+
# @param opts [Hash] Set of options
|
1122
|
+
# @option opts [Boolean] :memory Force open via memory
|
1123
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1124
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1125
|
+
# @option opts [Boolean] :fail Fail on first error
|
1126
|
+
# @option opts [Boolean] :disc Open to disc
|
1127
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1128
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1129
|
+
|
1130
|
+
# @!method self.jp2kload(filename, **opts)
|
1131
|
+
# Load jpeg2000 image.
|
1132
|
+
# @param filename [String] Filename to load from
|
1133
|
+
# @param opts [Hash] Set of options
|
1134
|
+
# @option opts [Integer] :page Load this page from the image
|
1135
|
+
# @option opts [Boolean] :memory Force open via memory
|
1136
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1137
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1138
|
+
# @option opts [Boolean] :fail Fail on first error
|
1139
|
+
# @option opts [Boolean] :disc Open to disc
|
1140
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1141
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1142
|
+
|
1143
|
+
# @!method self.jp2kload_buffer(buffer, **opts)
|
1144
|
+
# Load jpeg2000 image.
|
1145
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1146
|
+
# @param opts [Hash] Set of options
|
1147
|
+
# @option opts [Integer] :page Load this page from the image
|
1148
|
+
# @option opts [Boolean] :memory Force open via memory
|
1149
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1150
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1151
|
+
# @option opts [Boolean] :fail Fail on first error
|
1152
|
+
# @option opts [Boolean] :disc Open to disc
|
1153
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1154
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1155
|
+
|
1156
|
+
# @!method self.jp2kload_source(source, **opts)
|
1157
|
+
# Load jpeg2000 image.
|
1158
|
+
# @param source [Vips::Source] Source to load from
|
1159
|
+
# @param opts [Hash] Set of options
|
1160
|
+
# @option opts [Integer] :page Load this page from the image
|
1000
1161
|
# @option opts [Boolean] :memory Force open via memory
|
1001
1162
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1163
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1002
1164
|
# @option opts [Boolean] :fail Fail on first error
|
1165
|
+
# @option opts [Boolean] :disc Open to disc
|
1003
1166
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1004
1167
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1005
1168
|
|
1006
1169
|
# @!method self.gifload(filename, **opts)
|
1007
|
-
# Load gif with
|
1170
|
+
# Load gif with libnsgif.
|
1008
1171
|
# @param filename [String] Filename to load from
|
1009
1172
|
# @param opts [Hash] Set of options
|
1010
|
-
# @option opts [Integer] :page Load this page from the file
|
1011
1173
|
# @option opts [Integer] :n Load this many pages
|
1174
|
+
# @option opts [Integer] :page Load this page from the file
|
1012
1175
|
# @option opts [Boolean] :memory Force open via memory
|
1013
1176
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1177
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1014
1178
|
# @option opts [Boolean] :fail Fail on first error
|
1179
|
+
# @option opts [Boolean] :disc Open to disc
|
1015
1180
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1016
1181
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1017
1182
|
|
1018
1183
|
# @!method self.gifload_buffer(buffer, **opts)
|
1019
|
-
# Load gif with
|
1184
|
+
# Load gif with libnsgif.
|
1020
1185
|
# @param buffer [VipsBlob] Buffer to load from
|
1021
1186
|
# @param opts [Hash] Set of options
|
1187
|
+
# @option opts [Integer] :n Load this many pages
|
1022
1188
|
# @option opts [Integer] :page Load this page from the file
|
1189
|
+
# @option opts [Boolean] :memory Force open via memory
|
1190
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1191
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1192
|
+
# @option opts [Boolean] :fail Fail on first error
|
1193
|
+
# @option opts [Boolean] :disc Open to disc
|
1194
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1195
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1196
|
+
|
1197
|
+
# @!method self.gifload_source(source, **opts)
|
1198
|
+
# Load gif from source.
|
1199
|
+
# @param source [Vips::Source] Source to load from
|
1200
|
+
# @param opts [Hash] Set of options
|
1023
1201
|
# @option opts [Integer] :n Load this many pages
|
1202
|
+
# @option opts [Integer] :page Load this page from the file
|
1024
1203
|
# @option opts [Boolean] :memory Force open via memory
|
1025
1204
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1205
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1026
1206
|
# @option opts [Boolean] :fail Fail on first error
|
1207
|
+
# @option opts [Boolean] :disc Open to disc
|
1027
1208
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1028
1209
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1029
1210
|
|
@@ -1033,7 +1214,9 @@ module Vips
|
|
1033
1214
|
# @param opts [Hash] Set of options
|
1034
1215
|
# @option opts [Boolean] :memory Force open via memory
|
1035
1216
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1217
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1036
1218
|
# @option opts [Boolean] :fail Fail on first error
|
1219
|
+
# @option opts [Boolean] :disc Open to disc
|
1037
1220
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1038
1221
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1039
1222
|
|
@@ -1043,7 +1226,21 @@ module Vips
|
|
1043
1226
|
# @param opts [Hash] Set of options
|
1044
1227
|
# @option opts [Boolean] :memory Force open via memory
|
1045
1228
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1229
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1230
|
+
# @option opts [Boolean] :fail Fail on first error
|
1231
|
+
# @option opts [Boolean] :disc Open to disc
|
1232
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1233
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1234
|
+
|
1235
|
+
# @!method self.pngload_source(source, **opts)
|
1236
|
+
# Load png from source.
|
1237
|
+
# @param source [Vips::Source] Source to load from
|
1238
|
+
# @param opts [Hash] Set of options
|
1239
|
+
# @option opts [Boolean] :memory Force open via memory
|
1240
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1241
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1046
1242
|
# @option opts [Boolean] :fail Fail on first error
|
1243
|
+
# @option opts [Boolean] :disc Open to disc
|
1047
1244
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1048
1245
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1049
1246
|
|
@@ -1053,7 +1250,9 @@ module Vips
|
|
1053
1250
|
# @param opts [Hash] Set of options
|
1054
1251
|
# @option opts [Boolean] :memory Force open via memory
|
1055
1252
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1253
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1056
1254
|
# @option opts [Boolean] :fail Fail on first error
|
1255
|
+
# @option opts [Boolean] :disc Open to disc
|
1057
1256
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1058
1257
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1059
1258
|
|
@@ -1065,7 +1264,9 @@ module Vips
|
|
1065
1264
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1066
1265
|
# @option opts [Boolean] :memory Force open via memory
|
1067
1266
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1267
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1068
1268
|
# @option opts [Boolean] :fail Fail on first error
|
1269
|
+
# @option opts [Boolean] :disc Open to disc
|
1069
1270
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1070
1271
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1071
1272
|
|
@@ -1077,7 +1278,23 @@ module Vips
|
|
1077
1278
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1078
1279
|
# @option opts [Boolean] :memory Force open via memory
|
1079
1280
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1281
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1282
|
+
# @option opts [Boolean] :fail Fail on first error
|
1283
|
+
# @option opts [Boolean] :disc Open to disc
|
1284
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1285
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1286
|
+
|
1287
|
+
# @!method self.jpegload_source(source, **opts)
|
1288
|
+
# Load image from jpeg source.
|
1289
|
+
# @param source [Vips::Source] Source to load from
|
1290
|
+
# @param opts [Hash] Set of options
|
1291
|
+
# @option opts [Integer] :shrink Shrink factor on load
|
1292
|
+
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1293
|
+
# @option opts [Boolean] :memory Force open via memory
|
1294
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1295
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1080
1296
|
# @option opts [Boolean] :fail Fail on first error
|
1297
|
+
# @option opts [Boolean] :disc Open to disc
|
1081
1298
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1082
1299
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1083
1300
|
|
@@ -1088,9 +1305,12 @@ module Vips
|
|
1088
1305
|
# @option opts [Integer] :page Load this page from the file
|
1089
1306
|
# @option opts [Integer] :n Load this many pages
|
1090
1307
|
# @option opts [Float] :scale Scale factor on load
|
1308
|
+
# @option opts [Integer] :shrink Shrink factor on load
|
1091
1309
|
# @option opts [Boolean] :memory Force open via memory
|
1092
1310
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1311
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1093
1312
|
# @option opts [Boolean] :fail Fail on first error
|
1313
|
+
# @option opts [Boolean] :disc Open to disc
|
1094
1314
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1095
1315
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1096
1316
|
|
@@ -1101,9 +1321,28 @@ module Vips
|
|
1101
1321
|
# @option opts [Integer] :page Load this page from the file
|
1102
1322
|
# @option opts [Integer] :n Load this many pages
|
1103
1323
|
# @option opts [Float] :scale Scale factor on load
|
1324
|
+
# @option opts [Integer] :shrink Shrink factor on load
|
1104
1325
|
# @option opts [Boolean] :memory Force open via memory
|
1105
1326
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1327
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1106
1328
|
# @option opts [Boolean] :fail Fail on first error
|
1329
|
+
# @option opts [Boolean] :disc Open to disc
|
1330
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1331
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1332
|
+
|
1333
|
+
# @!method self.webpload_source(source, **opts)
|
1334
|
+
# Load webp from source.
|
1335
|
+
# @param source [Vips::Source] Source to load from
|
1336
|
+
# @param opts [Hash] Set of options
|
1337
|
+
# @option opts [Integer] :page Load this page from the file
|
1338
|
+
# @option opts [Integer] :n Load this many pages
|
1339
|
+
# @option opts [Float] :scale Scale factor on load
|
1340
|
+
# @option opts [Integer] :shrink Shrink factor on load
|
1341
|
+
# @option opts [Boolean] :memory Force open via memory
|
1342
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1343
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1344
|
+
# @option opts [Boolean] :fail Fail on first error
|
1345
|
+
# @option opts [Boolean] :disc Open to disc
|
1107
1346
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1108
1347
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1109
1348
|
|
@@ -1112,11 +1351,14 @@ module Vips
|
|
1112
1351
|
# @param filename [String] Filename to load from
|
1113
1352
|
# @param opts [Hash] Set of options
|
1114
1353
|
# @option opts [Integer] :page Load this page from the image
|
1354
|
+
# @option opts [Integer] :subifd Select subifd index
|
1115
1355
|
# @option opts [Integer] :n Load this many pages
|
1116
1356
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1117
1357
|
# @option opts [Boolean] :memory Force open via memory
|
1118
1358
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1359
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1119
1360
|
# @option opts [Boolean] :fail Fail on first error
|
1361
|
+
# @option opts [Boolean] :disc Open to disc
|
1120
1362
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1121
1363
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1122
1364
|
|
@@ -1125,11 +1367,90 @@ module Vips
|
|
1125
1367
|
# @param buffer [VipsBlob] Buffer to load from
|
1126
1368
|
# @param opts [Hash] Set of options
|
1127
1369
|
# @option opts [Integer] :page Load this page from the image
|
1370
|
+
# @option opts [Integer] :subifd Select subifd index
|
1128
1371
|
# @option opts [Integer] :n Load this many pages
|
1129
1372
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1130
1373
|
# @option opts [Boolean] :memory Force open via memory
|
1131
1374
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1375
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1132
1376
|
# @option opts [Boolean] :fail Fail on first error
|
1377
|
+
# @option opts [Boolean] :disc Open to disc
|
1378
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1379
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1380
|
+
|
1381
|
+
# @!method self.tiffload_source(source, **opts)
|
1382
|
+
# Load tiff from source.
|
1383
|
+
# @param source [Vips::Source] Source to load from
|
1384
|
+
# @param opts [Hash] Set of options
|
1385
|
+
# @option opts [Integer] :page Load this page from the image
|
1386
|
+
# @option opts [Integer] :subifd Select subifd index
|
1387
|
+
# @option opts [Integer] :n Load this many pages
|
1388
|
+
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1389
|
+
# @option opts [Boolean] :memory Force open via memory
|
1390
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1391
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1392
|
+
# @option opts [Boolean] :fail Fail on first error
|
1393
|
+
# @option opts [Boolean] :disc Open to disc
|
1394
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1395
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1396
|
+
|
1397
|
+
# @!method self.fitsload(filename, **opts)
|
1398
|
+
# Load a fits image.
|
1399
|
+
# @param filename [String] Filename to load from
|
1400
|
+
# @param opts [Hash] Set of options
|
1401
|
+
# @option opts [Boolean] :memory Force open via memory
|
1402
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1403
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1404
|
+
# @option opts [Boolean] :fail Fail on first error
|
1405
|
+
# @option opts [Boolean] :disc Open to disc
|
1406
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1407
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1408
|
+
|
1409
|
+
# @!method self.fitsload_source(source, **opts)
|
1410
|
+
# Load fits from a source.
|
1411
|
+
# @param source [Vips::Source] Source to load from
|
1412
|
+
# @param opts [Hash] Set of options
|
1413
|
+
# @option opts [Boolean] :memory Force open via memory
|
1414
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1415
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1416
|
+
# @option opts [Boolean] :fail Fail on first error
|
1417
|
+
# @option opts [Boolean] :disc Open to disc
|
1418
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1419
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1420
|
+
|
1421
|
+
# @!method self.openexrload(filename, **opts)
|
1422
|
+
# Load an openexr image.
|
1423
|
+
# @param filename [String] Filename to load from
|
1424
|
+
# @param opts [Hash] Set of options
|
1425
|
+
# @option opts [Boolean] :memory Force open via memory
|
1426
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1427
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1428
|
+
# @option opts [Boolean] :fail Fail on first error
|
1429
|
+
# @option opts [Boolean] :disc Open to disc
|
1430
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1431
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1432
|
+
|
1433
|
+
# @!method self.niftiload(filename, **opts)
|
1434
|
+
# Load nifti volume.
|
1435
|
+
# @param filename [String] Filename to load from
|
1436
|
+
# @param opts [Hash] Set of options
|
1437
|
+
# @option opts [Boolean] :memory Force open via memory
|
1438
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1439
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1440
|
+
# @option opts [Boolean] :fail Fail on first error
|
1441
|
+
# @option opts [Boolean] :disc Open to disc
|
1442
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1443
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1444
|
+
|
1445
|
+
# @!method self.niftiload_source(source, **opts)
|
1446
|
+
# Load nifti volumes.
|
1447
|
+
# @param source [Vips::Source] Source to load from
|
1448
|
+
# @param opts [Hash] Set of options
|
1449
|
+
# @option opts [Boolean] :memory Force open via memory
|
1450
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1451
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1452
|
+
# @option opts [Boolean] :fail Fail on first error
|
1453
|
+
# @option opts [Boolean] :disc Open to disc
|
1133
1454
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1134
1455
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1135
1456
|
|
@@ -1137,192 +1458,391 @@ module Vips
|
|
1137
1458
|
# Load file with openslide.
|
1138
1459
|
# @param filename [String] Filename to load from
|
1139
1460
|
# @param opts [Hash] Set of options
|
1140
|
-
# @option opts [Boolean] :attach_associated Attach all
|
1461
|
+
# @option opts [Boolean] :attach_associated Attach all associated images
|
1141
1462
|
# @option opts [Integer] :level Load this level from the file
|
1142
1463
|
# @option opts [Boolean] :autocrop Crop to image bounds
|
1143
1464
|
# @option opts [String] :associated Load this associated image
|
1144
1465
|
# @option opts [Boolean] :memory Force open via memory
|
1145
1466
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1467
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1146
1468
|
# @option opts [Boolean] :fail Fail on first error
|
1469
|
+
# @option opts [Boolean] :disc Open to disc
|
1147
1470
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1148
1471
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1149
1472
|
|
1150
|
-
# @!method self.
|
1151
|
-
# Load
|
1473
|
+
# @!method self.openslideload_source(source, **opts)
|
1474
|
+
# Load source with openslide.
|
1475
|
+
# @param source [Vips::Source] Source to load from
|
1476
|
+
# @param opts [Hash] Set of options
|
1477
|
+
# @option opts [Boolean] :attach_associated Attach all associated images
|
1478
|
+
# @option opts [Integer] :level Load this level from the file
|
1479
|
+
# @option opts [Boolean] :autocrop Crop to image bounds
|
1480
|
+
# @option opts [String] :associated Load this associated image
|
1481
|
+
# @option opts [Boolean] :memory Force open via memory
|
1482
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1483
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1484
|
+
# @option opts [Boolean] :fail Fail on first error
|
1485
|
+
# @option opts [Boolean] :disc Open to disc
|
1486
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1487
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1488
|
+
|
1489
|
+
# @!method self.heifload(filename, **opts)
|
1490
|
+
# Load a heif image.
|
1152
1491
|
# @param filename [String] Filename to load from
|
1153
1492
|
# @param opts [Hash] Set of options
|
1154
|
-
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1155
1493
|
# @option opts [Integer] :page Load this page from the file
|
1156
1494
|
# @option opts [Integer] :n Load this many pages
|
1495
|
+
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1496
|
+
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1157
1497
|
# @option opts [Boolean] :memory Force open via memory
|
1158
1498
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1499
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1159
1500
|
# @option opts [Boolean] :fail Fail on first error
|
1501
|
+
# @option opts [Boolean] :disc Open to disc
|
1160
1502
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1161
1503
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1162
1504
|
|
1163
|
-
# @!method self.
|
1164
|
-
# Load
|
1505
|
+
# @!method self.heifload_buffer(buffer, **opts)
|
1506
|
+
# Load a heif image.
|
1165
1507
|
# @param buffer [VipsBlob] Buffer to load from
|
1166
1508
|
# @param opts [Hash] Set of options
|
1167
|
-
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1168
1509
|
# @option opts [Integer] :page Load this page from the file
|
1169
1510
|
# @option opts [Integer] :n Load this many pages
|
1511
|
+
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1512
|
+
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1170
1513
|
# @option opts [Boolean] :memory Force open via memory
|
1171
1514
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1515
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1172
1516
|
# @option opts [Boolean] :fail Fail on first error
|
1517
|
+
# @option opts [Boolean] :disc Open to disc
|
1173
1518
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1174
1519
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1175
1520
|
|
1176
|
-
# @!method self.
|
1177
|
-
# Load a
|
1178
|
-
# @param
|
1521
|
+
# @!method self.heifload_source(source, **opts)
|
1522
|
+
# Load a heif image.
|
1523
|
+
# @param source [Vips::Source] Source to load from
|
1179
1524
|
# @param opts [Hash] Set of options
|
1525
|
+
# @option opts [Integer] :page Load this page from the file
|
1526
|
+
# @option opts [Integer] :n Load this many pages
|
1527
|
+
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1528
|
+
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1180
1529
|
# @option opts [Boolean] :memory Force open via memory
|
1181
1530
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1531
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1182
1532
|
# @option opts [Boolean] :fail Fail on first error
|
1533
|
+
# @option opts [Boolean] :disc Open to disc
|
1183
1534
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1184
1535
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1185
1536
|
|
1186
|
-
# @!method self.
|
1187
|
-
# Load
|
1537
|
+
# @!method self.pdfload(filename, **opts)
|
1538
|
+
# Load pdf from file.
|
1188
1539
|
# @param filename [String] Filename to load from
|
1189
1540
|
# @param opts [Hash] Set of options
|
1541
|
+
# @option opts [Integer] :page Load this page from the file
|
1542
|
+
# @option opts [Integer] :n Load this many pages
|
1543
|
+
# @option opts [Float] :dpi Render at this DPI
|
1544
|
+
# @option opts [Float] :scale Scale output by this factor
|
1545
|
+
# @option opts [Array<Double>] :background Background value
|
1190
1546
|
# @option opts [Boolean] :memory Force open via memory
|
1191
1547
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1548
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1192
1549
|
# @option opts [Boolean] :fail Fail on first error
|
1550
|
+
# @option opts [Boolean] :disc Open to disc
|
1193
1551
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1194
1552
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1195
1553
|
|
1196
|
-
# @!method self.
|
1197
|
-
# Load
|
1198
|
-
# @param
|
1554
|
+
# @!method self.pdfload_buffer(buffer, **opts)
|
1555
|
+
# Load pdf from buffer.
|
1556
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1199
1557
|
# @param opts [Hash] Set of options
|
1558
|
+
# @option opts [Integer] :page Load this page from the file
|
1559
|
+
# @option opts [Integer] :n Load this many pages
|
1560
|
+
# @option opts [Float] :dpi Render at this DPI
|
1561
|
+
# @option opts [Float] :scale Scale output by this factor
|
1562
|
+
# @option opts [Array<Double>] :background Background value
|
1200
1563
|
# @option opts [Boolean] :memory Force open via memory
|
1201
1564
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1565
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1202
1566
|
# @option opts [Boolean] :fail Fail on first error
|
1567
|
+
# @option opts [Boolean] :disc Open to disc
|
1203
1568
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1204
1569
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1205
1570
|
|
1206
|
-
# @!method self.
|
1207
|
-
# Load
|
1571
|
+
# @!method self.pdfload_source(source, **opts)
|
1572
|
+
# Load pdf from source.
|
1573
|
+
# @param source [Vips::Source] Source to load from
|
1574
|
+
# @param opts [Hash] Set of options
|
1575
|
+
# @option opts [Integer] :page Load this page from the file
|
1576
|
+
# @option opts [Integer] :n Load this many pages
|
1577
|
+
# @option opts [Float] :dpi Render at this DPI
|
1578
|
+
# @option opts [Float] :scale Scale output by this factor
|
1579
|
+
# @option opts [Array<Double>] :background Background value
|
1580
|
+
# @option opts [Boolean] :memory Force open via memory
|
1581
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1582
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1583
|
+
# @option opts [Boolean] :fail Fail on first error
|
1584
|
+
# @option opts [Boolean] :disc Open to disc
|
1585
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1586
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1587
|
+
|
1588
|
+
# @!method self.magickload(filename, **opts)
|
1589
|
+
# Load file with imagemagick.
|
1208
1590
|
# @param filename [String] Filename to load from
|
1209
1591
|
# @param opts [Hash] Set of options
|
1592
|
+
# @option opts [Boolean] :all_frames Read all frames from an image
|
1593
|
+
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1210
1594
|
# @option opts [Integer] :page Load this page from the file
|
1211
1595
|
# @option opts [Integer] :n Load this many pages
|
1212
|
-
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1213
|
-
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1214
1596
|
# @option opts [Boolean] :memory Force open via memory
|
1215
1597
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1598
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1216
1599
|
# @option opts [Boolean] :fail Fail on first error
|
1600
|
+
# @option opts [Boolean] :disc Open to disc
|
1217
1601
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1218
1602
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1219
1603
|
|
1220
|
-
# @!method self.
|
1221
|
-
# Load
|
1604
|
+
# @!method self.magickload_buffer(buffer, **opts)
|
1605
|
+
# Load buffer with imagemagick.
|
1222
1606
|
# @param buffer [VipsBlob] Buffer to load from
|
1223
1607
|
# @param opts [Hash] Set of options
|
1608
|
+
# @option opts [Boolean] :all_frames Read all frames from an image
|
1609
|
+
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1224
1610
|
# @option opts [Integer] :page Load this page from the file
|
1225
1611
|
# @option opts [Integer] :n Load this many pages
|
1226
|
-
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1227
|
-
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1228
1612
|
# @option opts [Boolean] :memory Force open via memory
|
1229
1613
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1614
|
+
# @option opts [Boolean] :sequential Sequential read only
|
1230
1615
|
# @option opts [Boolean] :fail Fail on first error
|
1616
|
+
# @option opts [Boolean] :disc Open to disc
|
1231
1617
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1232
1618
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1233
1619
|
|
1234
1620
|
# @!method csvsave(filename, **opts)
|
1235
|
-
# Save image to csv
|
1621
|
+
# Save image to csv.
|
1236
1622
|
# @param filename [String] Filename to save to
|
1237
1623
|
# @param opts [Hash] Set of options
|
1624
|
+
# @option opts [String] :separator Separator characters
|
1625
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1626
|
+
# @option opts [Array<Double>] :background Background value
|
1238
1627
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1628
|
+
# @return [nil]
|
1629
|
+
|
1630
|
+
# @!method csvsave_target(target, **opts)
|
1631
|
+
# Save image to csv.
|
1632
|
+
# @param target [Vips::Target] Target to save to
|
1633
|
+
# @param opts [Hash] Set of options
|
1239
1634
|
# @option opts [String] :separator Separator characters
|
1240
1635
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1241
1636
|
# @option opts [Array<Double>] :background Background value
|
1637
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1242
1638
|
# @return [nil]
|
1243
1639
|
|
1244
1640
|
# @!method matrixsave(filename, **opts)
|
1245
|
-
# Save image to matrix
|
1641
|
+
# Save image to matrix.
|
1246
1642
|
# @param filename [String] Filename to save to
|
1247
1643
|
# @param opts [Hash] Set of options
|
1644
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1645
|
+
# @option opts [Array<Double>] :background Background value
|
1248
1646
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1647
|
+
# @return [nil]
|
1648
|
+
|
1649
|
+
# @!method matrixsave_target(target, **opts)
|
1650
|
+
# Save image to matrix.
|
1651
|
+
# @param target [Vips::Target] Target to save to
|
1652
|
+
# @param opts [Hash] Set of options
|
1249
1653
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1250
1654
|
# @option opts [Array<Double>] :background Background value
|
1655
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1251
1656
|
# @return [nil]
|
1252
1657
|
|
1253
1658
|
# @!method matrixprint(**opts)
|
1254
1659
|
# Print matrix.
|
1255
1660
|
# @param opts [Hash] Set of options
|
1256
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1257
1661
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1258
1662
|
# @option opts [Array<Double>] :background Background value
|
1663
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1259
1664
|
# @return [nil]
|
1260
1665
|
|
1261
1666
|
# @!method rawsave(filename, **opts)
|
1262
1667
|
# Save image to raw file.
|
1263
1668
|
# @param filename [String] Filename to save to
|
1264
1669
|
# @param opts [Hash] Set of options
|
1265
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1266
1670
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1267
1671
|
# @option opts [Array<Double>] :background Background value
|
1672
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1268
1673
|
# @return [nil]
|
1269
1674
|
|
1270
1675
|
# @!method rawsave_fd(fd, **opts)
|
1271
1676
|
# Write raw image to file descriptor.
|
1272
1677
|
# @param fd [Integer] File descriptor to write to
|
1273
1678
|
# @param opts [Hash] Set of options
|
1274
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1275
1679
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1276
1680
|
# @option opts [Array<Double>] :background Background value
|
1681
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1277
1682
|
# @return [nil]
|
1278
1683
|
|
1279
1684
|
# @!method vipssave(filename, **opts)
|
1280
|
-
# Save image to vips
|
1685
|
+
# Save image to file in vips format.
|
1281
1686
|
# @param filename [String] Filename to save to
|
1282
1687
|
# @param opts [Hash] Set of options
|
1688
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1689
|
+
# @option opts [Array<Double>] :background Background value
|
1283
1690
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1691
|
+
# @return [nil]
|
1692
|
+
|
1693
|
+
# @!method vipssave_target(target, **opts)
|
1694
|
+
# Save image to target in vips format.
|
1695
|
+
# @param target [Vips::Target] Target to save to
|
1696
|
+
# @param opts [Hash] Set of options
|
1284
1697
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1285
1698
|
# @option opts [Array<Double>] :background Background value
|
1699
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1286
1700
|
# @return [nil]
|
1287
1701
|
|
1288
1702
|
# @!method ppmsave(filename, **opts)
|
1289
1703
|
# Save image to ppm file.
|
1290
1704
|
# @param filename [String] Filename to save to
|
1291
1705
|
# @param opts [Hash] Set of options
|
1706
|
+
# @option opts [Boolean] :ascii save as ascii
|
1707
|
+
# @option opts [Boolean] :squash save as one bit
|
1708
|
+
# @option opts [Integer] :bitdepth set to 1 to write as a 1 bit image
|
1709
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1710
|
+
# @option opts [Array<Double>] :background Background value
|
1292
1711
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1712
|
+
# @return [nil]
|
1713
|
+
|
1714
|
+
# @!method ppmsave_target(target, **opts)
|
1715
|
+
# Save to ppm.
|
1716
|
+
# @param target [Vips::Target] Target to save to
|
1717
|
+
# @param opts [Hash] Set of options
|
1293
1718
|
# @option opts [Boolean] :ascii save as ascii
|
1294
1719
|
# @option opts [Boolean] :squash save as one bit
|
1720
|
+
# @option opts [Integer] :bitdepth set to 1 to write as a 1 bit image
|
1295
1721
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1296
1722
|
# @option opts [Array<Double>] :background Background value
|
1723
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1297
1724
|
# @return [nil]
|
1298
1725
|
|
1299
1726
|
# @!method radsave(filename, **opts)
|
1300
1727
|
# Save image to radiance file.
|
1301
1728
|
# @param filename [String] Filename to save to
|
1302
1729
|
# @param opts [Hash] Set of options
|
1303
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1304
1730
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1305
1731
|
# @option opts [Array<Double>] :background Background value
|
1732
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1306
1733
|
# @return [nil]
|
1307
1734
|
|
1308
1735
|
# @!method radsave_buffer(**opts)
|
1309
1736
|
# Save image to radiance buffer.
|
1310
1737
|
# @param opts [Hash] Set of options
|
1738
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1739
|
+
# @option opts [Array<Double>] :background Background value
|
1740
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1741
|
+
# @return [VipsBlob] Buffer to save to
|
1742
|
+
|
1743
|
+
# @!method radsave_target(target, **opts)
|
1744
|
+
# Save image to radiance target.
|
1745
|
+
# @param target [Vips::Target] Target to save to
|
1746
|
+
# @param opts [Hash] Set of options
|
1747
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1748
|
+
# @option opts [Array<Double>] :background Background value
|
1749
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1750
|
+
# @return [nil]
|
1751
|
+
|
1752
|
+
# @!method jxlsave(filename, **opts)
|
1753
|
+
# Save image in jpeg-xl format.
|
1754
|
+
# @param filename [String] Filename to load from
|
1755
|
+
# @param opts [Hash] Set of options
|
1756
|
+
# @option opts [Integer] :tier Decode speed tier
|
1757
|
+
# @option opts [Float] :distance Target butteraugli distance
|
1758
|
+
# @option opts [Integer] :effort Encoding effort
|
1759
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1760
|
+
# @option opts [Integer] :Q Quality factor
|
1761
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1762
|
+
# @option opts [Array<Double>] :background Background value
|
1763
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1764
|
+
# @return [nil]
|
1765
|
+
|
1766
|
+
# @!method jxlsave_buffer(**opts)
|
1767
|
+
# Save image in jpeg-xl format.
|
1768
|
+
# @param opts [Hash] Set of options
|
1769
|
+
# @option opts [Integer] :tier Decode speed tier
|
1770
|
+
# @option opts [Float] :distance Target butteraugli distance
|
1771
|
+
# @option opts [Integer] :effort Encoding effort
|
1772
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1773
|
+
# @option opts [Integer] :Q Quality factor
|
1774
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1775
|
+
# @option opts [Array<Double>] :background Background value
|
1776
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1777
|
+
# @return [VipsBlob] Buffer to save to
|
1778
|
+
|
1779
|
+
# @!method jxlsave_target(target, **opts)
|
1780
|
+
# Save image in jpeg-xl format.
|
1781
|
+
# @param target [Vips::Target] Target to save to
|
1782
|
+
# @param opts [Hash] Set of options
|
1783
|
+
# @option opts [Integer] :tier Decode speed tier
|
1784
|
+
# @option opts [Float] :distance Target butteraugli distance
|
1785
|
+
# @option opts [Integer] :effort Encoding effort
|
1786
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1787
|
+
# @option opts [Integer] :Q Quality factor
|
1788
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1789
|
+
# @option opts [Array<Double>] :background Background value
|
1790
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1791
|
+
# @return [nil]
|
1792
|
+
|
1793
|
+
# @!method jp2ksave(filename, **opts)
|
1794
|
+
# Save image in jpeg2000 format.
|
1795
|
+
# @param filename [String] Filename to load from
|
1796
|
+
# @param opts [Hash] Set of options
|
1797
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1798
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1799
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1800
|
+
# @option opts [Integer] :Q Q factor
|
1801
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1802
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1803
|
+
# @option opts [Array<Double>] :background Background value
|
1311
1804
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1805
|
+
# @return [nil]
|
1806
|
+
|
1807
|
+
# @!method jp2ksave_buffer(**opts)
|
1808
|
+
# Save image in jpeg2000 format.
|
1809
|
+
# @param opts [Hash] Set of options
|
1810
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1811
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1812
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1813
|
+
# @option opts [Integer] :Q Q factor
|
1814
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1312
1815
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1313
1816
|
# @option opts [Array<Double>] :background Background value
|
1817
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1314
1818
|
# @return [VipsBlob] Buffer to save to
|
1315
1819
|
|
1820
|
+
# @!method jp2ksave_target(target, **opts)
|
1821
|
+
# Save image in jpeg2000 format.
|
1822
|
+
# @param target [Vips::Target] Target to save to
|
1823
|
+
# @param opts [Hash] Set of options
|
1824
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1825
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1826
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1827
|
+
# @option opts [Integer] :Q Q factor
|
1828
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1829
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1830
|
+
# @option opts [Array<Double>] :background Background value
|
1831
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1832
|
+
# @return [nil]
|
1833
|
+
|
1316
1834
|
# @!method dzsave(filename, **opts)
|
1317
1835
|
# Save image to deepzoom file.
|
1318
1836
|
# @param filename [String] Filename to save to
|
1319
1837
|
# @param opts [Hash] Set of options
|
1838
|
+
# @option opts [String] :dirname Directory name to save to
|
1320
1839
|
# @option opts [String] :basename Base name to save to
|
1321
1840
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1322
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1323
1841
|
# @option opts [String] :suffix Filename suffix for tiles
|
1324
1842
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1325
1843
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1844
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1845
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1326
1846
|
# @option opts [Boolean] :centre Center image in tile
|
1327
1847
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1328
1848
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
@@ -1331,19 +1851,24 @@ module Vips
|
|
1331
1851
|
# @option opts [Integer] :compression ZIP deflate compression level
|
1332
1852
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
1333
1853
|
# @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
|
1854
|
+
# @option opts [Boolean] :no_strip Don't strip tile metadata
|
1855
|
+
# @option opts [String] :id Resource ID
|
1334
1856
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1335
1857
|
# @option opts [Array<Double>] :background Background value
|
1858
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1336
1859
|
# @return [nil]
|
1337
1860
|
|
1338
1861
|
# @!method dzsave_buffer(**opts)
|
1339
1862
|
# Save image to dz buffer.
|
1340
1863
|
# @param opts [Hash] Set of options
|
1864
|
+
# @option opts [String] :dirname Directory name to save to
|
1341
1865
|
# @option opts [String] :basename Base name to save to
|
1342
1866
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1343
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1344
1867
|
# @option opts [String] :suffix Filename suffix for tiles
|
1345
1868
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1346
1869
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1870
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1871
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1347
1872
|
# @option opts [Boolean] :centre Center image in tile
|
1348
1873
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1349
1874
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
@@ -1352,8 +1877,11 @@ module Vips
|
|
1352
1877
|
# @option opts [Integer] :compression ZIP deflate compression level
|
1353
1878
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
1354
1879
|
# @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
|
1880
|
+
# @option opts [Boolean] :no_strip Don't strip tile metadata
|
1881
|
+
# @option opts [String] :id Resource ID
|
1355
1882
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1356
1883
|
# @option opts [Array<Double>] :background Background value
|
1884
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1357
1885
|
# @return [VipsBlob] Buffer to save to
|
1358
1886
|
|
1359
1887
|
# @!method pngsave(filename, **opts)
|
@@ -1362,15 +1890,16 @@ module Vips
|
|
1362
1890
|
# @param opts [Hash] Set of options
|
1363
1891
|
# @option opts [Integer] :compression Compression factor
|
1364
1892
|
# @option opts [Boolean] :interlace Interlace image
|
1365
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1366
1893
|
# @option opts [String] :profile ICC profile to embed
|
1367
1894
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1368
1895
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1369
1896
|
# @option opts [Integer] :colours Max number of palette colours
|
1370
1897
|
# @option opts [Integer] :Q Quantisation quality
|
1371
1898
|
# @option opts [Float] :dither Amount of dithering
|
1899
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1372
1900
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1373
1901
|
# @option opts [Array<Double>] :background Background value
|
1902
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1374
1903
|
# @return [nil]
|
1375
1904
|
|
1376
1905
|
# @!method pngsave_buffer(**opts)
|
@@ -1378,22 +1907,40 @@ module Vips
|
|
1378
1907
|
# @param opts [Hash] Set of options
|
1379
1908
|
# @option opts [Integer] :compression Compression factor
|
1380
1909
|
# @option opts [Boolean] :interlace Interlace image
|
1381
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1382
1910
|
# @option opts [String] :profile ICC profile to embed
|
1383
1911
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1384
1912
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1385
1913
|
# @option opts [Integer] :colours Max number of palette colours
|
1386
1914
|
# @option opts [Integer] :Q Quantisation quality
|
1387
1915
|
# @option opts [Float] :dither Amount of dithering
|
1916
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1388
1917
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1389
1918
|
# @option opts [Array<Double>] :background Background value
|
1919
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1390
1920
|
# @return [VipsBlob] Buffer to save to
|
1391
1921
|
|
1922
|
+
# @!method pngsave_target(target, **opts)
|
1923
|
+
# Save image to target as png.
|
1924
|
+
# @param target [Vips::Target] Target to save to
|
1925
|
+
# @param opts [Hash] Set of options
|
1926
|
+
# @option opts [Integer] :compression Compression factor
|
1927
|
+
# @option opts [Boolean] :interlace Interlace image
|
1928
|
+
# @option opts [String] :profile ICC profile to embed
|
1929
|
+
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1930
|
+
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1931
|
+
# @option opts [Integer] :colours Max number of palette colours
|
1932
|
+
# @option opts [Integer] :Q Quantisation quality
|
1933
|
+
# @option opts [Float] :dither Amount of dithering
|
1934
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1935
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1936
|
+
# @option opts [Array<Double>] :background Background value
|
1937
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1938
|
+
# @return [nil]
|
1939
|
+
|
1392
1940
|
# @!method jpegsave(filename, **opts)
|
1393
1941
|
# Save image to jpeg file.
|
1394
1942
|
# @param filename [String] Filename to save to
|
1395
1943
|
# @param opts [Hash] Set of options
|
1396
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1397
1944
|
# @option opts [Integer] :Q Q factor
|
1398
1945
|
# @option opts [String] :profile ICC profile to embed
|
1399
1946
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
@@ -1401,16 +1948,17 @@ module Vips
|
|
1401
1948
|
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1402
1949
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1403
1950
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1404
|
-
# @option opts [Boolean] :optimize_scans Split
|
1951
|
+
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1405
1952
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1953
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1406
1954
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1407
1955
|
# @option opts [Array<Double>] :background Background value
|
1956
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1408
1957
|
# @return [nil]
|
1409
1958
|
|
1410
1959
|
# @!method jpegsave_buffer(**opts)
|
1411
1960
|
# Save image to jpeg buffer.
|
1412
1961
|
# @param opts [Hash] Set of options
|
1413
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1414
1962
|
# @option opts [Integer] :Q Q factor
|
1415
1963
|
# @option opts [String] :profile ICC profile to embed
|
1416
1964
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
@@ -1418,16 +1966,36 @@ module Vips
|
|
1418
1966
|
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1419
1967
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1420
1968
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1421
|
-
# @option opts [Boolean] :optimize_scans Split
|
1969
|
+
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1422
1970
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1971
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1423
1972
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1424
1973
|
# @option opts [Array<Double>] :background Background value
|
1974
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1425
1975
|
# @return [VipsBlob] Buffer to save to
|
1426
1976
|
|
1977
|
+
# @!method jpegsave_target(target, **opts)
|
1978
|
+
# Save image to jpeg target.
|
1979
|
+
# @param target [Vips::Target] Target to save to
|
1980
|
+
# @param opts [Hash] Set of options
|
1981
|
+
# @option opts [Integer] :Q Q factor
|
1982
|
+
# @option opts [String] :profile ICC profile to embed
|
1983
|
+
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1984
|
+
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1985
|
+
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1986
|
+
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1987
|
+
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1988
|
+
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1989
|
+
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1990
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1991
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1992
|
+
# @option opts [Array<Double>] :background Background value
|
1993
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1994
|
+
# @return [nil]
|
1995
|
+
|
1427
1996
|
# @!method jpegsave_mime(**opts)
|
1428
1997
|
# Save image to jpeg mime.
|
1429
1998
|
# @param opts [Hash] Set of options
|
1430
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1431
1999
|
# @option opts [Integer] :Q Q factor
|
1432
2000
|
# @option opts [String] :profile ICC profile to embed
|
1433
2001
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
@@ -1435,17 +2003,18 @@ module Vips
|
|
1435
2003
|
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1436
2004
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1437
2005
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1438
|
-
# @option opts [Boolean] :optimize_scans Split
|
2006
|
+
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1439
2007
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
2008
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1440
2009
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1441
2010
|
# @option opts [Array<Double>] :background Background value
|
2011
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1442
2012
|
# @return [nil]
|
1443
2013
|
|
1444
2014
|
# @!method webpsave(filename, **opts)
|
1445
2015
|
# Save image to webp file.
|
1446
2016
|
# @param filename [String] Filename to save to
|
1447
2017
|
# @param opts [Hash] Set of options
|
1448
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1449
2018
|
# @option opts [Integer] :Q Q factor
|
1450
2019
|
# @option opts [Boolean] :lossless enable lossless compression
|
1451
2020
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
@@ -1456,14 +2025,15 @@ module Vips
|
|
1456
2025
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1457
2026
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1458
2027
|
# @option opts [Integer] :reduction_effort Level of CPU effort to reduce file size
|
2028
|
+
# @option opts [String] :profile ICC profile to embed
|
1459
2029
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1460
2030
|
# @option opts [Array<Double>] :background Background value
|
2031
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1461
2032
|
# @return [nil]
|
1462
2033
|
|
1463
2034
|
# @!method webpsave_buffer(**opts)
|
1464
2035
|
# Save image to webp buffer.
|
1465
2036
|
# @param opts [Hash] Set of options
|
1466
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1467
2037
|
# @option opts [Integer] :Q Q factor
|
1468
2038
|
# @option opts [Boolean] :lossless enable lossless compression
|
1469
2039
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
@@ -1474,10 +2044,32 @@ module Vips
|
|
1474
2044
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1475
2045
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1476
2046
|
# @option opts [Integer] :reduction_effort Level of CPU effort to reduce file size
|
2047
|
+
# @option opts [String] :profile ICC profile to embed
|
1477
2048
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1478
2049
|
# @option opts [Array<Double>] :background Background value
|
2050
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1479
2051
|
# @return [VipsBlob] Buffer to save to
|
1480
2052
|
|
2053
|
+
# @!method webpsave_target(target, **opts)
|
2054
|
+
# Save image to webp target.
|
2055
|
+
# @param target [Vips::Target] Target to save to
|
2056
|
+
# @param opts [Hash] Set of options
|
2057
|
+
# @option opts [Integer] :Q Q factor
|
2058
|
+
# @option opts [Boolean] :lossless enable lossless compression
|
2059
|
+
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
2060
|
+
# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
|
2061
|
+
# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
|
2062
|
+
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
2063
|
+
# @option opts [Boolean] :min_size Optimise for minium size
|
2064
|
+
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
2065
|
+
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
2066
|
+
# @option opts [Integer] :reduction_effort Level of CPU effort to reduce file size
|
2067
|
+
# @option opts [String] :profile ICC profile to embed
|
2068
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
2069
|
+
# @option opts [Array<Double>] :background Background value
|
2070
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2071
|
+
# @return [nil]
|
2072
|
+
|
1481
2073
|
# @!method tiffsave(filename, **opts)
|
1482
2074
|
# Save image to tiff file.
|
1483
2075
|
# @param filename [String] Filename to save to
|
@@ -1485,22 +2077,29 @@ module Vips
|
|
1485
2077
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
1486
2078
|
# @option opts [Integer] :Q Q factor
|
1487
2079
|
# @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
|
1488
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1489
2080
|
# @option opts [String] :profile ICC profile to embed
|
1490
2081
|
# @option opts [Boolean] :tile Write a tiled tiff
|
1491
2082
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1492
2083
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1493
2084
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1494
|
-
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1495
2085
|
# @option opts [Boolean] :squash Squash images down to 1 bit
|
2086
|
+
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
2087
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1496
2088
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1497
2089
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1498
2090
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
1499
2091
|
# @option opts [Boolean] :bigtiff Write a bigtiff image
|
2092
|
+
# @option opts [Boolean] :rgbjpeg Output RGB JPEG rather than YCbCr
|
1500
2093
|
# @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
|
1501
2094
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
2095
|
+
# @option opts [Integer] :level ZSTD compression level
|
2096
|
+
# @option opts [Boolean] :lossless Enable WEBP lossless mode
|
2097
|
+
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
2098
|
+
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
2099
|
+
# @option opts [Boolean] :premultiply Save with premultiplied alpha
|
1502
2100
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1503
2101
|
# @option opts [Array<Double>] :background Background value
|
2102
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1504
2103
|
# @return [nil]
|
1505
2104
|
|
1506
2105
|
# @!method tiffsave_buffer(**opts)
|
@@ -1509,93 +2108,113 @@ module Vips
|
|
1509
2108
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
1510
2109
|
# @option opts [Integer] :Q Q factor
|
1511
2110
|
# @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
|
1512
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1513
2111
|
# @option opts [String] :profile ICC profile to embed
|
1514
2112
|
# @option opts [Boolean] :tile Write a tiled tiff
|
1515
2113
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1516
2114
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1517
2115
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1518
|
-
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1519
2116
|
# @option opts [Boolean] :squash Squash images down to 1 bit
|
2117
|
+
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
2118
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1520
2119
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1521
2120
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1522
2121
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
1523
2122
|
# @option opts [Boolean] :bigtiff Write a bigtiff image
|
2123
|
+
# @option opts [Boolean] :rgbjpeg Output RGB JPEG rather than YCbCr
|
1524
2124
|
# @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
|
1525
2125
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
2126
|
+
# @option opts [Integer] :level ZSTD compression level
|
2127
|
+
# @option opts [Boolean] :lossless Enable WEBP lossless mode
|
2128
|
+
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
2129
|
+
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
2130
|
+
# @option opts [Boolean] :premultiply Save with premultiplied alpha
|
1526
2131
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1527
2132
|
# @option opts [Array<Double>] :background Background value
|
1528
|
-
# @return [VipsBlob] Buffer to save to
|
1529
|
-
|
1530
|
-
# @!method magicksave(filename, **opts)
|
1531
|
-
# Save file with imagemagick.
|
1532
|
-
# @param filename [String] Filename to save to
|
1533
|
-
# @param opts [Hash] Set of options
|
1534
|
-
# @option opts [String] :format Format to save in
|
1535
|
-
# @option opts [Integer] :quality Quality to use
|
1536
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1537
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
1538
|
-
# @option opts [Array<Double>] :background Background value
|
1539
|
-
# @return [nil]
|
1540
|
-
|
1541
|
-
# @!method magicksave_buffer(**opts)
|
1542
|
-
# Save image to magick buffer.
|
1543
|
-
# @param opts [Hash] Set of options
|
1544
|
-
# @option opts [String] :format Format to save in
|
1545
|
-
# @option opts [Integer] :quality Quality to use
|
1546
2133
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1547
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
1548
|
-
# @option opts [Array<Double>] :background Background value
|
1549
2134
|
# @return [VipsBlob] Buffer to save to
|
1550
2135
|
|
1551
2136
|
# @!method fitssave(filename, **opts)
|
1552
2137
|
# Save image to fits file.
|
1553
2138
|
# @param filename [String] Filename to save to
|
1554
2139
|
# @param opts [Hash] Set of options
|
1555
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1556
2140
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1557
2141
|
# @option opts [Array<Double>] :background Background value
|
2142
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1558
2143
|
# @return [nil]
|
1559
2144
|
|
1560
2145
|
# @!method niftisave(filename, **opts)
|
1561
2146
|
# Save image to nifti file.
|
1562
2147
|
# @param filename [String] Filename to save to
|
1563
2148
|
# @param opts [Hash] Set of options
|
1564
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1565
2149
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1566
2150
|
# @option opts [Array<Double>] :background Background value
|
2151
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1567
2152
|
# @return [nil]
|
1568
2153
|
|
1569
2154
|
# @!method heifsave(filename, **opts)
|
1570
2155
|
# Save image in heif format.
|
1571
|
-
# @param filename [String] Filename to
|
2156
|
+
# @param filename [String] Filename to save to
|
1572
2157
|
# @param opts [Hash] Set of options
|
1573
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1574
2158
|
# @option opts [Integer] :Q Q factor
|
1575
2159
|
# @option opts [Boolean] :lossless Enable lossless compression
|
2160
|
+
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
2161
|
+
# @option opts [Integer] :speed CPU effort
|
2162
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1576
2163
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1577
2164
|
# @option opts [Array<Double>] :background Background value
|
2165
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1578
2166
|
# @return [nil]
|
1579
2167
|
|
1580
|
-
# @!method
|
2168
|
+
# @!method heifsave_buffer(**opts)
|
1581
2169
|
# Save image in heif format.
|
1582
|
-
# @param filename [String] Filename to load from
|
1583
2170
|
# @param opts [Hash] Set of options
|
1584
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1585
2171
|
# @option opts [Integer] :Q Q factor
|
1586
2172
|
# @option opts [Boolean] :lossless Enable lossless compression
|
2173
|
+
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
2174
|
+
# @option opts [Integer] :speed CPU effort
|
2175
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1587
2176
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1588
2177
|
# @option opts [Array<Double>] :background Background value
|
1589
|
-
# @
|
2178
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2179
|
+
# @return [VipsBlob] Buffer to save to
|
1590
2180
|
|
1591
|
-
# @!method
|
2181
|
+
# @!method heifsave_target(target, **opts)
|
1592
2182
|
# Save image in heif format.
|
2183
|
+
# @param target [Vips::Target] Target to save to
|
1593
2184
|
# @param opts [Hash] Set of options
|
1594
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1595
2185
|
# @option opts [Integer] :Q Q factor
|
1596
2186
|
# @option opts [Boolean] :lossless Enable lossless compression
|
2187
|
+
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
2188
|
+
# @option opts [Integer] :speed CPU effort
|
2189
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
2190
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
2191
|
+
# @option opts [Array<Double>] :background Background value
|
2192
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2193
|
+
# @return [nil]
|
2194
|
+
|
2195
|
+
# @!method magicksave(filename, **opts)
|
2196
|
+
# Save file with imagemagick.
|
2197
|
+
# @param filename [String] Filename to save to
|
2198
|
+
# @param opts [Hash] Set of options
|
2199
|
+
# @option opts [String] :format Format to save in
|
2200
|
+
# @option opts [Integer] :quality Quality to use
|
2201
|
+
# @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
|
2202
|
+
# @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
|
2203
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
2204
|
+
# @option opts [Array<Double>] :background Background value
|
2205
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2206
|
+
# @return [nil]
|
2207
|
+
|
2208
|
+
# @!method magicksave_buffer(**opts)
|
2209
|
+
# Save image to magick buffer.
|
2210
|
+
# @param opts [Hash] Set of options
|
2211
|
+
# @option opts [String] :format Format to save in
|
2212
|
+
# @option opts [Integer] :quality Quality to use
|
2213
|
+
# @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
|
2214
|
+
# @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
|
1597
2215
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1598
2216
|
# @option opts [Array<Double>] :background Background value
|
2217
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1599
2218
|
# @return [VipsBlob] Buffer to save to
|
1600
2219
|
|
1601
2220
|
# @!method self.thumbnail(filename, width, **opts)
|
@@ -1611,6 +2230,7 @@ module Vips
|
|
1611
2230
|
# @option opts [String] :import_profile Fallback import profile
|
1612
2231
|
# @option opts [String] :export_profile Fallback export profile
|
1613
2232
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2233
|
+
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
1614
2234
|
# @return [Vips::Image] Output image
|
1615
2235
|
|
1616
2236
|
# @!method self.thumbnail_buffer(buffer, width, **opts)
|
@@ -1627,6 +2247,7 @@ module Vips
|
|
1627
2247
|
# @option opts [String] :import_profile Fallback import profile
|
1628
2248
|
# @option opts [String] :export_profile Fallback export profile
|
1629
2249
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2250
|
+
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
1630
2251
|
# @return [Vips::Image] Output image
|
1631
2252
|
|
1632
2253
|
# @!method thumbnail_image(width, **opts)
|
@@ -1641,6 +2262,24 @@ module Vips
|
|
1641
2262
|
# @option opts [String] :import_profile Fallback import profile
|
1642
2263
|
# @option opts [String] :export_profile Fallback export profile
|
1643
2264
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2265
|
+
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
2266
|
+
# @return [Vips::Image] Output image
|
2267
|
+
|
2268
|
+
# @!method self.thumbnail_source(source, width, **opts)
|
2269
|
+
# Generate thumbnail from source.
|
2270
|
+
# @param source [Vips::Source] Source to load from
|
2271
|
+
# @param width [Integer] Size to this width
|
2272
|
+
# @param opts [Hash] Set of options
|
2273
|
+
# @option opts [String] :option_string Options that are passed on to the underlying loader
|
2274
|
+
# @option opts [Integer] :height Size to this height
|
2275
|
+
# @option opts [Vips::Size] :size Only upsize, only downsize, or both
|
2276
|
+
# @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
|
2277
|
+
# @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
|
2278
|
+
# @option opts [Boolean] :linear Reduce in linear light
|
2279
|
+
# @option opts [String] :import_profile Fallback import profile
|
2280
|
+
# @option opts [String] :export_profile Fallback export profile
|
2281
|
+
# @option opts [Vips::Intent] :intent Rendering intent
|
2282
|
+
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
1644
2283
|
# @return [Vips::Image] Output image
|
1645
2284
|
|
1646
2285
|
# @!method mapim(index, **opts)
|
@@ -1655,24 +2294,29 @@ module Vips
|
|
1655
2294
|
# @param hshrink [Float] Horizontal shrink factor
|
1656
2295
|
# @param vshrink [Float] Vertical shrink factor
|
1657
2296
|
# @param opts [Hash] Set of options
|
2297
|
+
# @option opts [Float] :xshrink Horizontal shrink factor
|
2298
|
+
# @option opts [Float] :yshrink Vertical shrink factor
|
1658
2299
|
# @return [Vips::Image] Output image
|
1659
2300
|
|
1660
2301
|
# @!method shrinkh(hshrink, **opts)
|
1661
2302
|
# Shrink an image horizontally.
|
1662
2303
|
# @param hshrink [Integer] Horizontal shrink factor
|
1663
2304
|
# @param opts [Hash] Set of options
|
2305
|
+
# @option opts [Integer] :xshrink Horizontal shrink factor
|
1664
2306
|
# @return [Vips::Image] Output image
|
1665
2307
|
|
1666
2308
|
# @!method shrinkv(vshrink, **opts)
|
1667
2309
|
# Shrink an image vertically.
|
1668
2310
|
# @param vshrink [Integer] Vertical shrink factor
|
1669
2311
|
# @param opts [Hash] Set of options
|
2312
|
+
# @option opts [Integer] :yshrink Vertical shrink factor
|
1670
2313
|
# @return [Vips::Image] Output image
|
1671
2314
|
|
1672
2315
|
# @!method reduceh(hshrink, **opts)
|
1673
2316
|
# Shrink an image horizontally.
|
1674
2317
|
# @param hshrink [Float] Horizontal shrink factor
|
1675
2318
|
# @param opts [Hash] Set of options
|
2319
|
+
# @option opts [Float] :xshrink Horizontal shrink factor
|
1676
2320
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1677
2321
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1678
2322
|
# @return [Vips::Image] Output image
|
@@ -1681,6 +2325,7 @@ module Vips
|
|
1681
2325
|
# Shrink an image vertically.
|
1682
2326
|
# @param vshrink [Float] Vertical shrink factor
|
1683
2327
|
# @param opts [Hash] Set of options
|
2328
|
+
# @option opts [Float] :yshrink Vertical shrink factor
|
1684
2329
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1685
2330
|
# @option opts [Boolean] :centre Use centre sampling convention
|
1686
2331
|
# @return [Vips::Image] Output image
|
@@ -1692,6 +2337,8 @@ module Vips
|
|
1692
2337
|
# @param opts [Hash] Set of options
|
1693
2338
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
1694
2339
|
# @option opts [Boolean] :centre Use centre sampling convention
|
2340
|
+
# @option opts [Float] :xshrink Horizontal shrink factor
|
2341
|
+
# @option opts [Float] :yshrink Vertical shrink factor
|
1695
2342
|
# @return [Vips::Image] Output image
|
1696
2343
|
|
1697
2344
|
# @!method quadratic(coeff, **opts)
|
@@ -1712,6 +2359,7 @@ module Vips
|
|
1712
2359
|
# @option opts [Float] :idx Horizontal input displacement
|
1713
2360
|
# @option opts [Float] :idy Vertical input displacement
|
1714
2361
|
# @option opts [Array<Double>] :background Background value
|
2362
|
+
# @option opts [Boolean] :premultiplied Images have premultiplied alpha
|
1715
2363
|
# @option opts [Vips::Extend] :extend How to generate the extra pixels
|
1716
2364
|
# @return [Vips::Image] Output image
|
1717
2365
|
|
@@ -1744,8 +2392,12 @@ module Vips
|
|
1744
2392
|
# Resize an image.
|
1745
2393
|
# @param scale [Float] Scale image by this factor
|
1746
2394
|
# @param opts [Hash] Set of options
|
2395
|
+
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
1747
2396
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2397
|
+
# @option opts [Boolean] :centre Use centre sampling convention
|
1748
2398
|
# @option opts [Float] :vscale Vertical scale image by this factor
|
2399
|
+
# @option opts [Float] :idx Horizontal input displacement
|
2400
|
+
# @option opts [Float] :idy Vertical input displacement
|
1749
2401
|
# @return [Vips::Image] Output image
|
1750
2402
|
|
1751
2403
|
# @!method colourspace(space, **opts)
|
@@ -1867,6 +2519,7 @@ module Vips
|
|
1867
2519
|
# @param opts [Hash] Set of options
|
1868
2520
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1869
2521
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2522
|
+
# @option opts [Boolean] :black_point_compensation Enable black point compensation
|
1870
2523
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
1871
2524
|
# @option opts [String] :input_profile Filename to load input profile from
|
1872
2525
|
# @return [Vips::Image] Output image
|
@@ -1876,6 +2529,7 @@ module Vips
|
|
1876
2529
|
# @param opts [Hash] Set of options
|
1877
2530
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1878
2531
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2532
|
+
# @option opts [Boolean] :black_point_compensation Enable black point compensation
|
1879
2533
|
# @option opts [String] :output_profile Filename to load output profile from
|
1880
2534
|
# @option opts [Integer] :depth Output device space depth in bits
|
1881
2535
|
# @return [Vips::Image] Output image
|
@@ -1886,6 +2540,7 @@ module Vips
|
|
1886
2540
|
# @param opts [Hash] Set of options
|
1887
2541
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
1888
2542
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2543
|
+
# @option opts [Boolean] :black_point_compensation Enable black point compensation
|
1889
2544
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
1890
2545
|
# @option opts [String] :input_profile Filename to load input profile from
|
1891
2546
|
# @option opts [Integer] :depth Output device space depth in bits
|
@@ -1949,6 +2604,12 @@ module Vips
|
|
1949
2604
|
# @option opts [Integer] :band apply one-band lut to this band of in
|
1950
2605
|
# @return [Vips::Image] Output image
|
1951
2606
|
|
2607
|
+
# @!method case(cases, **opts)
|
2608
|
+
# Use pixel values to pick cases from an array of images.
|
2609
|
+
# @param cases [Array<Image>] Array of case images
|
2610
|
+
# @param opts [Hash] Set of options
|
2611
|
+
# @return [Vips::Image] Output image
|
2612
|
+
|
1952
2613
|
# @!method percent(percent, **opts)
|
1953
2614
|
# Find threshold for percent of pixels.
|
1954
2615
|
# @param percent [Float] Percent of pixels
|
@@ -2083,6 +2744,7 @@ module Vips
|
|
2083
2744
|
# @!method sharpen(**opts)
|
2084
2745
|
# Unsharp masking for print.
|
2085
2746
|
# @param opts [Hash] Set of options
|
2747
|
+
# @option opts [Integer] :radius radius of Gaussian
|
2086
2748
|
# @option opts [Float] :sigma Sigma of Gaussian
|
2087
2749
|
# @option opts [Float] :x1 Flat/jaggy threshold
|
2088
2750
|
# @option opts [Float] :y2 Maximum brightening
|
@@ -2247,7 +2909,7 @@ module Vips
|
|
2247
2909
|
# @!method merge(sec, direction, dx, dy, **opts)
|
2248
2910
|
# Merge two images.
|
2249
2911
|
# @param sec [Vips::Image] Secondary image
|
2250
|
-
# @param direction [Vips::Direction] Horizontal or
|
2912
|
+
# @param direction [Vips::Direction] Horizontal or vertical merge
|
2251
2913
|
# @param dx [Integer] Horizontal displacement from sec to ref
|
2252
2914
|
# @param dy [Integer] Vertical displacement from sec to ref
|
2253
2915
|
# @param opts [Hash] Set of options
|
@@ -2257,7 +2919,7 @@ module Vips
|
|
2257
2919
|
# @!method mosaic(sec, direction, xref, yref, xsec, ysec, **opts)
|
2258
2920
|
# Mosaic two images.
|
2259
2921
|
# @param sec [Vips::Image] Secondary image
|
2260
|
-
# @param direction [Vips::Direction] Horizontal or
|
2922
|
+
# @param direction [Vips::Direction] Horizontal or vertical mosaic
|
2261
2923
|
# @param xref [Integer] Position of reference tie-point
|
2262
2924
|
# @param yref [Integer] Position of reference tie-point
|
2263
2925
|
# @param xsec [Integer] Position of secondary tie-point
|
@@ -2278,7 +2940,7 @@ module Vips
|
|
2278
2940
|
# @!method mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, **opts)
|
2279
2941
|
# First-order mosaic of two images.
|
2280
2942
|
# @param sec [Vips::Image] Secondary image
|
2281
|
-
# @param direction [Vips::Direction] Horizontal or
|
2943
|
+
# @param direction [Vips::Direction] Horizontal or vertical mosaic
|
2282
2944
|
# @param xr1 [Integer] Position of first reference tie-point
|
2283
2945
|
# @param yr1 [Integer] Position of first reference tie-point
|
2284
2946
|
# @param xs1 [Integer] Position of first secondary tie-point
|
@@ -2296,6 +2958,11 @@ module Vips
|
|
2296
2958
|
# @option opts [Integer] :bandno Band to search for features on
|
2297
2959
|
# @return [Vips::Image] Output image
|
2298
2960
|
|
2961
|
+
# @!method matrixinvert(**opts)
|
2962
|
+
# Invert an matrix.
|
2963
|
+
# @param opts [Hash] Set of options
|
2964
|
+
# @return [Vips::Image] Output matrix
|
2965
|
+
|
2299
2966
|
# @!method match(sec, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, **opts)
|
2300
2967
|
# First-order match of two images.
|
2301
2968
|
# @param sec [Vips::Image] Secondary image
|