|
vips-cpp 8.16
libvips C++ binding
|
Loading...
Searching...
No Matches
VImage Class Reference
#include <VImage8.h>
Inheritance diagram for VImage:
Collaboration diagram for VImage:
Public Member Functions inherited from Detailed Description
An image object.
Image processing operations on images are member functions of VImage. For example:
VImage in = VImage::new_from_file(argv[1], VImage::option()
->set("access", "sequential"));
VImage out = in.embed(10, 10, 1000, 1000, VImage::option()
->set("extend", "copy"));
out.write_to_file(argv[2]);
VImage objects are smart pointers over the underlying VipsImage objects. They manage the complications of GLib's ref and unref system for you.
Constructor & Destructor Documentation
◆ VImage() [1/2]
|
inlineexplicit |
◆ VImage() [2/2]
|
inline |
An empty (NULL) VImage, eg. "VImage a;"
Member Function Documentation
◆ abs()
Absolute value of an image.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ acos()
Find the arc cosine of each pixel. Angles are in degrees.
◆ acosh()
Find the hyperbolic arc cosine of each pixel. Angles are in radians.
◆ add()
Add two images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ addalpha()
Append an alpha channel.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ affine()
Affine transform of an image.
Optional parameters
- interpolate – Interpolate pixels with this, VInterpolate.
- oarea – Area of output to generate, std::vector<int>.
- odx – Horizontal output displacement, double.
- ody – Vertical output displacement, double.
- idx – Horizontal input displacement, double.
- idy – Vertical input displacement, double.
- background – Background value, std::vector<double>.
- premultiplied – Images have premultiplied alpha, bool.
- extend – How to generate the extra pixels, VipsExtend.
- Parameters
-
matrix Transformation matrix. options Set of options.
- Returns
- Output image.
◆ analyzeload()
Load an analyze6 image.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ arrayjoin()
Join an array of images.
Optional parameters
- across – Number of images across grid, int.
- shim – Pixels between images, int.
- background – Colour for new pixels, std::vector<double>.
- halign – Align on the left, centre or right, VipsAlign.
- valign – Align on the top, centre or bottom, VipsAlign.
- hspacing – Horizontal spacing between images, int.
- vspacing – Vertical spacing between images, int.
- Parameters
-
in Array of input images. options Set of options.
- Returns
- Output image.
◆ asin()
Find the arc sine of each pixel. Angles are in degrees.
◆ asinh()
Find the hyperbolic arc sine of each pixel. Angles are in radians.
◆ atan()
Find the arc tangent of each pixel. Angles are in degrees.
◆ atan2() [1/3]
Calculate atan2 of each pixel.
◆ atan2() [2/3]
Calculate atan2 of each pixel.
◆ atan2() [3/3]
Calculate atan2 of each pixel.
◆ atanh()
Find the hyperbolic arc tangent of each pixel. Angles are in radians.
◆ autorot()
Autorotate image by exif tag.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ avg()
Find image average.
- Parameters
-
options Set of options.
- Returns
- Output value.
◆ bandand()
AND all bands of an image together to make a one-band image. Useful with the relational operators, for example:
VImage mask = (in > 128).bandand()
◆ bandbool()
| VImage VImage::bandbool | ( | VipsOperationBoolean | boolean, |
| VOption * |
options = nullptr |
||
| ) | const |
Boolean operation across image bands.
- Parameters
-
boolean Boolean to perform. options Set of options.
- Returns
- Output image.
◆ bandeor()
EOR all bands of an image together to make a one-band image. Useful with the relational operators, for example:
VImage mask = (in > 128).bandand()
◆ bandfold()
Fold up x axis into bands.
Optional parameters
- factor – Fold by this factor, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ bandjoin() [1/4]
Append a band to an image, with each element initialized to the constant value.
◆ bandjoin() [2/4]
Append a series of bands to an image, with each element initialized to the constant values.
◆ bandjoin() [3/4]
Bandwise join a set of images.
- Parameters
-
in Array of input images. options Set of options.
- Returns
- Output image.
◆ bandjoin() [4/4]
Join two images bandwise.
◆ bandjoin_const()
Append a constant band to an image.
- Parameters
-
c Array of constants to add. options Set of options.
- Returns
- Output image.
◆ bandmean()
Band-wise average.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ bandor()
OR all bands of an image together to make a one-band image. Useful with the relational operators, for example:
VImage mask = (in > 128).bandand()
◆ bandrank()
Band-wise rank of a set of images.
Optional parameters
- index – Select this band element from sorted list, int.
- Parameters
-
in Array of input images. options Set of options.
- Returns
- Output image.
◆ bands()
|
inline |
Return the number of image bands.
◆ bandsplit()
Split a many-band image into an array of one-band images.
◆ bandunfold()
Unfold image bands into x axis.
Optional parameters
- factor – Unfold by this factor, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ black()
Make a black image.
Optional parameters
- bands – Number of bands in image, int.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ boolean()
| VImage VImage::boolean | ( | VImage | right, |
| VipsOperationBoolean | boolean, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Boolean operation on two images.
- Parameters
-
right Right-hand image argument. boolean Boolean to perform. options Set of options.
- Returns
- Output image.
◆ boolean_const()
| VImage VImage::boolean_const | ( | VipsOperationBoolean | boolean, |
| std::vector< double > | c, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Boolean operations against a constant.
- Parameters
-
boolean Boolean to perform. c Array of constants. options Set of options.
- Returns
- Output image.
◆ buildlut()
Build a look-up table.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ byteswap()
Byteswap an image.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ cache()
Cache an image.
Optional parameters
- max_tiles – Maximum number of tiles to cache, int.
- tile_height – Tile height in pixels, int.
- tile_width – Tile width in pixels, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ call()
Call any libvips operation.
◆ call_option_string()
|
static |
Call any libvips operation, with a set of string-encoded options as well as VOption.
◆ canny()
Canny edge detector.
Optional parameters
- sigma – Sigma of Gaussian, double.
- precision – Convolve with this precision, VipsPrecision.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ case_image()
Use pixel values to pick cases from an array of images.
- Parameters
-
cases Array of case images. options Set of options.
- Returns
- Output image.
◆ cast()
| VImage VImage::cast | ( | VipsBandFormat | format, |
| VOption * |
options = nullptr |
||
| ) | const |
Cast an image.
Optional parameters
- shift – Shift integer values up and down, bool.
- Parameters
-
format Format to cast to. options Set of options.
- Returns
- Output image.
◆ ceil()
◆ clamp()
Clamp values of an image.
Optional parameters
- min – Minimum value, double.
- max – Maximum value, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ CMC2LCh()
Transform lch to cmc.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ CMYK2XYZ()
Transform cmyk to xyz.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ coding()
|
inline |
Return the image coding, for example VIPS_CODING_NONE.
◆ colourspace()
| VImage VImage::colourspace | ( | VipsInterpretation | space, |
| VOption * |
options = nullptr |
||
| ) | const |
Convert to a new colorspace.
Optional parameters
- source_space – Source color space, VipsInterpretation.
- Parameters
-
space Destination color space. options Set of options.
- Returns
- Output image.
◆ compass()
Convolve with rotating mask.
Optional parameters
- times – Rotate and convolve this many times, int.
- angle – Rotate mask by this much between convolutions, VipsAngle45.
- combine – Combine convolution results like this, VipsCombine.
- precision – Convolve with this precision, VipsPrecision.
- layers – Use this many layers in approximation, int.
- cluster – Cluster lines closer than this in approximation, int.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ complex()
Perform a complex operation on an image.
- Parameters
-
cmplx Complex to perform. options Set of options.
- Returns
- Output image.
◆ complex2()
| VImage VImage::complex2 | ( | VImage | right, |
| VipsOperationComplex2 | cmplx, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Complex binary operations on two images.
- Parameters
-
right Right-hand image argument. cmplx Binary complex operation to perform. options Set of options.
- Returns
- Output image.
◆ complexform()
Form a complex image from two real images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ complexget()
| VImage VImage::complexget | ( | VipsOperationComplexget | get, |
| VOption * |
options = nullptr |
||
| ) | const |
Get a component from a complex image.
- Parameters
-
get Complex to perform. options Set of options.
- Returns
- Output image.
◆ composite() [1/2]
|
static |
Blend an array of images with an array of blend modes.
Optional parameters
- x – Array of x coordinates to join at, std::vector<int>.
- y – Array of y coordinates to join at, std::vector<int>.
- compositing_space – Composite images in this colour space, VipsInterpretation.
- premultiplied – Images have premultiplied alpha, bool.
- Parameters
-
in Array of input images. mode Array of VipsBlendMode to join with. options Set of options.
- Returns
- Output image.
◆ composite() [2/2]
| VImage VImage::composite | ( | VImage | other, |
| VipsBlendMode | mode, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Composite other on top of self using the specified blending mode.
◆ composite2()
| VImage VImage::composite2 | ( | VImage | overlay, |
| VipsBlendMode | mode, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Blend a pair of images with a blend mode.
Optional parameters
- x – x position of overlay, int.
- y – y position of overlay, int.
- compositing_space – Composite images in this colour space, VipsInterpretation.
- premultiplied – Images have premultiplied alpha, bool.
- Parameters
-
overlay Overlay image. mode VipsBlendMode to join with. options Set of options.
- Returns
- Output image.
◆ conj()
◆ conv()
Convolution operation.
Optional parameters
- precision – Convolve with this precision, VipsPrecision.
- layers – Use this many layers in approximation, int.
- cluster – Cluster lines closer than this in approximation, int.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ conva()
Approximate integer convolution.
Optional parameters
- layers – Use this many layers in approximation, int.
- cluster – Cluster lines closer than this in approximation, int.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ convasep()
Approximate separable integer convolution.
Optional parameters
- layers – Use this many layers in approximation, int.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ convf()
Float convolution operation.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ convi()
Int convolution operation.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ convsep()
Separable convolution operation.
Optional parameters
- precision – Convolve with this precision, VipsPrecision.
- layers – Use this many layers in approximation, int.
- cluster – Cluster lines closer than this in approximation, int.
- Parameters
-
mask Input matrix image. options Set of options.
- Returns
- Output image.
◆ copy()
Copy an image.
Optional parameters
- width – Image width in pixels, int.
- height – Image height in pixels, int.
- bands – Number of bands in image, int.
- format – Pixel format in image, VipsBandFormat.
- coding – Pixel coding, VipsCoding.
- interpretation – Pixel interpretation, VipsInterpretation.
- xres – Horizontal resolution in pixels/mm, double.
- yres – Vertical resolution in pixels/mm, double.
- xoffset – Horizontal offset of origin, int.
- yoffset – Vertical offset of origin, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ copy_memory()
|
inline |
This operation allocates memory, renders self into it, builds a new image around the memory area, and returns that.
If the image is already a simple area of memory, it does nothing.
Call this before using the draw operations to make sure you have a memory image that can be modified.
VImage::copy() adds a null "copy" node to a pipeline. Use that instead if you want to change metadata and not pixels.
◆ cos()
Find the cosine of each pixel. Angles are in degrees.
◆ cosh()
Find the hyperbolic cosine of each pixel. Angles are in degrees.
◆ countlines()
| double VImage::countlines | ( | VipsDirection | direction, |
| VOption * |
options = nullptr |
||
| ) | const |
Count lines in an image.
- Parameters
-
direction Countlines left-right or up-down. options Set of options.
- Returns
- Number of lines.
◆ crop()
Extract an area from an image.
- Parameters
-
left Left edge of extract area. top Top edge of extract area. width Width of extract area. height Height of extract area. options Set of options.
- Returns
- Output image.
◆ csvload()
Load csv.
Optional parameters
- skip – Skip this many lines at the start of the file, int.
- lines – Read this many lines from the file, int.
- whitespace – Set of whitespace characters, const char *.
- separator – Set of separator characters, const char *.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ csvload_source()
Load csv.
Optional parameters
- skip – Skip this many lines at the start of the file, int.
- lines – Read this many lines from the file, int.
- whitespace – Set of whitespace characters, const char *.
- separator – Set of separator characters, const char *.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ csvsave()
Save image to csv.
Optional parameters
- separator – Separator characters, const char *.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ csvsave_target()
Save image to csv.
Optional parameters
- separator – Separator characters, const char *.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ data()
Arrange for the underlying object to be entirely in memory, then return a pointer to the first pixel.
This can take a long time and need a very large amount of RAM.
◆ dE00()
Calculate de00.
- Parameters
-
right Right-hand input image. options Set of options.
- Returns
- Output image.
◆ dE76()
Calculate de76.
- Parameters
-
right Right-hand input image. options Set of options.
- Returns
- Output image.
◆ dECMC()
Calculate decmc.
- Parameters
-
right Right-hand input image. options Set of options.
- Returns
- Output image.
◆ deviate()
Find image standard deviation.
- Parameters
-
options Set of options.
- Returns
- Output value.
◆ dilate()
Dilate the image with the specified structuring element, see VImage::new_matrix(). Structuring element values can be 0 for black, 255 for white and 128 for don't care. See VImage::morph().
◆ divide()
Divide two images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ draw_circle() [1/2]
|
inline |
Draw a circle on an image.
Optional parameters
- fill – Draw a solid object, bool.
- Parameters
-
ink Color for pixels. cx Centre of draw_circle. cy Centre of draw_circle. radius Radius in pixels. options Set of options.
◆ draw_circle() [2/2]
| void VImage::draw_circle | ( | std::vector< double > | ink, |
| int | cx, | ||
| int | cy, | ||
| int | radius, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Draw a circle on an image.
Optional parameters
- fill – Draw a solid object, bool.
- Parameters
-
ink Color for pixels. cx Centre of draw_circle. cy Centre of draw_circle. radius Radius in pixels. options Set of options.
◆ draw_flood() [1/2]
Flood-fill an area.
Optional parameters
- test – Test pixels in this image, VImage.
- equal – DrawFlood while equal to edge, bool.
- Parameters
-
ink Color for pixels. x DrawFlood start point. y DrawFlood start point. options Set of options.
◆ draw_flood() [2/2]
| void VImage::draw_flood | ( | std::vector< double > | ink, |
| int | x, | ||
| int | y, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Flood-fill an area.
Optional parameters
- test – Test pixels in this image, VImage.
- equal – DrawFlood while equal to edge, bool.
- Parameters
-
ink Color for pixels. x DrawFlood start point. y DrawFlood start point. options Set of options.
◆ draw_image()
Paint an image into another image.
Optional parameters
- mode – Combining mode, VipsCombineMode.
- Parameters
-
sub Sub-image to insert into main image. x Draw image here. y Draw image here. options Set of options.
◆ draw_line() [1/2]
|
inline |
Draw a line on an image.
- Parameters
-
ink Color for pixels. x1 Start of draw_line. y1 Start of draw_line. x2 End of draw_line. y2 End of draw_line. options Set of options.
◆ draw_line() [2/2]
| void VImage::draw_line | ( | std::vector< double > | ink, |
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Draw a line on an image.
- Parameters
-
ink Color for pixels. x1 Start of draw_line. y1 Start of draw_line. x2 End of draw_line. y2 End of draw_line. options Set of options.
◆ draw_mask() [1/2]
|
inline |
Draw a mask on an image.
- Parameters
-
ink Color for pixels. mask Mask of pixels to draw. x Draw mask here. y Draw mask here. options Set of options.
◆ draw_mask() [2/2]
| void VImage::draw_mask | ( | std::vector< double > | ink, |
| VImage | mask, | ||
| int | x, | ||
| int | y, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Draw a mask on an image.
- Parameters
-
ink Color for pixels. mask Mask of pixels to draw. x Draw mask here. y Draw mask here. options Set of options.
◆ draw_point() [1/2]
Paint a single pixel on an image.
- Parameters
-
ink Color for pixels. x Point to paint. y Point to paint.
◆ draw_point() [2/2]
|
inline |
Paint a single pixel on an image.
- Parameters
-
ink Color for pixels. x Point to paint. y Point to paint.
◆ draw_rect() [1/2]
|
inline |
Paint a rectangle on an image.
Optional parameters
- fill – Draw a solid object, bool.
- Parameters
-
ink Color for pixels. left Rect to fill. top Rect to fill. width Rect to fill. height Rect to fill. options Set of options.
◆ draw_rect() [2/2]
| void VImage::draw_rect | ( | std::vector< double > | ink, |
| int | left, | ||
| int | top, | ||
| int | width, | ||
| int | height, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Paint a rectangle on an image.
Optional parameters
- fill – Draw a solid object, bool.
- Parameters
-
ink Color for pixels. left Rect to fill. top Rect to fill. width Rect to fill. height Rect to fill. options Set of options.
◆ draw_smudge()
| void VImage::draw_smudge | ( | int | left, |
| int | top, | ||
| int | width, | ||
| int | height, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Blur a rectangle on an image.
- Parameters
-
left Rect to fill. top Rect to fill. width Rect to fill. height Rect to fill. options Set of options.
◆ dzsave()
Save image to deepzoom file.
Optional parameters
- imagename – Image name, const char *.
- layout – Directory layout, VipsForeignDzLayout.
- suffix – Filename suffix for tiles, const char *.
- overlap – Tile overlap in pixels, int.
- tile_size – Tile size in pixels, int.
- centre – Center image in tile, bool.
- depth – Pyramid depth, VipsForeignDzDepth.
- angle – Rotate image during save, VipsAngle.
- container – Pyramid container type, VipsForeignDzContainer.
- compression – ZIP deflate compression level, int.
- region_shrink – Method to shrink regions, VipsRegionShrink.
- skip_blanks – Skip tiles which are nearly equal to the background, int.
- id – Resource ID, const char *.
- Q – Q factor, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ dzsave_buffer()
Save image to dz buffer.
Optional parameters
- imagename – Image name, const char *.
- layout – Directory layout, VipsForeignDzLayout.
- suffix – Filename suffix for tiles, const char *.
- overlap – Tile overlap in pixels, int.
- tile_size – Tile size in pixels, int.
- centre – Center image in tile, bool.
- depth – Pyramid depth, VipsForeignDzDepth.
- angle – Rotate image during save, VipsAngle.
- container – Pyramid container type, VipsForeignDzContainer.
- compression – ZIP deflate compression level, int.
- region_shrink – Method to shrink regions, VipsRegionShrink.
- skip_blanks – Skip tiles which are nearly equal to the background, int.
- id – Resource ID, const char *.
- Q – Q factor, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ dzsave_target()
Save image to deepzoom target.
Optional parameters
- imagename – Image name, const char *.
- layout – Directory layout, VipsForeignDzLayout.
- suffix – Filename suffix for tiles, const char *.
- overlap – Tile overlap in pixels, int.
- tile_size – Tile size in pixels, int.
- centre – Center image in tile, bool.
- depth – Pyramid depth, VipsForeignDzDepth.
- angle – Rotate image during save, VipsAngle.
- container – Pyramid container type, VipsForeignDzContainer.
- compression – ZIP deflate compression level, int.
- region_shrink – Method to shrink regions, VipsRegionShrink.
- skip_blanks – Skip tiles which are nearly equal to the background, int.
- id – Resource ID, const char *.
- Q – Q factor, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ embed()
Embed an image in a larger image.
Optional parameters
- extend – How to generate the extra pixels, VipsExtend.
- background – Color for background pixels, std::vector<double>.
- Parameters
-
x Left edge of input in output. y Top edge of input in output. width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ erode()
Erode the image with the specified structuring element, see VImage::new_matrix(). Structuring element values can be 0 for black, 255 for white and 128 for don't care. See VImage::morph().
◆ exp()
◆ exp10()
Find 10 to the power of each pixel.
◆ extract_area()
| VImage VImage::extract_area | ( | int | left, |
| int | top, | ||
| int | width, | ||
| int | height, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Extract an area from an image.
- Parameters
-
left Left edge of extract area. top Top edge of extract area. width Width of extract area. height Height of extract area. options Set of options.
- Returns
- Output image.
◆ extract_band()
Extract band from an image.
Optional parameters
- n – Number of bands to extract, int.
- Parameters
-
band Band to extract. options Set of options.
- Returns
- Output image.
◆ eye()
Make an image showing the eye's spatial response.
Optional parameters
- uchar – Output an unsigned char image, bool.
- factor – Maximum spatial frequency, double.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ falsecolour()
False-color an image.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ fastcor()
Fast correlation.
- Parameters
-
ref Input reference image. options Set of options.
- Returns
- Output image.
◆ filename()
The name of the file this image originally came from, or NULL if it's not a file image.
◆ fill_nearest()
Fill image zeros with nearest non-zero pixel.
- Parameters
-
options Set of options.
- Returns
- Value of nearest non-zero pixel.
◆ find_trim()
Search an image for non-edge areas.
Optional parameters
- threshold – Object threshold, double.
- background – Color for background pixels, std::vector<double>.
- line_art – Enable line art mode, bool.
- Parameters
-
top Top edge of extract area. width Width of extract area. height Height of extract area. options Set of options.
- Returns
- Left edge of image.
◆ fitsload()
Load a fits image.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ fitsload_source()
Load fits from a source.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ fitssave()
Save image to fits file.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ flatten()
Flatten alpha out of an image.
Optional parameters
- background – Background value, std::vector<double>.
- max_alpha – Maximum value of alpha channel, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ flip()
| VImage VImage::flip | ( | VipsDirection | direction, |
| VOption * |
options = nullptr |
||
| ) | const |
Flip an image.
- Parameters
-
direction Direction to flip image. options Set of options.
- Returns
- Output image.
◆ fliphor()
◆ flipver()
◆ float2rad()
Transform float rgb to radiance coding.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ floor()
Convert to integer, rounding down.
◆ format()
|
inline |
Return the image format, for example VIPS_FORMAT_UCHAR.
◆ fractsurf()
|
static |
Make a fractal surface.
- Parameters
-
width Image width in pixels. height Image height in pixels. fractal_dimension Fractal dimension. options Set of options.
- Returns
- Output image.
◆ freqmult()
Frequency-domain filtering.
- Parameters
-
mask Input mask image. options Set of options.
- Returns
- Output image.
◆ fwfft()
Forward fft.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ gamma()
Gamma an image.
Optional parameters
- exponent – Gamma factor, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ gaussblur()
Gaussian blur.
Optional parameters
- min_ampl – Minimum amplitude of Gaussian, double.
- precision – Convolve with this precision, VipsPrecision.
- Parameters
-
sigma Sigma of Gaussian. options Set of options.
- Returns
- Output image.
◆ gaussmat()
Make a gaussian image.
Optional parameters
- separable – Generate separable Gaussian, bool.
- precision – Generate with this precision, VipsPrecision.
- Parameters
-
sigma Sigma of Gaussian. min_ampl Minimum amplitude of Gaussian. options Set of options.
- Returns
- Output image.
◆ gaussnoise()
Make a gaussnoise image.
Optional parameters
- sigma – Standard deviation of pixels in generated image, double.
- mean – Mean of pixels in generated image, double.
- seed – Random number seed, int.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ get_array_double() [1/2]
Get the value of a metadata item as an array of doubles.
If the item is not of this type, an exception is thrown.
◆ get_array_double() [2/2]
Get the value of a metadata item as an array of doubles. Do not free the result.
If the item is not of this type, an exception is thrown.
◆ get_array_int() [1/2]
Get the value of a metadata item as an array of ints.
If the item is not of this type, an exception is thrown.
◆ get_array_int() [2/2]
Get the value of a metadata item as an array of ints. Do not free the result.
If the item is not of this type, an exception is thrown.
◆ get_blob()
Get the value of a metadata item as a binary object. You must not free the result.
If the item is not of this type, an exception is thrown.
◆ get_double()
Get the value of a metadata item as a double.
If the item is not of this type, an exception is thrown.
◆ get_image()
|
inline |
Return the underlying VipsImage reference that this VImage holds. This does not make a new reference – you'll need to g_object_ref() the pointer if you need it to last.
◆ get_int()
Get the value of a metadata item as an int.
If the item is not of this type, an exception is thrown.
◆ get_string()
Get the value of a metadata item as a string. You must not free the result.
If the item is not of this type, an exception is thrown.
◆ get_typeof()
Return the GType of a metadata item, or 0 if the named item does not exist.
◆ getpoint()
Read a point from an image.
Optional parameters
- unpack_complex – Complex pixels should be unpacked, bool.
- Parameters
-
x Point to read. y Point to read. options Set of options.
- Returns
- Array of output values.
◆ gifload()
Load gif with libnsgif.
Optional parameters
- n – Number of pages to load, -1 for all, int.
- page – First page to load, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ gifload_buffer()
Load gif with libnsgif.
Optional parameters
- n – Number of pages to load, -1 for all, int.
- page – First page to load, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ gifload_source()
Load gif from source.
Optional parameters
- n – Number of pages to load, -1 for all, int.
- page – First page to load, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ gifsave()
Save as gif.
Optional parameters
- dither – Amount of dithering, double.
- effort – Quantisation effort, int.
- bitdepth – Number of bits per pixel, int.
- interframe_maxerror – Maximum inter-frame error for transparency, double.
- reuse – Reuse palette from input, bool.
- interpalette_maxerror – Maximum inter-palette error for palette reusage, double.
- interlace – Generate an interlaced (progressive) GIF, bool.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ gifsave_buffer()
Save as gif.
Optional parameters
- dither – Amount of dithering, double.
- effort – Quantisation effort, int.
- bitdepth – Number of bits per pixel, int.
- interframe_maxerror – Maximum inter-frame error for transparency, double.
- reuse – Reuse palette from input, bool.
- interpalette_maxerror – Maximum inter-palette error for palette reusage, double.
- interlace – Generate an interlaced (progressive) GIF, bool.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ gifsave_target()
Save as gif.
Optional parameters
- dither – Amount of dithering, double.
- effort – Quantisation effort, int.
- bitdepth – Number of bits per pixel, int.
- interframe_maxerror – Maximum inter-frame error for transparency, double.
- reuse – Reuse palette from input, bool.
- interpalette_maxerror – Maximum inter-palette error for palette reusage, double.
- interlace – Generate an interlaced (progressive) GIF, bool.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ globalbalance()
Global balance an image mosaic.
Optional parameters
- gamma – Image gamma, double.
- int_output – Integer output, bool.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ gravity()
| VImage VImage::gravity | ( | VipsCompassDirection | direction, |
| int | width, | ||
| int | height, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Place an image within a larger image with a certain gravity.
Optional parameters
- extend – How to generate the extra pixels, VipsExtend.
- background – Color for background pixels, std::vector<double>.
- Parameters
-
direction Direction to place image within width/height. width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ grey()
Make a grey ramp image.
Optional parameters
- uchar – Output an unsigned char image, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ grid()
Grid an image.
- Parameters
-
tile_height Chop into tiles this high. across Number of tiles across. down Number of tiles down. options Set of options.
- Returns
- Output image.
◆ guess_interpretation()
|
inline |
Try to guess the image interpretation from other fields. This is handy if the interpretation has not been set correctly.
◆ has_alpha()
|
inline |
TRUE if the image has an alpha channel.
◆ heifload()
Load a heif image.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- thumbnail – Fetch thumbnail image, bool.
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ heifload_buffer()
Load a heif image.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- thumbnail – Fetch thumbnail image, bool.
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ heifload_source()
Load a heif image.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- thumbnail – Fetch thumbnail image, bool.
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ heifsave()
Save image in heif format.
Optional parameters
- Q – Q factor, int.
- bitdepth – Number of bits per pixel, int.
- lossless – Enable lossless compression, bool.
- compression – Compression format, VipsForeignHeifCompression.
- effort – CPU effort, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- encoder – Select encoder to use, VipsForeignHeifEncoder.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ heifsave_buffer()
Save image in heif format.
Optional parameters
- Q – Q factor, int.
- bitdepth – Number of bits per pixel, int.
- lossless – Enable lossless compression, bool.
- compression – Compression format, VipsForeignHeifCompression.
- effort – CPU effort, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- encoder – Select encoder to use, VipsForeignHeifEncoder.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ heifsave_target()
Save image in heif format.
Optional parameters
- Q – Q factor, int.
- bitdepth – Number of bits per pixel, int.
- lossless – Enable lossless compression, bool.
- compression – Compression format, VipsForeignHeifCompression.
- effort – CPU effort, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- encoder – Select encoder to use, VipsForeignHeifEncoder.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ height()
|
inline |
Return the height of the image in pixels.
◆ hist_cum()
Form cumulative histogram.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ hist_entropy()
Estimate image entropy.
- Parameters
-
options Set of options.
- Returns
- Output value.
◆ hist_equal()
Histogram equalisation.
Optional parameters
- band – Equalise with this band, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ hist_find()
Find image histogram.
Optional parameters
- band – Find histogram of band, int.
- Parameters
-
options Set of options.
- Returns
- Output histogram.
◆ hist_find_indexed()
Find indexed image histogram.
Optional parameters
- combine – Combine bins like this, VipsCombine.
- Parameters
-
index Index image. options Set of options.
- Returns
- Output histogram.
◆ hist_find_ndim()
Find n-dimensional image histogram.
Optional parameters
- bins – Number of bins in each dimension, int.
- Parameters
-
options Set of options.
- Returns
- Output histogram.
◆ hist_ismonotonic()
Test for monotonicity.
- Parameters
-
options Set of options.
- Returns
- true if in is monotonic.
◆ hist_local()
Local histogram equalisation.
Optional parameters
- max_slope – Maximum slope (CLAHE), int.
- Parameters
-
width Window width in pixels. height Window height in pixels. options Set of options.
- Returns
- Output image.
◆ hist_match()
Match two histograms.
- Parameters
-
ref Reference histogram. options Set of options.
- Returns
- Output image.
◆ hist_norm()
Normalise histogram.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ hist_plot()
Plot histogram.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ hough_circle()
Find hough circle transform.
Optional parameters
- scale – Scale down dimensions by this factor, int.
- min_radius – Smallest radius to search for, int.
- max_radius – Largest radius to search for, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ hough_line()
Find hough line transform.
Optional parameters
- width – Horizontal size of parameter space, int.
- height – Vertical size of parameter space, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ HSV2sRGB()
Transform hsv to srgb.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ icc_export()
Output to device with icc profile.
Optional parameters
- pcs – Set Profile Connection Space, VipsPCS.
- intent – Rendering intent, VipsIntent.
- black_point_compensation – Enable black point compensation, bool.
- output_profile – Filename to load output profile from, const char *.
- depth – Output device space depth in bits, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ icc_import()
Import from device with icc profile.
Optional parameters
- pcs – Set Profile Connection Space, VipsPCS.
- intent – Rendering intent, VipsIntent.
- black_point_compensation – Enable black point compensation, bool.
- embedded – Use embedded input profile, if available, bool.
- input_profile – Filename to load input profile from, const char *.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ icc_transform()
Transform between devices with icc profiles.
Optional parameters
- pcs – Set Profile Connection Space, VipsPCS.
- intent – Rendering intent, VipsIntent.
- black_point_compensation – Enable black point compensation, bool.
- embedded – Use embedded input profile, if available, bool.
- input_profile – Filename to load input profile from, const char *.
- depth – Output device space depth in bits, int.
- Parameters
-
output_profile Filename to load output profile from. options Set of options.
- Returns
- Output image.
◆ identity()
Make a 1d image where pixel values are indexes.
Optional parameters
- bands – Number of bands in LUT, int.
- ushort – Create a 16-bit LUT, bool.
- size – Size of 16-bit LUT, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ ifthenelse() [1/7]
Use self as a conditional image (not zero meaning TRUE) to pick pixels from th (then) or el (else).
◆ ifthenelse() [2/7]
Use self as a conditional image (not zero meaning TRUE) to pick pixels from th (then) or el (else).
◆ ifthenelse() [3/7]
|
inline |
Use self as a conditional image (not zero meaning TRUE) to pick pixels from th (then) or el (else).
◆ ifthenelse() [4/7]
|
inline |
Use self as a conditional image (not zero meaning TRUE) to pick pixels from th (then) or el (else).
◆ ifthenelse() [5/7]
Ifthenelse an image.
Optional parameters
- blend – Blend smoothly between then and else parts, bool.
- Parameters
-
in1 Source for TRUE pixels. in2 Source for FALSE pixels. options Set of options.
- Returns
- Output image.
◆ ifthenelse() [6/7]
Use self as a conditional image (not zero meaning TRUE) to pick pixels from th (then) or el (else).
◆ ifthenelse() [7/7]
|
inline |
Use self as a conditional image (not zero meaning TRUE) to pick pixels from th (then) or el (else).
◆ imag()
Return the imaginary part of a complex image.
◆ inplace()
|
inline |
Gets an VImage ready for an in-place operation, such as draw_circle(). After calling this function you can both read and write the image with VIPS_IMAGE_ADDR().
This method is called for you by the draw operations, there's no need to call it yourself.
Since this function modifies the image, it is not thread-safe. Only call it on images which you are sure have not been shared with another thread. All in-place operations are inherently not thread-safe, so you need to take great care in any case.
◆ insert()
Insert image @sub into @main at @x, @y.
Optional parameters
- expand – Expand output to hold all of both inputs, bool.
- background – Color for new pixels, std::vector<double>.
- Parameters
-
sub Sub-image to insert into main image. x Left edge of sub in main. y Top edge of sub in main. options Set of options.
- Returns
- Output image.
◆ interpretation()
|
inline |
Return the image interpretation, for example VIPS_INTERPRETATION_sRGB.
◆ invert()
Invert an image.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ invertlut()
Build an inverted look-up table.
Optional parameters
- size – LUT size to generate, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ invfft()
Inverse fft.
Optional parameters
- real – Output only the real part of the transform, bool.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ is_null()
◆ join()
| VImage VImage::join | ( | VImage | in2, |
| VipsDirection | direction, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Join a pair of images.
Optional parameters
- expand – Expand output to hold all of both inputs, bool.
- shim – Pixels between images, int.
- background – Colour for new pixels, std::vector<double>.
- align – Align on the low, centre or high coordinate edge, VipsAlign.
- Parameters
-
in2 Second input image. direction Join left-right or up-down. options Set of options.
- Returns
- Output image.
◆ jp2kload()
Load jpeg2000 image.
Optional parameters
- page – Load this page from the image, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ jp2kload_buffer()
Load jpeg2000 image.
Optional parameters
- page – Load this page from the image, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ jp2kload_source()
Load jpeg2000 image.
Optional parameters
- page – Load this page from the image, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ jp2ksave()
Save image in jpeg2000 format.
Optional parameters
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- lossless – Enable lossless compression, bool.
- Q – Q factor, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ jp2ksave_buffer()
Save image in jpeg2000 format.
Optional parameters
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- lossless – Enable lossless compression, bool.
- Q – Q factor, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ jp2ksave_target()
Save image in jpeg2000 format.
Optional parameters
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- lossless – Enable lossless compression, bool.
- Q – Q factor, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ jpegload()
Load jpeg from file.
Optional parameters
- shrink – Shrink factor on load, int.
- autorotate – Rotate image using exif orientation, bool.
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ jpegload_buffer()
Load jpeg from buffer.
Optional parameters
- shrink – Shrink factor on load, int.
- autorotate – Rotate image using exif orientation, bool.
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ jpegload_source()
Load image from jpeg source.
Optional parameters
- shrink – Shrink factor on load, int.
- autorotate – Rotate image using exif orientation, bool.
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ jpegsave()
Save image to jpeg file.
Optional parameters
- Q – Q factor, int.
- optimize_coding – Compute optimal Huffman coding tables, bool.
- interlace – Generate an interlaced (progressive) jpeg, bool.
- trellis_quant – Apply trellis quantisation to each 8x8 block, bool.
- overshoot_deringing – Apply overshooting to samples with extreme values, bool.
- optimize_scans – Split spectrum of DCT coefficients into separate scans, bool.
- quant_table – Use predefined quantization table with given index, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- restart_interval – Add restart markers every specified number of mcu, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ jpegsave_buffer()
Save image to jpeg buffer.
Optional parameters
- Q – Q factor, int.
- optimize_coding – Compute optimal Huffman coding tables, bool.
- interlace – Generate an interlaced (progressive) jpeg, bool.
- trellis_quant – Apply trellis quantisation to each 8x8 block, bool.
- overshoot_deringing – Apply overshooting to samples with extreme values, bool.
- optimize_scans – Split spectrum of DCT coefficients into separate scans, bool.
- quant_table – Use predefined quantization table with given index, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- restart_interval – Add restart markers every specified number of mcu, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ jpegsave_mime()
Save image to jpeg mime.
Optional parameters
- Q – Q factor, int.
- optimize_coding – Compute optimal Huffman coding tables, bool.
- interlace – Generate an interlaced (progressive) jpeg, bool.
- trellis_quant – Apply trellis quantisation to each 8x8 block, bool.
- overshoot_deringing – Apply overshooting to samples with extreme values, bool.
- optimize_scans – Split spectrum of DCT coefficients into separate scans, bool.
- quant_table – Use predefined quantization table with given index, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- restart_interval – Add restart markers every specified number of mcu, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
◆ jpegsave_target()
Save image to jpeg target.
Optional parameters
- Q – Q factor, int.
- optimize_coding – Compute optimal Huffman coding tables, bool.
- interlace – Generate an interlaced (progressive) jpeg, bool.
- trellis_quant – Apply trellis quantisation to each 8x8 block, bool.
- overshoot_deringing – Apply overshooting to samples with extreme values, bool.
- optimize_scans – Split spectrum of DCT coefficients into separate scans, bool.
- quant_table – Use predefined quantization table with given index, int.
- subsample_mode – Select chroma subsample operation mode, VipsForeignSubsample.
- restart_interval – Add restart markers every specified number of mcu, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ jxlload()
Load jpeg-xl image.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ jxlload_buffer()
Load jpeg-xl image.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ jxlload_source()
Load jpeg-xl image.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ jxlsave()
Save image in jpeg-xl format.
Optional parameters
- tier – Decode speed tier, int.
- distance – Target butteraugli distance, double.
- effort – Encoding effort, int.
- lossless – Enable lossless compression, bool.
- Q – Quality factor, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ jxlsave_buffer()
Save image in jpeg-xl format.
Optional parameters
- tier – Decode speed tier, int.
- distance – Target butteraugli distance, double.
- effort – Encoding effort, int.
- lossless – Enable lossless compression, bool.
- Q – Quality factor, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ jxlsave_target()
Save image in jpeg-xl format.
Optional parameters
- tier – Decode speed tier, int.
- distance – Target butteraugli distance, double.
- effort – Encoding effort, int.
- lossless – Enable lossless compression, bool.
- Q – Quality factor, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ Lab2LabQ()
Transform float lab to labq coding.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ Lab2LabS()
Transform float lab to signed short.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ Lab2LCh()
Transform lab to lch.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ Lab2XYZ()
Transform cielab to xyz.
Optional parameters
- temp – Color temperature, std::vector<double>.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ labelregions()
Label regions in an image.
- Parameters
-
options Set of options.
- Returns
- Mask of region labels.
◆ LabQ2Lab()
Unpack a labq image to float lab.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ LabQ2LabS()
Unpack a labq image to short lab.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ LabQ2sRGB()
Convert a labq image to srgb.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ LabS2Lab()
Transform signed short lab to float.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ LabS2LabQ()
Transform short lab to labq coding.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ LCh2CMC()
Transform lch to cmc.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ LCh2Lab()
Transform lch to lab.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ linear() [1/4]
Apply a linear transform to an image. For every pixel,
out = in * a + b
◆ linear() [2/4]
|
inline |
Apply a linear transform to an image. For every pixel,
out = in * a + b
◆ linear() [3/4]
|
inline |
Apply a linear transform to an image. For every pixel,
out = in * a + b
◆ linear() [4/4]
| VImage VImage::linear | ( | std::vector< double > | a, |
| std::vector< double > | b, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Calculate (a * in + b).
Optional parameters
- uchar – Output should be uchar, bool.
- Parameters
-
a Multiply by this. b Add this. options Set of options.
- Returns
- Output image.
◆ linecache()
Cache an image as a set of lines.
Optional parameters
- tile_height – Tile height in pixels, int.
- access – Expected access pattern, VipsAccess.
- threaded – Allow threaded access, bool.
- persistent – Keep cache between evaluations, bool.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ log()
◆ log10()
Find the base 10 log of each pixel.
◆ logmat()
Make a laplacian of gaussian image.
Optional parameters
- separable – Generate separable Gaussian, bool.
- precision – Generate with this precision, VipsPrecision.
- Parameters
-
sigma Radius of Gaussian. min_ampl Minimum amplitude of Gaussian. options Set of options.
- Returns
- Output image.
◆ magickload()
Load file with imagemagick.
Optional parameters
- density – Canvas resolution for rendering vector formats like SVG, const char *.
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ magickload_buffer()
Load buffer with imagemagick.
Optional parameters
- density – Canvas resolution for rendering vector formats like SVG, const char *.
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ magicksave()
Save file with imagemagick.
Optional parameters
- format – Format to save in, const char *.
- quality – Quality to use, int.
- optimize_gif_frames – Apply GIF frames optimization, bool.
- optimize_gif_transparency – Apply GIF transparency optimization, bool.
- bitdepth – Number of bits per pixel, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ magicksave_buffer()
Save image to magick buffer.
Optional parameters
- format – Format to save in, const char *.
- quality – Quality to use, int.
- optimize_gif_frames – Apply GIF frames optimization, bool.
- optimize_gif_transparency – Apply GIF transparency optimization, bool.
- bitdepth – Number of bits per pixel, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ mapim()
Resample with a map image.
Optional parameters
- interpolate – Interpolate pixels with this, VInterpolate.
- background – Background value, std::vector<double>.
- premultiplied – Images have premultiplied alpha, bool.
- extend – How to generate the extra pixels, VipsExtend.
- Parameters
-
index Index pixels with this. options Set of options.
- Returns
- Output image.
◆ maplut()
Map an image though a lut.
Optional parameters
- band – Apply one-band lut to this band of in, int.
- Parameters
-
lut Look-up table image. options Set of options.
- Returns
- Output image.
◆ mask_butterworth()
|
static |
Make a butterworth filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. order Filter order. frequency_cutoff Frequency cutoff. amplitude_cutoff Amplitude cutoff. options Set of options.
- Returns
- Output image.
◆ mask_butterworth_band()
|
static |
Make a butterworth_band filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. order Filter order. frequency_cutoff_x Frequency cutoff x. frequency_cutoff_y Frequency cutoff y. radius Radius of circle. amplitude_cutoff Amplitude cutoff. options Set of options.
- Returns
- Output image.
◆ mask_butterworth_ring()
|
static |
Make a butterworth ring filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. order Filter order. frequency_cutoff Frequency cutoff. amplitude_cutoff Amplitude cutoff. ringwidth Ringwidth. options Set of options.
- Returns
- Output image.
◆ mask_fractal()
|
static |
Make fractal filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. fractal_dimension Fractal dimension. options Set of options.
- Returns
- Output image.
◆ mask_gaussian()
|
static |
Make a gaussian filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. frequency_cutoff Frequency cutoff. amplitude_cutoff Amplitude cutoff. options Set of options.
- Returns
- Output image.
◆ mask_gaussian_band()
|
static |
Make a gaussian filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. frequency_cutoff_x Frequency cutoff x. frequency_cutoff_y Frequency cutoff y. radius Radius of circle. amplitude_cutoff Amplitude cutoff. options Set of options.
- Returns
- Output image.
◆ mask_gaussian_ring()
|
static |
Make a gaussian ring filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. frequency_cutoff Frequency cutoff. amplitude_cutoff Amplitude cutoff. ringwidth Ringwidth. options Set of options.
- Returns
- Output image.
◆ mask_ideal()
|
static |
Make an ideal filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. frequency_cutoff Frequency cutoff. options Set of options.
- Returns
- Output image.
◆ mask_ideal_band()
|
static |
Make an ideal band filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. frequency_cutoff_x Frequency cutoff x. frequency_cutoff_y Frequency cutoff y. radius Radius of circle. options Set of options.
- Returns
- Output image.
◆ mask_ideal_ring()
|
static |
Make an ideal ring filter.
Optional parameters
- uchar – Output an unsigned char image, bool.
- nodc – Remove DC component, bool.
- reject – Invert the sense of the filter, bool.
- optical – Rotate quadrants to optical space, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. frequency_cutoff Frequency cutoff. ringwidth Ringwidth. options Set of options.
- Returns
- Output image.
◆ match()
| VImage VImage::match | ( | VImage | sec, |
| int | xr1, | ||
| int | yr1, | ||
| int | xs1, | ||
| int | ys1, | ||
| int | xr2, | ||
| int | yr2, | ||
| int | xs2, | ||
| int | ys2, | ||
| VOption * |
options = nullptr |
||
| ) | const |
First-order match of two images.
Optional parameters
- hwindow – Half window size, int.
- harea – Half area size, int.
- search – Search to improve tie-points, bool.
- interpolate – Interpolate pixels with this, VInterpolate.
- Parameters
-
sec Secondary image. xr1 Position of first reference tie-point. yr1 Position of first reference tie-point. xs1 Position of first secondary tie-point. ys1 Position of first secondary tie-point. xr2 Position of second reference tie-point. yr2 Position of second reference tie-point. xs2 Position of second secondary tie-point. ys2 Position of second secondary tie-point. options Set of options.
- Returns
- Output image.
◆ math()
| VImage VImage::math | ( | VipsOperationMath | math, |
| VOption * |
options = nullptr |
||
| ) | const |
Apply a math operation to an image.
- Parameters
-
math Math to perform. options Set of options.
- Returns
- Output image.
◆ math2()
| VImage VImage::math2 | ( | VImage | right, |
| VipsOperationMath2 | math2, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Binary math operations.
- Parameters
-
right Right-hand image argument. math2 Math to perform. options Set of options.
- Returns
- Output image.
◆ math2_const()
| VImage VImage::math2_const | ( | VipsOperationMath2 | math2, |
| std::vector< double > | c, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Binary math operations with a constant.
- Parameters
-
math2 Math to perform. c Array of constants. options Set of options.
- Returns
- Output image.
◆ matload()
Load mat from file.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ matrixinvert()
Invert an matrix.
- Parameters
-
options Set of options.
- Returns
- Output matrix.
◆ matrixload()
Load matrix.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ matrixload_source()
Load matrix.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ matrixprint()
Print matrix.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
◆ matrixsave()
Save image to matrix.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ matrixsave_target()
Save image to matrix.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ max()
Find image maximum.
Optional parameters
- size – Number of maximum values to find, int.
- Parameters
-
options Set of options.
- Returns
- Output value.
◆ maxpair()
Maximum of a pair of images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ maxpos()
Find the position of the image maximum as (x, y).
◆ measure()
Measure a set of patches on a color chart.
Optional parameters
- left – Left edge of extract area, int.
- top – Top edge of extract area, int.
- width – Width of extract area, int.
- height – Height of extract area, int.
- Parameters
-
h Number of patches across chart. v Number of patches down chart. options Set of options.
- Returns
- Output array of statistics.
◆ median()
A median filter of the specified size. See VImage::rank().
◆ merge()
| VImage VImage::merge | ( | VImage | sec, |
| VipsDirection | direction, | ||
| int | dx, | ||
| int | dy, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Merge two images.
Optional parameters
- mblend – Maximum blend size, int.
- Parameters
-
sec Secondary image. direction Horizontal or vertical merge. dx Horizontal displacement from sec to ref. dy Vertical displacement from sec to ref. options Set of options.
- Returns
- Output image.
◆ min()
Find image minimum.
Optional parameters
- size – Number of minimum values to find, int.
- Parameters
-
options Set of options.
- Returns
- Output value.
◆ minpair()
Minimum of a pair of images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ minpos()
Find the position of the image minimum as (x, y).
◆ morph()
| VImage VImage::morph | ( | VImage | mask, |
| VipsOperationMorphology | morph, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Morphology operation.
- Parameters
-
mask Input matrix image. morph Morphological operation to perform. options Set of options.
- Returns
- Output image.
◆ mosaic()
| VImage VImage::mosaic | ( | VImage | sec, |
| VipsDirection | direction, | ||
| int | xref, | ||
| int | yref, | ||
| int | xsec, | ||
| int | ysec, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Mosaic two images.
Optional parameters
- hwindow – Half window size, int.
- harea – Half area size, int.
- mblend – Maximum blend size, int.
- bandno – Band to search for features on, int.
- Parameters
-
sec Secondary image. direction Horizontal or vertical mosaic. xref Position of reference tie-point. yref Position of reference tie-point. xsec Position of secondary tie-point. ysec Position of secondary tie-point. options Set of options.
- Returns
- Output image.
◆ mosaic1()
| VImage VImage::mosaic1 | ( | VImage | sec, |
| VipsDirection | direction, | ||
| int | xr1, | ||
| int | yr1, | ||
| int | xs1, | ||
| int | ys1, | ||
| int | xr2, | ||
| int | yr2, | ||
| int | xs2, | ||
| int | ys2, | ||
| VOption * |
options = nullptr |
||
| ) | const |
First-order mosaic of two images.
Optional parameters
- hwindow – Half window size, int.
- harea – Half area size, int.
- search – Search to improve tie-points, bool.
- interpolate – Interpolate pixels with this, VInterpolate.
- mblend – Maximum blend size, int.
- Parameters
-
sec Secondary image. direction Horizontal or vertical mosaic. xr1 Position of first reference tie-point. yr1 Position of first reference tie-point. xs1 Position of first secondary tie-point. ys1 Position of first secondary tie-point. xr2 Position of second reference tie-point. yr2 Position of second reference tie-point. xs2 Position of second secondary tie-point. ys2 Position of second secondary tie-point. options Set of options.
- Returns
- Output image.
◆ msb()
Pick most-significant byte from an image.
Optional parameters
- band – Band to msb, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ multiply()
Multiply two images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ new_from_buffer() [1/2]
|
static |
Create a new VImage object from an area of memory containing an image encoded in some format such as JPEG.
The available options depends on the image format. See for example VImage::jpegload().
◆ new_from_buffer() [2/2]
|
static |
Create a new VImage object from an area of memory containing an image encoded in some format such as JPEG.
The available options depends on the image format. See for example VImage::jpegload().
◆ new_from_file()
Create a new VImage object from a file on disc.
The available options depends on the image format. See for example VImage::jpegload().
◆ new_from_image() [1/2]
Make a new image of the same size and type as self, but with each pixel initialized with the constant.
◆ new_from_image() [2/2]
Make a new image of the same size and type as self, but with each pixel initialized with the constant.
◆ new_from_memory()
|
inlinestatic |
Create a new VImage object from an area of memory containing a C-style array.
◆ new_from_memory_copy()
◆ new_from_memory_steal()
◆ new_from_source()
|
static |
Create a new VImage object from a generic source object.
The available options depends on the image format. See for example VImage::jpegload().
◆ new_matrix() [1/2]
Create a matrix image of a specified size. All elements will be zero.
◆ new_matrix() [2/2]
Create a matrix image of a specified size, initialized from the array.
◆ new_matrixv()
Create a matrix image of a specified size, initialized from the function parameters.
◆ new_memory()
Make a new image which, when written to, will create a large memory object. See VImage::write().
◆ new_temp_file()
Make a new VImage which, when written to, will create a temporary file on disc. See VImage::write().
◆ niftiload()
Load nifti volume.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ niftiload_source()
Load nifti volumes.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ niftisave()
Save image to nifti file.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ openexrload()
Load an openexr image.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ openslideload()
Load file with openslide.
Optional parameters
- level – Load this level from the file, int.
- autocrop – Crop to image bounds, bool.
- associated – Load this associated image, const char *.
- attach_associated – Attach all associated images, bool.
- rgb – Output RGB (not RGBA), bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ openslideload_source()
Load source with openslide.
Optional parameters
- level – Load this level from the file, int.
- autocrop – Crop to image bounds, bool.
- associated – Load this associated image, const char *.
- attach_associated – Attach all associated images, bool.
- rgb – Output RGB (not RGBA), bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ option()
◆ pdfload()
Load pdf from file.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- dpi – DPI to render at, double.
- scale – Factor to scale by, double.
- background – Background colour, std::vector<double>.
- password – Password to decrypt with, const char *.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ pdfload_buffer()
Load pdf from buffer.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- dpi – DPI to render at, double.
- scale – Factor to scale by, double.
- background – Background colour, std::vector<double>.
- password – Password to decrypt with, const char *.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ pdfload_source()
Load pdf from source.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- dpi – DPI to render at, double.
- scale – Factor to scale by, double.
- background – Background colour, std::vector<double>.
- password – Password to decrypt with, const char *.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ percent()
Find threshold for percent of pixels.
- Parameters
-
percent Percent of pixels. options Set of options.
- Returns
- Threshold above which lie percent of pixels.
◆ perlin()
Make a perlin noise image.
Optional parameters
- cell_size – Size of Perlin cells, int.
- uchar – Output an unsigned char image, bool.
- seed – Random number seed, int.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ phasecor()
Calculate phase correlation.
- Parameters
-
in2 Second input image. options Set of options.
- Returns
- Output image.
◆ pngload()
Load png from file.
Optional parameters
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ pngload_buffer()
Load png from buffer.
Optional parameters
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ pngload_source()
Load png from source.
Optional parameters
- unlimited – Remove all denial of service limits, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ pngsave()
Save image to file as png.
Optional parameters
- compression – Compression factor, int.
- interlace – Interlace image, bool.
- filter – libspng row filter flag(s), VipsForeignPngFilter.
- palette – Quantise to 8bpp palette, bool.
- Q – Quantisation quality, int.
- dither – Amount of dithering, double.
- bitdepth – Write as a 1, 2, 4, 8 or 16 bit image, int.
- effort – Quantisation CPU effort, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ pngsave_buffer()
Save image to buffer as png.
Optional parameters
- compression – Compression factor, int.
- interlace – Interlace image, bool.
- filter – libspng row filter flag(s), VipsForeignPngFilter.
- palette – Quantise to 8bpp palette, bool.
- Q – Quantisation quality, int.
- dither – Amount of dithering, double.
- bitdepth – Write as a 1, 2, 4, 8 or 16 bit image, int.
- effort – Quantisation CPU effort, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ pngsave_target()
Save image to target as png.
Optional parameters
- compression – Compression factor, int.
- interlace – Interlace image, bool.
- filter – libspng row filter flag(s), VipsForeignPngFilter.
- palette – Quantise to 8bpp palette, bool.
- Q – Quantisation quality, int.
- dither – Amount of dithering, double.
- bitdepth – Write as a 1, 2, 4, 8 or 16 bit image, int.
- effort – Quantisation CPU effort, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ polar()
Convert a complex image to polar coordinates.
◆ pow() [1/3]
Raise each pixel to the specified power.
◆ pow() [2/3]
Raise each pixel to the specified power.
◆ pow() [3/3]
Raise each pixel to the specified power.
◆ ppmload()
Load ppm from file.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ ppmload_source()
Load ppm base class.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ ppmsave()
Save image to ppm file.
Optional parameters
- format – Format to save in, VipsForeignPpmFormat.
- ascii – Save as ascii, bool.
- bitdepth – Set to 1 to write as a 1 bit image, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ ppmsave_target()
Save to ppm.
Optional parameters
- format – Format to save in, VipsForeignPpmFormat.
- ascii – Save as ascii, bool.
- bitdepth – Set to 1 to write as a 1 bit image, int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ premultiply()
Premultiply image alpha.
Optional parameters
- max_alpha – Maximum value of alpha channel, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ prewitt()
Prewitt edge detector.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ profile()
Find image profiles.
- Parameters
-
rows First non-zero pixel in row. options Set of options.
- Returns
- First non-zero pixel in column.
◆ profile_load()
Load named icc profile.
- Parameters
-
name Profile name. options Set of options.
- Returns
- Loaded profile.
◆ project()
Find image projections.
- Parameters
-
rows Sums of rows. options Set of options.
- Returns
- Sums of columns.
◆ quadratic()
Resample an image with a quadratic transform.
Optional parameters
- interpolate – Interpolate values with this, VInterpolate.
- Parameters
-
coeff Coefficient matrix. options Set of options.
- Returns
- Output image.
◆ rad2float()
Unpack radiance coding to float rgb.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ radload()
Load a radiance image from a file.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ radload_buffer()
Load rad from buffer.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ radload_source()
Load rad from source.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ radsave()
Save image to radiance file.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ radsave_buffer()
Save image to radiance buffer.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ radsave_target()
Save image to radiance target.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ rank()
Rank filter.
- Parameters
-
width Window width in pixels. height Window height in pixels. index Select pixel at index. options Set of options.
- Returns
- Output image.
◆ rawload()
|
static |
Load raw data from a file.
Optional parameters
- offset – Offset in bytes from start of file, guint64.
- format – Pixel format in image, VipsBandFormat.
- interpretation – Pixel interpretation, VipsInterpretation.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. width Image width in pixels. height Image height in pixels. bands Number of bands in image. options Set of options.
- Returns
- Output image.
◆ rawsave()
Save image to raw file.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ rawsave_buffer()
Write raw image to buffer.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ rawsave_fd()
Write raw image to file descriptor.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
fd File descriptor to write to. options Set of options.
◆ rawsave_target()
Write raw image to target.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ real()
Return the real part of a complex image.
◆ recomb()
Linear recombination with matrix.
- Parameters
-
m Matrix of coefficients. options Set of options.
- Returns
- Output image.
◆ rect()
Convert a complex image to rectangular coordinates.
◆ reduce()
Reduce an image.
Optional parameters
- kernel – Resampling kernel, VipsKernel.
- gap – Reducing gap, double.
- Parameters
-
hshrink Horizontal shrink factor. vshrink Vertical shrink factor. options Set of options.
- Returns
- Output image.
◆ reduceh()
Shrink an image horizontally.
Optional parameters
- kernel – Resampling kernel, VipsKernel.
- gap – Reducing gap, double.
- Parameters
-
hshrink Horizontal shrink factor. options Set of options.
- Returns
- Output image.
◆ reducev()
Shrink an image vertically.
Optional parameters
- kernel – Resampling kernel, VipsKernel.
- gap – Reducing gap, double.
- Parameters
-
vshrink Vertical shrink factor. options Set of options.
- Returns
- Output image.
◆ region() [1/3]
◆ region() [2/3]
Acquire VRegion covering the given coordinates.
◆ region() [3/3]
◆ relational()
| VImage VImage::relational | ( | VImage | right, |
| VipsOperationRelational | relational, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Relational operation on two images.
- Parameters
-
right Right-hand image argument. relational Relational to perform. options Set of options.
- Returns
- Output image.
◆ relational_const()
| VImage VImage::relational_const | ( | VipsOperationRelational | relational, |
| std::vector< double > | c, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Relational operations against a constant.
- Parameters
-
relational Relational to perform. c Array of constants. options Set of options.
- Returns
- Output image.
◆ remainder()
Remainder after integer division of two images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ remainder_const()
Remainder after integer division of an image and a constant.
- Parameters
-
c Array of constants. options Set of options.
- Returns
- Output image.
◆ remove()
Remove a metadata item. This does nothing if the item does not exist.
◆ replicate()
Replicate an image.
- Parameters
-
across Repeat this many times horizontally. down Repeat this many times vertically. options Set of options.
- Returns
- Output image.
◆ resize()
Resize an image.
Optional parameters
- kernel – Resampling kernel, VipsKernel.
- gap – Reducing gap, double.
- vscale – Vertical scale image by this factor, double.
- Parameters
-
scale Scale image by this factor. options Set of options.
- Returns
- Output image.
◆ rint()
Convert to integer, rounding to nearest.
◆ rot()
Rotate an image.
- Parameters
-
angle Angle to rotate image. options Set of options.
- Returns
- Output image.
◆ rot180()
◆ rot270()
Rotate the image by 270 degrees clockwise.
◆ rot45()
Rotate an image.
Optional parameters
- angle – Angle to rotate image, VipsAngle45.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ rot90()
Rotate the image by 90 degrees clockwise.
◆ rotate()
Rotate an image by a number of degrees.
Optional parameters
- interpolate – Interpolate pixels with this, VInterpolate.
- background – Background value, std::vector<double>.
- odx – Horizontal output displacement, double.
- ody – Vertical output displacement, double.
- idx – Horizontal input displacement, double.
- idy – Vertical input displacement, double.
- Parameters
-
angle Rotate clockwise by this many degrees. options Set of options.
- Returns
- Output image.
◆ round()
| VImage VImage::round | ( | VipsOperationRound | round, |
| VOption * |
options = nullptr |
||
| ) | const |
Perform a round function on an image.
- Parameters
-
round Rounding operation to perform. options Set of options.
- Returns
- Output image.
◆ scale()
Scale an image to uchar.
Optional parameters
- exp – Exponent for log scale, double.
- log – Log scale, bool.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ scharr()
Scharr edge detector.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ scRGB2BW()
Convert scrgb to bw.
Optional parameters
- depth – Output device space depth in bits, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ scRGB2sRGB()
Convert an scrgb image to srgb.
Optional parameters
- depth – Output device space depth in bits, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ scRGB2XYZ()
Transform scrgb to xyz.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ sdf()
|
static |
Create an sdf image.
Optional parameters
- r – Radius, double.
- a – Point a, std::vector<double>.
- b – Point b, std::vector<double>.
- corners – Corner radii, std::vector<double>.
- Parameters
-
width Image width in pixels. height Image height in pixels. shape SDF shape to create. options Set of options.
- Returns
- Output image.
◆ sequential()
Check sequential access.
Optional parameters
- tile_height – Tile height in pixels, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ set() [1/8]
Set the value of a string metadata item on an image.
A copy of the string is taken.
◆ set() [2/8]
Set the value of an double array metadata item on an image.
A copy of the array is taken.
◆ set() [3/8]
Set the value of a double metadata item on an image.
◆ set() [4/8]
Set the value of an int array metadata item on an image.
A copy of the array is taken.
◆ set() [5/8]
Set the value of an int metadata item on an image.
◆ set() [6/8]
Set the value of an double array metadata item on an image.
A copy of the array is taken.
◆ set() [7/8]
Set the value of an int array metadata item on an image.
A copy of the array is taken.
◆ set() [8/8]
Set the value of a binary object metadata item on an image, such as an ICC profile.
When libvips no longer needs the value, it will be disposed with the free function. This can be NULL.
◆ sharpen()
Unsharp masking for print.
Optional parameters
- sigma – Sigma of Gaussian, double.
- x1 – Flat/jaggy threshold, double.
- y2 – Maximum brightening, double.
- y3 – Maximum darkening, double.
- m1 – Slope for flat areas, double.
- m2 – Slope for jaggy areas, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ shrink()
Shrink an image.
Optional parameters
- ceil – Round-up output dimensions, bool.
- Parameters
-
hshrink Horizontal shrink factor. vshrink Vertical shrink factor. options Set of options.
- Returns
- Output image.
◆ shrinkh()
Shrink an image horizontally.
Optional parameters
- ceil – Round-up output dimensions, bool.
- Parameters
-
hshrink Horizontal shrink factor. options Set of options.
- Returns
- Output image.
◆ shrinkv()
Shrink an image vertically.
Optional parameters
- ceil – Round-up output dimensions, bool.
- Parameters
-
vshrink Vertical shrink factor. options Set of options.
- Returns
- Output image.
◆ sign()
Unit vector of pixel.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ similarity()
Similarity transform of an image.
Optional parameters
- scale – Scale by this factor, double.
- angle – Rotate clockwise by this many degrees, double.
- interpolate – Interpolate pixels with this, VInterpolate.
- background – Background value, std::vector<double>.
- odx – Horizontal output displacement, double.
- ody – Vertical output displacement, double.
- idx – Horizontal input displacement, double.
- idy – Vertical input displacement, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ sin()
Find the sine of each pixel. Angles are in degrees.
◆ sines()
Make a 2d sine wave.
Optional parameters
- uchar – Output an unsigned char image, bool.
- hfreq – Horizontal spatial frequency, double.
- vfreq – Vertical spatial frequency, double.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ sinh()
Find the hyperbolic sine of each pixel. Angles are in degrees.
◆ smartcrop()
Extract an area from an image.
Optional parameters
- interesting – How to measure interestingness, VipsInteresting.
- premultiplied – Input image already has premultiplied alpha, bool.
- Parameters
-
width Width of extract area. height Height of extract area. options Set of options.
- Returns
- Output image.
◆ sobel()
Sobel edge detector.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ spcor()
Spatial correlation.
- Parameters
-
ref Input reference image. options Set of options.
- Returns
- Output image.
◆ spectrum()
Make displayable power spectrum.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ sRGB2HSV()
Transform srgb to hsv.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ sRGB2scRGB()
Convert an srgb image to scrgb.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ stats()
Find many image stats.
- Parameters
-
options Set of options.
- Returns
- Output array of statistics.
◆ stdif()
Statistical difference.
Optional parameters
- s0 – New deviation, double.
- b – Weight of new deviation, double.
- m0 – New mean, double.
- a – Weight of new mean, double.
- Parameters
-
width Window width in pixels. height Window height in pixels. options Set of options.
- Returns
- Output image.
◆ subsample()
Subsample an image.
Optional parameters
- point – Point sample, bool.
- Parameters
-
xfac Horizontal subsample factor. yfac Vertical subsample factor. options Set of options.
- Returns
- Output image.
◆ subtract()
Subtract two images.
- Parameters
-
right Right-hand image argument. options Set of options.
- Returns
- Output image.
◆ sum()
Sum an array of images.
- Parameters
-
in Array of input images. options Set of options.
- Returns
- Output image.
◆ svgload()
Load svg with rsvg.
Optional parameters
- dpi – Render at this DPI, double.
- scale – Scale output by this factor, double.
- unlimited – Allow SVG of any size, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ svgload_buffer()
Load svg with rsvg.
Optional parameters
- dpi – Render at this DPI, double.
- scale – Scale output by this factor, double.
- unlimited – Allow SVG of any size, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ svgload_source()
Load svg from source.
Optional parameters
- dpi – Render at this DPI, double.
- scale – Scale output by this factor, double.
- unlimited – Allow SVG of any size, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ switch_image()
Find the index of the first non-zero pixel in tests.
- Parameters
-
tests Table of images to test. options Set of options.
- Returns
- Output image.
◆ system()
Run an external command.
Optional parameters
- in – Array of input images, std::vector<VImage>.
- out_format – Format for output filename, const char *.
- in_format – Format for input filename, const char *.
- Parameters
-
cmd_format Command to run. options Set of options.
◆ tan()
Find the tangent of each pixel. Angles are in degrees.
◆ tanh()
Find the hyperbolic tangent of each pixel. Angles are in degrees.
◆ text()
Make a text image.
Optional parameters
- font – Font to render with, const char *.
- width – Maximum image width in pixels, int.
- height – Maximum image height in pixels, int.
- align – Align on the low, centre or high edge, VipsAlign.
- justify – Justify lines, bool.
- dpi – DPI to render at, int.
- spacing – Line spacing, int.
- fontfile – Load this font file, const char *.
- rgba – Enable RGBA output, bool.
- wrap – Wrap lines on word or character boundaries, VipsTextWrap.
- Parameters
-
text Text to render. options Set of options.
- Returns
- Output image.
◆ thumbnail()
Generate thumbnail from file.
Optional parameters
- height – Size to this height, int.
- size – Only upsize, only downsize, or both, VipsSize.
- no_rotate – Don't use orientation tags to rotate image upright, bool.
- crop – Reduce to fill target rectangle, then crop, VipsInteresting.
- linear – Reduce in linear light, bool.
- import_profile – Fallback import profile, const char *.
- export_profile – Fallback export profile, const char *.
- intent – Rendering intent, VipsIntent.
- fail_on – Error level to fail on, VipsFailOn.
- Parameters
-
filename Filename to read from. width Size to this width. options Set of options.
- Returns
- Output image.
◆ thumbnail_buffer() [1/2]
|
static |
Generate thumbnail from buffer.
Optional parameters
- option_string – Options that are passed on to the underlying loader, const char *.
- height – Size to this height, int.
- size – Only upsize, only downsize, or both, VipsSize.
- no_rotate – Don't use orientation tags to rotate image upright, bool.
- crop – Reduce to fill target rectangle, then crop, VipsInteresting.
- linear – Reduce in linear light, bool.
- import_profile – Fallback import profile, const char *.
- export_profile – Fallback export profile, const char *.
- intent – Rendering intent, VipsIntent.
- fail_on – Error level to fail on, VipsFailOn.
- Parameters
-
buffer Buffer to load from. width Size to this width. options Set of options.
- Returns
- Output image.
◆ thumbnail_buffer() [2/2]
|
static |
Generate thumbnail from buffer.
Optional parameters
- option_string – Options that are passed on to the underlying loader, const char *.
- height – Size to this height, int.
- size – Only upsize, only downsize, or both, VipsSize.
- no_rotate – Don't use orientation tags to rotate image upright, bool.
- crop – Reduce to fill target rectangle, then crop, VipsInteresting.
- linear – Reduce in linear light, bool.
- import_profile – Fallback import profile, const char *.
- export_profile – Fallback export profile, const char *.
- intent – Rendering intent, VipsIntent.
- fail_on – Error level to fail on, VipsFailOn.
- Parameters
-
buf Buffer to load from. len Size of buffer. width Size to this width. options Set of options.
- Returns
- Output image.
◆ thumbnail_image()
Generate thumbnail from image.
Optional parameters
- height – Size to this height, int.
- size – Only upsize, only downsize, or both, VipsSize.
- no_rotate – Don't use orientation tags to rotate image upright, bool.
- crop – Reduce to fill target rectangle, then crop, VipsInteresting.
- linear – Reduce in linear light, bool.
- import_profile – Fallback import profile, const char *.
- export_profile – Fallback export profile, const char *.
- intent – Rendering intent, VipsIntent.
- fail_on – Error level to fail on, VipsFailOn.
- Parameters
-
width Size to this width. options Set of options.
- Returns
- Output image.
◆ thumbnail_source()
Generate thumbnail from source.
Optional parameters
- option_string – Options that are passed on to the underlying loader, const char *.
- height – Size to this height, int.
- size – Only upsize, only downsize, or both, VipsSize.
- no_rotate – Don't use orientation tags to rotate image upright, bool.
- crop – Reduce to fill target rectangle, then crop, VipsInteresting.
- linear – Reduce in linear light, bool.
- import_profile – Fallback import profile, const char *.
- export_profile – Fallback export profile, const char *.
- intent – Rendering intent, VipsIntent.
- fail_on – Error level to fail on, VipsFailOn.
- Parameters
-
source Source to load from. width Size to this width. options Set of options.
- Returns
- Output image.
◆ tiffload()
Load tiff from file.
Optional parameters
- page – First page to load, int.
- subifd – Subifd index, int.
- n – Number of pages to load, -1 for all, int.
- autorotate – Rotate image using orientation tag, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ tiffload_buffer()
Load tiff from buffer.
Optional parameters
- page – First page to load, int.
- subifd – Subifd index, int.
- n – Number of pages to load, -1 for all, int.
- autorotate – Rotate image using orientation tag, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ tiffload_source()
Load tiff from source.
Optional parameters
- page – First page to load, int.
- subifd – Subifd index, int.
- n – Number of pages to load, -1 for all, int.
- autorotate – Rotate image using orientation tag, bool.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ tiffsave()
Save image to tiff file.
Optional parameters
- compression – Compression for this file, VipsForeignTiffCompression.
- Q – Q factor, int.
- predictor – Compression prediction, VipsForeignTiffPredictor.
- tile – Write a tiled tiff, bool.
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- pyramid – Write a pyramidal tiff, bool.
- miniswhite – Use 0 for white in 1-bit images, bool.
- bitdepth – Write as a 1, 2, 4 or 8 bit image, int.
- resunit – Resolution unit, VipsForeignTiffResunit.
- xres – Horizontal resolution in pixels/mm, double.
- yres – Vertical resolution in pixels/mm, double.
- bigtiff – Write a bigtiff image, bool.
- properties – Write a properties document to IMAGEDESCRIPTION, bool.
- region_shrink – Method to shrink regions, VipsRegionShrink.
- level – Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level, int.
- lossless – Enable WEBP lossless mode, bool.
- depth – Pyramid depth, VipsForeignDzDepth.
- subifd – Save pyr layers as sub-IFDs, bool.
- premultiply – Save with premultiplied alpha, bool.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ tiffsave_buffer()
Save image to tiff buffer.
Optional parameters
- compression – Compression for this file, VipsForeignTiffCompression.
- Q – Q factor, int.
- predictor – Compression prediction, VipsForeignTiffPredictor.
- tile – Write a tiled tiff, bool.
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- pyramid – Write a pyramidal tiff, bool.
- miniswhite – Use 0 for white in 1-bit images, bool.
- bitdepth – Write as a 1, 2, 4 or 8 bit image, int.
- resunit – Resolution unit, VipsForeignTiffResunit.
- xres – Horizontal resolution in pixels/mm, double.
- yres – Vertical resolution in pixels/mm, double.
- bigtiff – Write a bigtiff image, bool.
- properties – Write a properties document to IMAGEDESCRIPTION, bool.
- region_shrink – Method to shrink regions, VipsRegionShrink.
- level – Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level, int.
- lossless – Enable WEBP lossless mode, bool.
- depth – Pyramid depth, VipsForeignDzDepth.
- subifd – Save pyr layers as sub-IFDs, bool.
- premultiply – Save with premultiplied alpha, bool.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ tiffsave_target()
Save image to tiff target.
Optional parameters
- compression – Compression for this file, VipsForeignTiffCompression.
- Q – Q factor, int.
- predictor – Compression prediction, VipsForeignTiffPredictor.
- tile – Write a tiled tiff, bool.
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- pyramid – Write a pyramidal tiff, bool.
- miniswhite – Use 0 for white in 1-bit images, bool.
- bitdepth – Write as a 1, 2, 4 or 8 bit image, int.
- resunit – Resolution unit, VipsForeignTiffResunit.
- xres – Horizontal resolution in pixels/mm, double.
- yres – Vertical resolution in pixels/mm, double.
- bigtiff – Write a bigtiff image, bool.
- properties – Write a properties document to IMAGEDESCRIPTION, bool.
- region_shrink – Method to shrink regions, VipsRegionShrink.
- level – Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level, int.
- lossless – Enable WEBP lossless mode, bool.
- depth – Pyramid depth, VipsForeignDzDepth.
- subifd – Save pyr layers as sub-IFDs, bool.
- premultiply – Save with premultiplied alpha, bool.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ tilecache()
Cache an image as a set of tiles.
Optional parameters
- tile_width – Tile width in pixels, int.
- tile_height – Tile height in pixels, int.
- max_tiles – Maximum number of tiles to cache, int.
- access – Expected access pattern, VipsAccess.
- threaded – Allow threaded access, bool.
- persistent – Keep cache between evaluations, bool.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ tonelut()
Build a look-up table.
Optional parameters
- in_max – Size of LUT to build, int.
- out_max – Maximum value in output LUT, int.
- Lb – Lowest value in output, double.
- Lw – Highest value in output, double.
- Ps – Position of shadow, double.
- Pm – Position of mid-tones, double.
- Ph – Position of highlights, double.
- S – Adjust shadows by this much, double.
- M – Adjust mid-tones by this much, double.
- H – Adjust highlights by this much, double.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ transpose3d()
Transpose3d an image.
Optional parameters
- page_height – Height of each input page, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ unpremultiply()
Unpremultiply image alpha.
Optional parameters
- max_alpha – Maximum value of alpha channel, double.
- alpha_band – Unpremultiply with this alpha, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ vipsload()
Load vips from file.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ vipsload_source()
Load vips from source.
Optional parameters
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ vipssave()
Save image to file in vips format.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ vipssave_target()
Save image to target in vips format.
Optional parameters
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ webpload()
Load webp from file.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- scale – Factor to scale by, double.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
filename Filename to load from. options Set of options.
- Returns
- Output image.
◆ webpload_buffer()
Load webp from buffer.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- scale – Factor to scale by, double.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
buffer Buffer to load from. options Set of options.
- Returns
- Output image.
◆ webpload_source()
Load webp from source.
Optional parameters
- page – First page to load, int.
- n – Number of pages to load, -1 for all, int.
- scale – Factor to scale by, double.
- memory – Force open via memory, bool.
- access – Required access pattern for this file, VipsAccess.
- fail_on – Error level to fail on, VipsFailOn.
- revalidate – Don't use a cached result for this operation, bool.
- Parameters
-
source Source to load from. options Set of options.
- Returns
- Output image.
◆ webpsave()
Save as webp.
Optional parameters
- Q – Q factor, int.
- lossless – Enable lossless compression, bool.
- preset – Preset for lossy compression, VipsForeignWebpPreset.
- smart_subsample – Enable high quality chroma subsampling, bool.
- near_lossless – Enable preprocessing in lossless mode (uses Q), bool.
- alpha_q – Change alpha plane fidelity for lossy compression, int.
- min_size – Optimise for minimum size, bool.
- kmin – Minimum number of frames between key frames, int.
- kmax – Maximum number of frames between key frames, int.
- effort – Level of CPU effort to reduce file size, int.
- target_size – Desired target size in bytes, int.
- mixed – Allow mixed encoding (might reduce file size), bool.
- smart_deblock – Enable auto-adjusting of the deblocking filter, bool.
- passes – Number of entropy-analysis passes (in [1..10]), int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
filename Filename to save to. options Set of options.
◆ webpsave_buffer()
Save as webp.
Optional parameters
- Q – Q factor, int.
- lossless – Enable lossless compression, bool.
- preset – Preset for lossy compression, VipsForeignWebpPreset.
- smart_subsample – Enable high quality chroma subsampling, bool.
- near_lossless – Enable preprocessing in lossless mode (uses Q), bool.
- alpha_q – Change alpha plane fidelity for lossy compression, int.
- min_size – Optimise for minimum size, bool.
- kmin – Minimum number of frames between key frames, int.
- kmax – Maximum number of frames between key frames, int.
- effort – Level of CPU effort to reduce file size, int.
- target_size – Desired target size in bytes, int.
- mixed – Allow mixed encoding (might reduce file size), bool.
- smart_deblock – Enable auto-adjusting of the deblocking filter, bool.
- passes – Number of entropy-analysis passes (in [1..10]), int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
- Returns
- Buffer to save to.
◆ webpsave_mime()
Save image to webp mime.
Optional parameters
- Q – Q factor, int.
- lossless – Enable lossless compression, bool.
- preset – Preset for lossy compression, VipsForeignWebpPreset.
- smart_subsample – Enable high quality chroma subsampling, bool.
- near_lossless – Enable preprocessing in lossless mode (uses Q), bool.
- alpha_q – Change alpha plane fidelity for lossy compression, int.
- min_size – Optimise for minimum size, bool.
- kmin – Minimum number of frames between key frames, int.
- kmax – Maximum number of frames between key frames, int.
- effort – Level of CPU effort to reduce file size, int.
- target_size – Desired target size in bytes, int.
- mixed – Allow mixed encoding (might reduce file size), bool.
- smart_deblock – Enable auto-adjusting of the deblocking filter, bool.
- passes – Number of entropy-analysis passes (in [1..10]), int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
options Set of options.
◆ webpsave_target()
Save as webp.
Optional parameters
- Q – Q factor, int.
- lossless – Enable lossless compression, bool.
- preset – Preset for lossy compression, VipsForeignWebpPreset.
- smart_subsample – Enable high quality chroma subsampling, bool.
- near_lossless – Enable preprocessing in lossless mode (uses Q), bool.
- alpha_q – Change alpha plane fidelity for lossy compression, int.
- min_size – Optimise for minimum size, bool.
- kmin – Minimum number of frames between key frames, int.
- kmax – Maximum number of frames between key frames, int.
- effort – Level of CPU effort to reduce file size, int.
- target_size – Desired target size in bytes, int.
- mixed – Allow mixed encoding (might reduce file size), bool.
- smart_deblock – Enable auto-adjusting of the deblocking filter, bool.
- passes – Number of entropy-analysis passes (in [1..10]), int.
- keep – Which metadata to retain, VipsForeignKeep.
- background – Background value, std::vector<double>.
- page_height – Set page height for multipage save, int.
- profile – Filename of ICC profile to embed, const char *.
- Parameters
-
target Target to save to. options Set of options.
◆ width()
|
inline |
Return the width of the image in pixels.
◆ wop() [1/3]
Raise the constant to the power of each pixel (the opposite of pow).
◆ wop() [2/3]
Raise the constant to the power of each pixel (the opposite of pow).
◆ wop() [3/3]
Raise other to the power of each pixel (the opposite of pow).
◆ worley()
Make a worley noise image.
Optional parameters
- cell_size – Size of Worley cells, int.
- seed – Random number seed, int.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ wrap()
Wrap image origin.
Optional parameters
- x – Left edge of input in output, int.
- y – Top edge of input in output, int.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ write()
Write self to out. See VImage::new_memory() etc.
◆ write_to_buffer()
| void VImage::write_to_buffer | ( | const char * | suffix, |
| void ** | buf, | ||
| size_t * | size, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Write an image to an area of memory in the specified format. You must free() the memory area once you are done with it.
For example:
void *buf;
size_t size;
image.write_to_buffer(".jpg", &buf, &size);
The available options depends on the file format. See VImage::jpegsave(), for example.
◆ write_to_file()
Write an image to a file.
The available options depends on the file format. See VImage::jpegsave(), for example.
◆ write_to_memory()
Write an image to an area of memory as a C-style array.
◆ write_to_target()
| void VImage::write_to_target | ( | const char * | suffix, |
| VTarget | target, | ||
| VOption * |
options = nullptr |
||
| ) | const |
Write an image to a generic target object in the specified format.
The available options depends on the file format. See VImage::jpegsave(), for example.
◆ xoffset()
|
inline |
The horizontal offset of the origin in pixels.
◆ xres()
|
inline |
The horizontal resolution in pixels per millimeter.
◆ xyz()
Make an image where pixel values are coordinates.
Optional parameters
- csize – Size of third dimension, int.
- dsize – Size of fourth dimension, int.
- esize – Size of fifth dimension, int.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ XYZ2CMYK()
Transform xyz to cmyk.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ XYZ2Lab()
Transform xyz to lab.
Optional parameters
- temp – Colour temperature, std::vector<double>.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ XYZ2scRGB()
Transform xyz to scrgb.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ XYZ2Yxy()
Transform xyz to yxy.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ yoffset()
|
inline |
The vertical offset of the origin in pixels.
◆ yres()
|
inline |
The vertical resolution in pixels per millimeter.
◆ Yxy2XYZ()
Transform yxy to xyz.
- Parameters
-
options Set of options.
- Returns
- Output image.
◆ zone()
Make a zone plate.
Optional parameters
- uchar – Output an unsigned char image, bool.
- Parameters
-
width Image width in pixels. height Image height in pixels. options Set of options.
- Returns
- Output image.
◆ zoom()
Zoom an image.
- Parameters
-
xfac Horizontal zoom factor. yfac Vertical zoom factor. options Set of options.
- Returns
- Output image.
The documentation for this class was generated from the following files:
- /home/john/GIT/libvips/cplusplus/include/vips/VImage8.h
- /home/john/GIT/libvips/cplusplus/VImage.cpp
- /home/john/GIT/libvips/cplusplus/vips-operators.cpp
Generated by
1.9.8