Title: Operator index / Alphabetical

libvips has a set of operators, each of which computes some useful image processing operation. Each operator is implemented as a [[email protected]] class, for example VipsGamma. Classes are identified by their unique [property@VipsObject:nickname], in this case gamma.

From the command-line, C++ and most language bindings, you use the nickname to call the operator. For example in C++:

c++

vips::VImage fred = ...;
vips::VImage jim = fred.gamma();

or Python:

python

fred = jim.gamma()

libvips has a set of C wrapper functions for calling operators, in this case [[email protected]]:

VipsImage *fred = ...;
VipsImage *jim;

if (vips_gamma(fred, &jim, NULL))
    ...error;

Some operators have many C convenience functions.

All libvips operators

This table lists all the libvips operators with their C convenience functions and a short description. It's supposed to be useful for searching. See the API docs each function links to for more details.

Operator	Description	C functions
`CMC2LCh`	Transform lch to cmc	[[email protected]]
`CMYK2XYZ`	Transform cmyk to xyz	[[email protected]]
`HSV2sRGB`	Transform hsv to srgb	[[email protected]]
`LCh2CMC`	Transform lch to cmc	[[email protected]]
`LCh2Lab`	Transform lch to lab	[[email protected]]
`Lab2LCh`	Transform lab to lch	[[email protected]]
`Lab2LabQ`	Transform float lab to labq coding	[[email protected]]
`Lab2LabS`	Transform float lab to signed short	[[email protected]]
`Lab2XYZ`	Transform cielab to xyz	[[email protected]]
`LabQ2Lab`	Unpack a labq image to float lab	[[email protected]]
`LabQ2LabS`	Unpack a labq image to short lab	[[email protected]]
`LabQ2sRGB`	Convert a labq image to srgb	[[email protected]]
`LabS2Lab`	Transform signed short lab to float	[[email protected]]
`LabS2LabQ`	Transform short lab to labq coding	[[email protected]]
`Oklab2Oklch`	Transform oklab to oklch	[[email protected]]
`Oklab2XYZ`	Transform oklab to xyz	[[email protected]]
`Oklch2Oklab`	Transform oklch to oklab	[[email protected]]
`XYZ2CMYK`	Transform xyz to cmyk	[[email protected]]
`XYZ2Lab`	Transform xyz to lab	[[email protected]]
`XYZ2Oklab`	Transform xyz to oklab	[[email protected]]
`XYZ2Yxy`	Transform xyz to yxy	[[email protected]]
`XYZ2scRGB`	Transform xyz to scrgb	[[email protected]]
`Yxy2XYZ`	Transform yxy to xyz	[[email protected]]
`abs`	Absolute value of an image	[[email protected]]
`add`	Add two images	[[email protected]]
`addalpha`	Append an alpha channel	[[email protected]]
`affine`	Affine transform of an image	[[email protected]]
`analyzeload`	Load an analyze6 image	[[email protected]]
`arrayjoin`	Join an array of images	[[email protected]]
`autorot`	Autorotate image by exif tag	[[email protected]]
`avg`	Find image average	[[email protected]]
`bandbool`	Boolean operation across image bands	[[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]]
`bandfold`	Fold up x axis into bands	[[email protected]]
`bandjoin`	Bandwise join a set of images	[[email protected]], [[email protected]]
`bandjoin_const`	Append a constant band to an image	[[email protected]_const], [[email protected]_const1]
`bandmean`	Band-wise average	[[email protected]]
`bandrank`	Band-wise rank of a set of images	[[email protected]]
`bandunfold`	Unfold image bands into x axis	[[email protected]]
`black`	Make a black image	[[email protected]]
`boolean`	Boolean operation on two images	[[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]]
`boolean_const`	Boolean operations against a constant	[[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1]
`buildlut`	Build a look-up table	[[email protected]]
`byteswap`	Byteswap an image	[[email protected]]
`canny`	Canny edge detector	[[email protected]]
`case`	Use pixel values to pick cases from an array of images	[[email protected]]
`cast`	Cast an image	[[email protected]], [[email protected]_uchar], [[email protected]_char], [[email protected]_ushort], [[email protected]_short], [[email protected]_uint], [[email protected]_int], [[email protected]_float], [[email protected]_double], [[email protected]_complex], [[email protected]_dpcomplex]
`clamp`	Clamp values of an image	[[email protected]]
`colourspace`	Convert to a new colorspace	[[email protected]]
`compass`	Convolve with rotating mask	[[email protected]]
`complex`	Perform a complex operation on an image	[[email protected]], [[email protected]], [[email protected]], [[email protected]]
`complex2`	Complex binary operations on two images	[[email protected]], [[email protected]_phase]
`complexform`	Form a complex image from two real images	[[email protected]]
`complexget`	Get a component from a complex image	[[email protected]], [[email protected]], [[email protected]]
`composite`	Blend an array of images with an array of blend modes	[[email protected]]
`composite2`	Blend a pair of images with a blend mode	[[email protected]]
`conv`	Convolution operation	[[email protected]]
`conva`	Approximate integer convolution	[[email protected]]
`convasep`	Approximate separable integer convolution	[[email protected]]
`convf`	Float convolution operation	[[email protected]]
`convi`	Int convolution operation	[[email protected]]
`convsep`	Separable convolution operation	[[email protected]]
`copy`	Copy an image	[[email protected]]
`countlines`	Count lines in an image	[[email protected]]
`csvload`	Load csv	[[email protected]]
`csvload_source`	Load csv	[[email protected]_source]
`csvsave`	Save image to csv	[[email protected]]
`csvsave_target`	Save image to csv	[[email protected]_target]
`dE00`	Calculate de00	[[email protected]]
`dE76`	Calculate de76	[[email protected]]
`dECMC`	Calculate decmc	[[email protected]]
`dcrawload`	Load raw camera files	[[email protected]]
`dcrawload_buffer`	Load raw camera files	[[email protected]_buffer]
`dcrawload_source`	Load raw camera files	[[email protected]_source]
`deviate`	Find image standard deviation	[[email protected]]
`divide`	Divide two images	[[email protected]]
`draw_circle`	Draw a circle on an image	[[email protected]_circle], [[email protected]_circle1]
`draw_flood`	Flood-fill an area	[[email protected]_flood], [[email protected]_flood1]
`draw_image`	Paint an image into another image	[[email protected]_image]
`draw_line`	Draw a line on an image	[[email protected]_line], [[email protected]_line1]
`draw_mask`	Draw a mask on an image	[[email protected]_mask], [[email protected]_mask1]
`draw_rect`	Paint a rectangle on an image	[[email protected]_rect], [[email protected]_rect1], [[email protected]_point], [[email protected]_point1]
`draw_smudge`	Blur a rectangle on an image	[[email protected]_smudge]
`dzsave`	Save image to deepzoom file	[[email protected]]
`dzsave_buffer`	Save image to dz buffer	[[email protected]_buffer]
`dzsave_target`	Save image to deepzoom target	[[email protected]_target]
`embed`	Embed an image in a larger image	[[email protected]]
`extract_area`	Extract an area from an image	[[email protected]_area], [[email protected]]
`extract_band`	Extract band from an image	[[email protected]_band]
`eye`	Make an image showing the eye's spatial response	[[email protected]]
`falsecolour`	False-color an image	[[email protected]]
`fastcor`	Fast correlation	[[email protected]]
`fill_nearest`	Fill image zeros with nearest non-zero pixel	[[email protected]_nearest]
`find_trim`	Search an image for non-edge areas	[[email protected]_trim]
`fitsload`	Load a fits image	[[email protected]]
`fitsload_source`	Load fits from a source	[[email protected]_source]
`fitssave`	Save image to fits file	[[email protected]]
`flatten`	Flatten alpha out of an image	[[email protected]]
`flip`	Flip an image	[[email protected]]
`float2rad`	Transform float rgb to radiance coding	[[email protected]]
`fractsurf`	Make a fractal surface	[[email protected]]
`freqmult`	Frequency-domain filtering	[[email protected]]
`fwfft`	Forward fft	[[email protected]]
`gamma`	Gamma an image	[[email protected]]
`gaussblur`	Gaussian blur	[[email protected]]
`gaussmat`	Make a gaussian image	[[email protected]]
`gaussnoise`	Make a gaussnoise image	[[email protected]]
`getpoint`	Read a point from an image	[[email protected]]
`gifload`	Load gif with libnsgif	[[email protected]]
`gifload_buffer`	Load gif with libnsgif	[[email protected]_buffer]
`gifload_source`	Load gif from source	[[email protected]_source]
`gifsave`	Save as gif	[[email protected]]
`gifsave_buffer`	Save as gif	[[email protected]_buffer]
`gifsave_target`	Save as gif	[[email protected]_target]
`globalbalance`	Global balance an image mosaic	[[email protected]]
`gravity`	Place an image within a larger image with a certain gravity	[[email protected]]
`grey`	Make a grey ramp image	[[email protected]]
`grid`	Grid an image	[[email protected]]
`heifload`	Load a heif image	[[email protected]]
`heifload_buffer`	Load a heif image	[[email protected]_buffer]
`heifload_source`	Load a heif image	[[email protected]_source]
`heifsave`	Save image in heif format	[[email protected]]
`heifsave_buffer`	Save image in heif format	[[email protected]_buffer]
`heifsave_target`	Save image in heif format	[[email protected]_target]
`hist_cum`	Form cumulative histogram	[[email protected]_cum]
`hist_entropy`	Estimate image entropy	[[email protected]_entropy]
`hist_equal`	Histogram equalisation	[[email protected]_equal]
`hist_find`	Find image histogram	[[email protected]_find]
`hist_find_indexed`	Find indexed image histogram	[[email protected]_find_indexed]
`hist_find_ndim`	Find n-dimensional image histogram	[[email protected]_find_ndim]
`hist_ismonotonic`	Test for monotonicity	[[email protected]_ismonotonic]
`hist_local`	Local histogram equalisation	[[email protected]_local]
`hist_match`	Match two histograms	[[email protected]_match]
`hist_norm`	Normalise histogram	[[email protected]_norm]
`hist_plot`	Plot histogram	[[email protected]_plot]
`hough_circle`	Find hough circle transform	[[email protected]_circle]
`hough_line`	Find hough line transform	[[email protected]_line]
`icc_export`	Output to device with icc profile	[[email protected]_export]
`icc_import`	Import from device with icc profile	[[email protected]_import]
`icc_transform`	Transform between devices with icc profiles	[[email protected]_transform]
`identity`	Make a 1d image where pixel values are indexes	[[email protected]]
`ifthenelse`	Ifthenelse an image	[[email protected]]
`insert`	Insert image @sub into @main at @x, @y	[[email protected]]
`invert`	Invert an image	[[email protected]]
`invertlut`	Build an inverted look-up table	[[email protected]]
`invfft`	Inverse fft	[[email protected]]
`join`	Join a pair of images	[[email protected]]
`jp2kload`	Load jpeg2000 image	[[email protected]]
`jp2kload_buffer`	Load jpeg2000 image	[[email protected]_buffer]
`jp2kload_source`	Load jpeg2000 image	[[email protected]_source]
`jp2ksave`	Save image in jpeg2000 format	[[email protected]]
`jp2ksave_buffer`	Save image in jpeg2000 format	[[email protected]_buffer]
`jp2ksave_target`	Save image in jpeg2000 format	[[email protected]_target]
`jpegload`	Load jpeg from file	[[email protected]]
`jpegload_buffer`	Load jpeg from buffer	[[email protected]_buffer]
`jpegload_source`	Load image from jpeg source	[[email protected]_source]
`jpegsave`	Save as jpeg	[[email protected]]
`jpegsave_buffer`	Save as jpeg	[[email protected]_buffer]
`jpegsave_mime`	Save image to jpeg mime	[[email protected]_mime]
`jpegsave_target`	Save as jpeg	[[email protected]_target]
`jxlload`	Load jpeg-xl image	[[email protected]]
`jxlload_buffer`	Load jpeg-xl image	[[email protected]_buffer]
`jxlload_source`	Load jpeg-xl image	[[email protected]_source]
`jxlsave`	Save image in jpeg-xl format	[[email protected]]
`jxlsave_buffer`	Save image in jpeg-xl format	[[email protected]_buffer]
`jxlsave_target`	Save image in jpeg-xl format	[[email protected]_target]
`labelregions`	Label regions in an image	[[email protected]]
`linear`	Calculate (a * in + b)	[[email protected]], [[email protected]]
`linecache`	Cache an image as a set of lines	[[email protected]]
`logmat`	Make a laplacian of gaussian image	[[email protected]]
`magickload`	Load file with imagemagick	[[email protected]]
`magickload_buffer`	Load buffer with imagemagick	[[email protected]_buffer]
`magickload_source`	Load source with imagemagick	[[email protected]_source]
`magicksave`	Save file with imagemagick	[[email protected]]
`magicksave_buffer`	Save image to magick buffer	[[email protected]_buffer]
`mapim`	Resample with a map image	[[email protected]]
`maplut`	Map an image though a lut	[[email protected]]
`mask_butterworth`	Make a butterworth filter	[[email protected]_butterworth]
`mask_butterworth_band`	Make a butterworth_band filter	[[email protected]_butterworth_band]
`mask_butterworth_ring`	Make a butterworth ring filter	[[email protected]_butterworth_ring]
`mask_fractal`	Make fractal filter	[[email protected]_fractal]
`mask_gaussian`	Make a gaussian filter	[[email protected]_gaussian]
`mask_gaussian_band`	Make a gaussian filter	[[email protected]_gaussian_band]
`mask_gaussian_ring`	Make a gaussian ring filter	[[email protected]_gaussian_ring]
`mask_ideal`	Make an ideal filter	[[email protected]_ideal]
`mask_ideal_band`	Make an ideal band filter	[[email protected]_ideal_band]
`mask_ideal_ring`	Make an ideal ring filter	[[email protected]_ideal_ring]
`match`	First-order match of two images	[[email protected]]
`math`	Apply a math operation to an image	[[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]]
`math2`	Binary math operations	[[email protected]], [[email protected]], [[email protected]], [[email protected]]
`math2_const`	Binary math operations with a constant	[[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1]
`matload`	Load mat from file	[[email protected]]
`matrixinvert`	Invert a matrix	[[email protected]]
`matrixload`	Load matrix	[[email protected]]
`matrixload_source`	Load matrix	[[email protected]_source]
`matrixmultiply`	Multiply two matrices	[[email protected]]
`matrixprint`	Print matrix	[[email protected]]
`matrixsave`	Save image to matrix	[[email protected]]
`matrixsave_target`	Save image to matrix	[[email protected]_target]
`max`	Find image maximum	[[email protected]]
`maxpair`	Maximum of a pair of images	[[email protected]]
`measure`	Measure a set of patches on a color chart	[[email protected]]
`merge`	Merge two images	[[email protected]]
`min`	Find image minimum	[[email protected]]
`minpair`	Minimum of a pair of images	[[email protected]]
`morph`	Morphology operation	[[email protected]]
`mosaic`	Mosaic two images	[[email protected]]
`mosaic1`	First-order mosaic of two images	[[email protected]]
`msb`	Pick most-significant byte from an image	[[email protected]]
`multiply`	Multiply two images	[[email protected]]
`niftiload`	Load nifti volume	[[email protected]]
`niftiload_source`	Load nifti volumes	[[email protected]_source]
`niftisave`	Save image to nifti file	[[email protected]]
`openexrload`	Load an openexr image	[[email protected]]
`openslideload`	Load file with openslide	[[email protected]]
`openslideload_source`	Load source with openslide	[[email protected]_source]
`pdfload`	Load pdf from file	[[email protected]]
`pdfload_buffer`	Load pdf from buffer	[[email protected]_buffer]
`pdfload_source`	Load pdf from source	[[email protected]_source]
`percent`	Find threshold for percent of pixels	[[email protected]]
`perlin`	Make a perlin noise image	[[email protected]]
`phasecor`	Calculate phase correlation	[[email protected]]
`pngload`	Load png from file	[[email protected]]
`pngload_buffer`	Load png from buffer	[[email protected]_buffer]
`pngload_source`	Load png from source	[[email protected]_source]
`pngsave`	Save image to file as png	[[email protected]]
`pngsave_buffer`	Save image to buffer as png	[[email protected]_buffer]
`pngsave_target`	Save image to target as png	[[email protected]_target]
`ppmload`	Load ppm from file	[[email protected]]
`ppmload_buffer`	Load ppm from buffer	[[email protected]_buffer]
`ppmload_source`	Load ppm from source	[[email protected]_source]
`ppmsave`	Save image to ppm file	[[email protected]]
`ppmsave_target`	Save to ppm	[[email protected]_target]
`premultiply`	Premultiply image alpha	[[email protected]]
`prewitt`	Prewitt edge detector	[[email protected]]
`profile`	Find image profiles	[[email protected]]
`profile_load`	Load named icc profile	[[email protected]_load]
`project`	Find image projections	[[email protected]]
`quadratic`	Resample an image with a quadratic transform	[[email protected]]
`rad2float`	Unpack radiance coding to float rgb	[[email protected]]
`radload`	Load a radiance image from a file	[[email protected]]
`radload_buffer`	Load rad from buffer	[[email protected]_buffer]
`radload_source`	Load rad from source	[[email protected]_source]
`radsave`	Save image to radiance file	[[email protected]]
`radsave_buffer`	Save image to radiance buffer	[[email protected]_buffer]
`radsave_target`	Save image to radiance target	[[email protected]_target]
`rank`	Rank filter	[[email protected]], [[email protected]]
`rawload`	Load raw data from a file	[[email protected]]
`rawsave`	Save image to raw file	[[email protected]]
`rawsave_buffer`	Write raw image to buffer	[[email protected]_buffer]
`rawsave_target`	Write raw image to target	[[email protected]_target]
`recomb`	Linear recombination with matrix	[[email protected]]
`reduce`	Reduce an image	[[email protected]]
`reduceh`	Shrink an image horizontally	[[email protected]]
`reducev`	Shrink an image vertically	[[email protected]]
`relational`	Relational operation on two images	[[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]], [[email protected]]
`relational_const`	Relational operations against a constant	[[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1], [[email protected]_const1]
`remainder`	Remainder after integer division of two images	[[email protected]]
`remainder_const`	Remainder after integer division of an image and a constant	[[email protected]_const], [[email protected]_const1]
`remosaic`	Rebuild an mosaiced image	[[email protected]]
`replicate`	Replicate an image	[[email protected]]
`resize`	Resize an image	[[email protected]]
`rot`	Rotate an image	[[email protected]]
`rot45`	Rotate an image	[[email protected]]
`rotate`	Rotate an image by a number of degrees	[[email protected]]
`round`	Perform a round function on an image	[[email protected]], [[email protected]], [[email protected]], [[email protected]]
`sRGB2HSV`	Transform srgb to hsv	[[email protected]]
`sRGB2scRGB`	Convert an srgb image to scrgb	[[email protected]]
`scRGB2BW`	Convert scrgb to bw	[[email protected]]
`scRGB2XYZ`	Transform scrgb to xyz	[[email protected]]
`scRGB2sRGB`	Convert scrgb to srgb	[[email protected]]
`scale`	Scale an image to uchar	[[email protected]]
`scharr`	Scharr edge detector	[[email protected]]
`sdf`	Create an sdf image	[[email protected]]
`sequential`	Check sequential access	[[email protected]]
`sharpen`	Unsharp masking for print	[[email protected]]
`shrink`	Shrink an image	[[email protected]]
`shrinkh`	Shrink an image horizontally	[[email protected]]
`shrinkv`	Shrink an image vertically	[[email protected]]
`sign`	Unit vector of pixel	[[email protected]]
`similarity`	Similarity transform of an image	[[email protected]]
`sines`	Make a 2d sine wave	[[email protected]]
`smartcrop`	Extract an area from an image	[[email protected]]
`sobel`	Sobel edge detector	[[email protected]]
`spcor`	Spatial correlation	[[email protected]]
`spectrum`	Make displayable power spectrum	[[email protected]]
`stats`	Find many image stats	[[email protected]]
`stdif`	Statistical difference	[[email protected]]
`subsample`	Subsample an image	[[email protected]]
`subtract`	Subtract two images	[[email protected]]
`sum`	Sum an array of images	[[email protected]]
`svgload`	Load svg with rsvg	[[email protected]]
`svgload_buffer`	Load svg with rsvg	[[email protected]_buffer]
`svgload_source`	Load svg from source	[[email protected]_source]
`switch`	Find the index of the first non-zero pixel in tests	[[email protected]]
`system`	Run an external command	[[email protected]]
`text`	Make a text image	[[email protected]]
`thumbnail`	Generate thumbnail from file	[[email protected]]
`thumbnail_buffer`	Generate thumbnail from buffer	[[email protected]_buffer]
`thumbnail_image`	Generate thumbnail from image	[[email protected]_image]
`thumbnail_source`	Generate thumbnail from source	[[email protected]_source]
`tiffload`	Load tiff from file	[[email protected]]
`tiffload_buffer`	Load tiff from buffer	[[email protected]_buffer]
`tiffload_source`	Load tiff from source	[[email protected]_source]
`tiffsave`	Save image to tiff file	[[email protected]]
`tiffsave_buffer`	Save image to tiff buffer	[[email protected]_buffer]
`tiffsave_target`	Save image to tiff target	[[email protected]_target]
`tilecache`	Cache an image as a set of tiles	[[email protected]]
`tonelut`	Build a look-up table	[[email protected]]
`transpose3d`	Transpose3d an image	[[email protected]]
`uhdr2scRGB`	Transform uhdr to scrgb	[[email protected]]
`uhdrload`	Load a uhdr image	[[email protected]]
`uhdrload_buffer`	Load a uhdr image	[[email protected]_buffer]
`uhdrload_source`	Load a uhdr image	[[email protected]_source]
`uhdrsave`	Save image in ultrahdr format	[[email protected]]
`uhdrsave_buffer`	Save image in ultrahdr format	[[email protected]_buffer]
`uhdrsave_target`	Save image in ultrahdr format	[[email protected]_target]
`unpremultiply`	Unpremultiply image alpha	[[email protected]]
`vipsload`	Load vips from file	[[email protected]]
`vipsload_source`	Load vips from source	[[email protected]_source]
`vipssave`	Save image to file in vips format	[[email protected]]
`vipssave_target`	Save image to target in vips format	[[email protected]_target]
`webpload`	Load webp from file	[[email protected]]
`webpload_buffer`	Load webp from buffer	[[email protected]_buffer]
`webpload_source`	Load webp from source	[[email protected]_source]
`webpsave`	Save as webp	[[email protected]]
`webpsave_buffer`	Save as webp	[[email protected]_buffer]
`webpsave_mime`	Save image to webp mime	[[email protected]_mime]
`webpsave_target`	Save as webp	[[email protected]_target]
`worley`	Make a worley noise image	[[email protected]]
`wrap`	Wrap image origin	[[email protected]]
`xyz`	Make an image where pixel values are coordinates	[[email protected]]
`zone`	Make a zone plate	[[email protected]]
`zoom`	Zoom an image	[[email protected]]

Function List

All libvips operators