Inheritance diagram for VImage:

Collaboration diagram for VImage:

Public Member Functions
	VImage (VipsImage *image, VSteal steal=STEAL)

VipsImage *	get_image () const

int	width () const

int	height () const

int	bands () const

VipsBandFormat	format () const

VipsCoding	coding () const

VipsInterpretation	interpretation () const

VipsInterpretation	guess_interpretation () const

double	xres () const

double	yres () const

int	xoffset () const

int	yoffset () const

bool	has_alpha () const

const char *	filename () const

const void *	data () const

void	set (const char *field, int value)

void	set (const char field, int value, int n)

void	set (const char *field, std::vector< int > value)

void	set (const char *field, double value)

void	set (const char field, const char value)

void	set (const char field, VipsCallbackFn free_fn, void data, size_t length)

GType	get_typeof (const char *field) const

int	get_int (const char *field) const

void	get_array_int (const char field, int out, int n) const

std::vector< int >	get_array_int (const char *field) const

double	get_double (const char *field) const

const char *	get_string (const char *field) const

const void *	get_blob (const char field, size_t length) const

bool	remove (const char *name) const

VImage	new_from_image (std::vector< double > pixel) const

VImage	new_from_image (double pixel) const

VImage	copy_memory () const

VImage	write (VImage out) const

void	write_to_file (const char name, VOption options=0) const

void	write_to_buffer (const char suffix, void buf, size_t size, VOption *options=0) const

void	write_to_target (const char suffix, VTarget target, VOption options=0) const

void *	write_to_memory (size_t *size) const

VImage	linear (double a, double b, VOption *options=0) const

VImage	linear (std::vector< double > a, double b, VOption *options=0) const

VImage	linear (double a, std::vector< double > b, VOption *options=0) const

std::vector< VImage >	bandsplit (VOption *options=0) const

VImage	bandjoin (VImage other, VOption *options=0) const

VImage	bandjoin (double other, VOption *options=0) const

VImage	bandjoin (std::vector< double > other, VOption *options=0) const

VImage	composite (VImage other, VipsBlendMode mode, VOption *options=0) const

std::complex< double >	minpos (VOption *options=0) const

std::complex< double >	maxpos (VOption *options=0) const

VImage	fliphor (VOption *options=0) const

VImage	flipver (VOption *options=0) const

VImage	rot90 (VOption *options=0) const

VImage	rot180 (VOption *options=0) const

VImage	rot270 (VOption *options=0) const

VImage	dilate (VImage mask, VOption *options=0) const

VImage	erode (VImage mask, VOption *options=0) const

VImage	median (int size=3, VOption *options=0) const

VImage	floor (VOption *options=0) const

VImage	ceil (VOption *options=0) const

VImage	rint (VOption *options=0) const

VImage	bandand (VOption *options=0) const

VImage	bandor (VOption *options=0) const

VImage	bandeor (VOption *options=0) const

VImage	real (VOption *options=0) const

VImage	imag (VOption *options=0) const

VImage	polar (VOption *options=0) const

VImage	rect (VOption *options=0) const

VImage	conj (VOption *options=0) const

VImage	sin (VOption *options=0) const

VImage	cos (VOption *options=0) const

VImage	tan (VOption *options=0) const

VImage	asin (VOption *options=0) const

VImage	acos (VOption *options=0) const

VImage	atan (VOption *options=0) const

VImage	log (VOption *options=0) const

VImage	log10 (VOption *options=0) const

VImage	exp (VOption *options=0) const

VImage	exp10 (VOption *options=0) const

VImage	pow (VImage other, VOption *options=0) const

VImage	pow (double other, VOption *options=0) const

VImage	pow (std::vector< double > other, VOption *options=0) const

VImage	wop (VImage other, VOption *options=0) const

VImage	wop (double other, VOption *options=0) const

VImage	wop (std::vector< double > other, VOption *options=0) const

VImage	ifthenelse (std::vector< double > th, VImage el, VOption *options=0) const

VImage	ifthenelse (VImage th, std::vector< double > el, VOption *options=0) const

VImage	ifthenelse (std::vector< double > th, std::vector< double > el, VOption *options=0) const

VImage	ifthenelse (double th, VImage el, VOption *options=0) const

VImage	ifthenelse (VImage th, double el, VOption *options=0) const

VImage	ifthenelse (double th, double el, VOption *options=0) const

VImage	operator[] (int index) const

std::vector< double >	operator() (int x, int y) const

VImage	CMC2LCh (VOption *options=0) const

VImage	CMYK2XYZ (VOption *options=0) const

VImage	HSV2sRGB (VOption *options=0) const

VImage	LCh2CMC (VOption *options=0) const

VImage	LCh2Lab (VOption *options=0) const

VImage	Lab2LCh (VOption *options=0) const

VImage	Lab2LabQ (VOption *options=0) const

VImage	Lab2LabS (VOption *options=0) const

VImage	Lab2XYZ (VOption *options=0) const

VImage	LabQ2Lab (VOption *options=0) const

VImage	LabQ2LabS (VOption *options=0) const

VImage	LabQ2sRGB (VOption *options=0) const

VImage	LabS2Lab (VOption *options=0) const

VImage	LabS2LabQ (VOption *options=0) const

VImage	XYZ2CMYK (VOption *options=0) const

VImage	XYZ2Lab (VOption *options=0) const

VImage	XYZ2Yxy (VOption *options=0) const

VImage	XYZ2scRGB (VOption *options=0) const

VImage	Yxy2XYZ (VOption *options=0) const

VImage	abs (VOption *options=0) const

VImage	add (VImage right, VOption *options=0) const

VImage	affine (std::vector< double > matrix, VOption *options=0) const

VImage	autorot (VOption *options=0) const

double	avg (VOption *options=0) const

VImage	bandbool (VipsOperationBoolean boolean, VOption *options=0) const

VImage	bandfold (VOption *options=0) const

VImage	bandjoin_const (std::vector< double > c, VOption *options=0) const

VImage	bandmean (VOption *options=0) const

VImage	bandunfold (VOption *options=0) const

VImage	boolean (VImage right, VipsOperationBoolean boolean, VOption *options=0) const

VImage	boolean_const (VipsOperationBoolean boolean, std::vector< double > c, VOption *options=0) const

VImage	buildlut (VOption *options=0) const

VImage	byteswap (VOption *options=0) const

VImage	cache (VOption *options=0) const

VImage	canny (VOption *options=0) const

VImage	case_image (std::vector< VImage > cases, VOption *options=0) const

VImage	cast (VipsBandFormat format, VOption *options=0) const

VImage	colourspace (VipsInterpretation space, VOption *options=0) const

VImage	compass (VImage mask, VOption *options=0) const

VImage	complex (VipsOperationComplex cmplx, VOption *options=0) const

VImage	complex2 (VImage right, VipsOperationComplex2 cmplx, VOption *options=0) const

VImage	complexform (VImage right, VOption *options=0) const

VImage	complexget (VipsOperationComplexget get, VOption *options=0) const

VImage	composite2 (VImage overlay, VipsBlendMode mode, VOption *options=0) const

VImage	conv (VImage mask, VOption *options=0) const

VImage	conva (VImage mask, VOption *options=0) const

VImage	convasep (VImage mask, VOption *options=0) const

VImage	convf (VImage mask, VOption *options=0) const

VImage	convi (VImage mask, VOption *options=0) const

VImage	convsep (VImage mask, VOption *options=0) const

VImage	copy (VOption *options=0) const

double	countlines (VipsDirection direction, VOption *options=0) const

VImage	crop (int left, int top, int width, int height, VOption *options=0) const

void	csvsave (const char filename, VOption options=0) const

void	csvsave_target (VTarget target, VOption *options=0) const

VImage	dE00 (VImage right, VOption *options=0) const

VImage	dE76 (VImage right, VOption *options=0) const

VImage	dECMC (VImage right, VOption *options=0) const

double	deviate (VOption *options=0) const

VImage	divide (VImage right, VOption *options=0) const

void	draw_circle (std::vector< double > ink, int cx, int cy, int radius, VOption *options=0) const

void	draw_flood (std::vector< double > ink, int x, int y, VOption *options=0) const

void	draw_image (VImage sub, int x, int y, VOption *options=0) const

void	draw_line (std::vector< double > ink, int x1, int y1, int x2, int y2, VOption *options=0) const

void	draw_mask (std::vector< double > ink, VImage mask, int x, int y, VOption *options=0) const

void	draw_rect (std::vector< double > ink, int left, int top, int width, int height, VOption *options=0) const

void	draw_smudge (int left, int top, int width, int height, VOption *options=0) const

void	dzsave (const char filename, VOption options=0) const

VipsBlob *	dzsave_buffer (VOption *options=0) const

VImage	embed (int x, int y, int width, int height, VOption *options=0) const

VImage	extract_area (int left, int top, int width, int height, VOption *options=0) const

VImage	extract_band (int band, VOption *options=0) const

VImage	falsecolour (VOption *options=0) const

VImage	fastcor (VImage ref, VOption *options=0) const

VImage	fill_nearest (VOption *options=0) const

int	find_trim (int top, int width, int height, VOption options=0) const

void	fitssave (const char filename, VOption options=0) const

VImage	flatten (VOption *options=0) const

VImage	flip (VipsDirection direction, VOption *options=0) const

VImage	float2rad (VOption *options=0) const

VImage	freqmult (VImage mask, VOption *options=0) const

VImage	fwfft (VOption *options=0) const

VImage	gamma (VOption *options=0) const

VImage	gaussblur (double sigma, VOption *options=0) const

std::vector< double >	getpoint (int x, int y, VOption *options=0) const

VImage	globalbalance (VOption *options=0) const

VImage	gravity (VipsCompassDirection direction, int width, int height, VOption *options=0) const

VImage	grid (int tile_height, int across, int down, VOption *options=0) const

void	heifsave (const char filename, VOption options=0) const

VipsBlob *	heifsave_buffer (VOption *options=0) const

void	heifsave_target (VTarget target, VOption *options=0) const

VImage	hist_cum (VOption *options=0) const

double	hist_entropy (VOption *options=0) const

VImage	hist_equal (VOption *options=0) const

VImage	hist_find (VOption *options=0) const

VImage	hist_find_indexed (VImage index, VOption *options=0) const

VImage	hist_find_ndim (VOption *options=0) const

bool	hist_ismonotonic (VOption *options=0) const

VImage	hist_local (int width, int height, VOption *options=0) const

VImage	hist_match (VImage ref, VOption *options=0) const

VImage	hist_norm (VOption *options=0) const

VImage	hist_plot (VOption *options=0) const

VImage	hough_circle (VOption *options=0) const

VImage	hough_line (VOption *options=0) const

VImage	icc_export (VOption *options=0) const

VImage	icc_import (VOption *options=0) const

VImage	icc_transform (const char output_profile, VOption options=0) const

VImage	ifthenelse (VImage in1, VImage in2, VOption *options=0) const

VImage	insert (VImage sub, int x, int y, VOption *options=0) const

VImage	invert (VOption *options=0) const

VImage	invertlut (VOption *options=0) const

VImage	invfft (VOption *options=0) const

VImage	join (VImage in2, VipsDirection direction, VOption *options=0) const

void	jpegsave (const char filename, VOption options=0) const

VipsBlob *	jpegsave_buffer (VOption *options=0) const

void	jpegsave_mime (VOption *options=0) const

void	jpegsave_target (VTarget target, VOption *options=0) const

VImage	labelregions (VOption *options=0) const

VImage	linear (std::vector< double > a, std::vector< double > b, VOption *options=0) const

VImage	linecache (VOption *options=0) const

void	magicksave (const char filename, VOption options=0) const

VipsBlob *	magicksave_buffer (VOption *options=0) const

VImage	mapim (VImage index, VOption *options=0) const

VImage	maplut (VImage lut, VOption *options=0) const

VImage	match (VImage sec, int xr1, int yr1, int xs1, int ys1, int xr2, int yr2, int xs2, int ys2, VOption *options=0) const

VImage	math (VipsOperationMath math, VOption *options=0) const

VImage	math2 (VImage right, VipsOperationMath2 math2, VOption *options=0) const

VImage	math2_const (VipsOperationMath2 math2, std::vector< double > c, VOption *options=0) const

VImage	matrixinvert (VOption *options=0) const

void	matrixprint (VOption *options=0) const

void	matrixsave (const char filename, VOption options=0) const

void	matrixsave_target (VTarget target, VOption *options=0) const

double	max (VOption *options=0) const

VImage	measure (int h, int v, VOption *options=0) const

VImage	merge (VImage sec, VipsDirection direction, int dx, int dy, VOption *options=0) const

double	min (VOption *options=0) const

VImage	morph (VImage mask, VipsOperationMorphology morph, VOption *options=0) const

VImage	mosaic (VImage sec, VipsDirection direction, int xref, int yref, int xsec, int ysec, VOption *options=0) const

VImage	mosaic1 (VImage sec, VipsDirection direction, int xr1, int yr1, int xs1, int ys1, int xr2, int yr2, int xs2, int ys2, VOption *options=0) const

VImage	msb (VOption *options=0) const

VImage	multiply (VImage right, VOption *options=0) const

void	niftisave (const char filename, VOption options=0) const

int	percent (double percent, VOption *options=0) const

VImage	phasecor (VImage in2, VOption *options=0) const

void	pngsave (const char filename, VOption options=0) const

VipsBlob *	pngsave_buffer (VOption *options=0) const

void	pngsave_target (VTarget target, VOption *options=0) const

void	ppmsave (const char filename, VOption options=0) const

void	ppmsave_target (VTarget target, VOption *options=0) const

VImage	premultiply (VOption *options=0) const

VImage	profile (VImage rows, VOption options=0) const

VImage	project (VImage rows, VOption options=0) const

VImage	quadratic (VImage coeff, VOption *options=0) const

VImage	rad2float (VOption *options=0) const

void	radsave (const char filename, VOption options=0) const

VipsBlob *	radsave_buffer (VOption *options=0) const

void	radsave_target (VTarget target, VOption *options=0) const

VImage	rank (int width, int height, int index, VOption *options=0) const

void	rawsave (const char filename, VOption options=0) const

void	rawsave_fd (int fd, VOption *options=0) const

VImage	recomb (VImage m, VOption *options=0) const

VImage	reduce (double hshrink, double vshrink, VOption *options=0) const

VImage	reduceh (double hshrink, VOption *options=0) const

VImage	reducev (double vshrink, VOption *options=0) const

VImage	relational (VImage right, VipsOperationRelational relational, VOption *options=0) const

VImage	relational_const (VipsOperationRelational relational, std::vector< double > c, VOption *options=0) const

VImage	remainder (VImage right, VOption *options=0) const

VImage	remainder_const (std::vector< double > c, VOption *options=0) const

VImage	replicate (int across, int down, VOption *options=0) const

VImage	resize (double scale, VOption *options=0) const

VImage	rot (VipsAngle angle, VOption *options=0) const

VImage	rot45 (VOption *options=0) const

VImage	rotate (double angle, VOption *options=0) const

VImage	round (VipsOperationRound round, VOption *options=0) const

VImage	sRGB2HSV (VOption *options=0) const

VImage	sRGB2scRGB (VOption *options=0) const

VImage	scRGB2BW (VOption *options=0) const

VImage	scRGB2XYZ (VOption *options=0) const

VImage	scRGB2sRGB (VOption *options=0) const

VImage	scale (VOption *options=0) const

VImage	sequential (VOption *options=0) const

VImage	sharpen (VOption *options=0) const

VImage	shrink (double hshrink, double vshrink, VOption *options=0) const

VImage	shrinkh (int hshrink, VOption *options=0) const

VImage	shrinkv (int vshrink, VOption *options=0) const

VImage	sign (VOption *options=0) const

VImage	similarity (VOption *options=0) const

VImage	smartcrop (int width, int height, VOption *options=0) const

VImage	sobel (VOption *options=0) const

VImage	spcor (VImage ref, VOption *options=0) const

VImage	spectrum (VOption *options=0) const

VImage	stats (VOption *options=0) const

VImage	stdif (int width, int height, VOption *options=0) const

VImage	subsample (int xfac, int yfac, VOption *options=0) const

VImage	subtract (VImage right, VOption *options=0) const

VImage	thumbnail_image (int width, VOption *options=0) const

void	tiffsave (const char filename, VOption options=0) const

VipsBlob *	tiffsave_buffer (VOption *options=0) const

VImage	tilecache (VOption *options=0) const

VImage	transpose3d (VOption *options=0) const

VImage	unpremultiply (VOption *options=0) const

void	vipssave (const char filename, VOption options=0) const

void	webpsave (const char filename, VOption options=0) const

VipsBlob *	webpsave_buffer (VOption *options=0) const

void	webpsave_target (VTarget target, VOption *options=0) const

VImage	wrap (VOption *options=0) const

VImage	zoom (int xfac, int yfac, VOption *options=0) const

bool	is_null () const

Static Public Member Functions
static VOption *	option ()

static void	call_option_string (const char operation_name, const char option_string, VOption *options=0)

static void	call (const char operation_name, VOption options=0)

static VImage	new_memory ()

static VImage	new_temp_file (const char *file_format=".v")

static VImage	new_from_file (const char name, VOption options=0)

static VImage	new_from_memory (void *data, size_t size, int width, int height, int bands, VipsBandFormat format)

static VImage	new_from_buffer (const void buf, size_t len, const char option_string, VOption *options=0)

static VImage	new_from_buffer (const std::string &buf, const char option_string, VOption options=0)

static VImage	new_from_source (VSource source, const char option_string, VOption options=0)

static VImage	new_matrix (int width, int height)

static VImage	new_matrix (int width, int height, double *array, int size)

static VImage	new_matrixv (int width, int height,...)

static VImage	analyzeload (const char filename, VOption options=0)

static VImage	arrayjoin (std::vector< VImage > in, VOption *options=0)

static VImage	bandjoin (std::vector< VImage > in, VOption *options=0)

static VImage	bandrank (std::vector< VImage > in, VOption *options=0)

static VImage	black (int width, int height, VOption *options=0)

static VImage	composite (std::vector< VImage > in, std::vector< int > mode, VOption *options=0)

static VImage	csvload (const char filename, VOption options=0)

static VImage	csvload_source (VSource source, VOption *options=0)

static VImage	eye (int width, int height, VOption *options=0)

static VImage	fitsload (const char filename, VOption options=0)

static VImage	fractsurf (int width, int height, double fractal_dimension, VOption *options=0)

static VImage	gaussmat (double sigma, double min_ampl, VOption *options=0)

static VImage	gaussnoise (int width, int height, VOption *options=0)

static VImage	gifload (const char filename, VOption options=0)

static VImage	gifload_buffer (VipsBlob buffer, VOption options=0)

static VImage	gifload_source (VSource source, VOption *options=0)

static VImage	grey (int width, int height, VOption *options=0)

static VImage	heifload (const char filename, VOption options=0)

static VImage	heifload_buffer (VipsBlob buffer, VOption options=0)

static VImage	heifload_source (VSource source, VOption *options=0)

static VImage	identity (VOption *options=0)

static VImage	jpegload (const char filename, VOption options=0)

static VImage	jpegload_buffer (VipsBlob buffer, VOption options=0)

static VImage	jpegload_source (VSource source, VOption *options=0)

static VImage	logmat (double sigma, double min_ampl, VOption *options=0)

static VImage	magickload (const char filename, VOption options=0)

static VImage	magickload_buffer (VipsBlob buffer, VOption options=0)

static VImage	mask_butterworth (int width, int height, double order, double frequency_cutoff, double amplitude_cutoff, VOption *options=0)

static VImage	mask_butterworth_band (int width, int height, double order, double frequency_cutoff_x, double frequency_cutoff_y, double radius, double amplitude_cutoff, VOption *options=0)

static VImage	mask_butterworth_ring (int width, int height, double order, double frequency_cutoff, double amplitude_cutoff, double ringwidth, VOption *options=0)

static VImage	mask_fractal (int width, int height, double fractal_dimension, VOption *options=0)

static VImage	mask_gaussian (int width, int height, double frequency_cutoff, double amplitude_cutoff, VOption *options=0)

static VImage	mask_gaussian_band (int width, int height, double frequency_cutoff_x, double frequency_cutoff_y, double radius, double amplitude_cutoff, VOption *options=0)

static VImage	mask_gaussian_ring (int width, int height, double frequency_cutoff, double amplitude_cutoff, double ringwidth, VOption *options=0)

static VImage	mask_ideal (int width, int height, double frequency_cutoff, VOption *options=0)

static VImage	mask_ideal_band (int width, int height, double frequency_cutoff_x, double frequency_cutoff_y, double radius, VOption *options=0)

static VImage	mask_ideal_ring (int width, int height, double frequency_cutoff, double ringwidth, VOption *options=0)

static VImage	matload (const char filename, VOption options=0)

static VImage	matrixload (const char filename, VOption options=0)

static VImage	matrixload_source (VSource source, VOption *options=0)

static VImage	niftiload (const char filename, VOption options=0)

static VImage	openexrload (const char filename, VOption options=0)

static VImage	openslideload (const char filename, VOption options=0)

static VImage	pdfload (const char filename, VOption options=0)

static VImage	pdfload_buffer (VipsBlob buffer, VOption options=0)

static VImage	pdfload_source (VSource source, VOption *options=0)

static VImage	perlin (int width, int height, VOption *options=0)

static VImage	pngload (const char filename, VOption options=0)

static VImage	pngload_buffer (VipsBlob buffer, VOption options=0)

static VImage	pngload_source (VSource source, VOption *options=0)

static VImage	ppmload (const char filename, VOption options=0)

static VImage	ppmload_source (VSource source, VOption *options=0)

static VipsBlob *	profile_load (const char name, VOption options=0)

static VImage	radload (const char filename, VOption options=0)

static VImage	radload_buffer (VipsBlob buffer, VOption options=0)

static VImage	radload_source (VSource source, VOption *options=0)

static VImage	rawload (const char filename, int width, int height, int bands, VOption options=0)

static VImage	sines (int width, int height, VOption *options=0)

static VImage	sum (std::vector< VImage > in, VOption *options=0)

static VImage	svgload (const char filename, VOption options=0)

static VImage	svgload_buffer (VipsBlob buffer, VOption options=0)

static VImage	svgload_source (VSource source, VOption *options=0)

static VImage	switch_image (std::vector< VImage > tests, VOption *options=0)

static void	system (const char cmd_format, VOption options=0)

static VImage	text (const char text, VOption options=0)

static VImage	thumbnail (const char filename, int width, VOption options=0)

static VImage	thumbnail_buffer (VipsBlob buffer, int width, VOption options=0)

static VImage	thumbnail_source (VSource source, int width, VOption *options=0)

static VImage	tiffload (const char filename, VOption options=0)

static VImage	tiffload_buffer (VipsBlob buffer, VOption options=0)

static VImage	tiffload_source (VSource source, VOption *options=0)

static VImage	tonelut (VOption *options=0)

static VImage	vipsload (const char filename, VOption options=0)

static VImage	webpload (const char filename, VOption options=0)

static VImage	webpload_buffer (VipsBlob buffer, VOption options=0)

static VImage	webpload_source (VSource source, VOption *options=0)

static VImage	worley (int width, int height, VOption *options=0)

static VImage	xyz (int width, int height, VOption *options=0)

static VImage	zone (int width, int height, VOption *options=0)

Friends
VIPS_CPLUSPLUS_API VImage	operator+ (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator+ (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator+ (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator+ (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator+ (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator+= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator+= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator+= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator- (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator- (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator- (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator- (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator- (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator-= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator-= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator-= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator- (const VImage a)

VIPS_CPLUSPLUS_API VImage	operator* (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator* (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator* (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator* (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator* (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	*operator=** (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	*operator=** (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	*operator=** (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator/ (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator/ (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator/ (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator/ (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator/ (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator/= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator/= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator/= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator% (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator% (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator% (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator%= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator%= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator%= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator< (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator< (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator< (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator< (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator< (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator<= (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator<= (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator<= (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator<= (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator<= (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator> (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator> (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator> (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator> (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator> (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator>= (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator>= (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator>= (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator>= (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator>= (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator== (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator== (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator== (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator== (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator== (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator!= (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator!= (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator!= (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator!= (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator!= (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator& (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator& (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator& (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator& (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator& (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator&= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator&= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator&= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator\| (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator\| (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator\| (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator\| (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator\| (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator\|= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator\|= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator\|= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator^ (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator^ (const double a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator^ (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator^ (const std::vector< double > a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator^ (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator^= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator^= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator^= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator<< (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator<< (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator<< (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator<<= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator<<= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator<<= (VImage &a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage	operator>> (const VImage a, const VImage b)

VIPS_CPLUSPLUS_API VImage	operator>> (const VImage a, const double b)

VIPS_CPLUSPLUS_API VImage	operator>> (const VImage a, const std::vector< double > b)

VIPS_CPLUSPLUS_API VImage &	operator>>= (VImage &a, const VImage b)

VIPS_CPLUSPLUS_API VImage &	operator>>= (VImage &a, const double b)

VIPS_CPLUSPLUS_API VImage &	operator>>= (VImage &a, const std::vector< double > b)

Member Function Documentation

◆ abs()

VImage VImage::abs ( VOption * options = 0 ) const

Absolute value of an image.

Parameters

options Set of options.

Returns: Output image.

◆ add()

VImage VImage::add	(	VImage	right,
		VOption *	options = `0`
	)		const

Add two images.

Parameters

right	Right-hand image argument.
options	Set of options.

Returns: Output image.

◆ affine()

VImage VImage::affine	(	std::vector< double >	matrix,
		VOption *	options = `0`
	)		const

Affine transform of an image.

Optional parameters

interpolate – Interpolate pixels with this, <unknown type>.
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()

VImage VImage::analyzeload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load an analyze6 image.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ arrayjoin()

VImage VImage::arrayjoin	(	std::vector< VImage >	in,
		VOption *	options = `0`
	)

static

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.

◆ autorot()

VImage VImage::autorot ( VOption * options = 0 ) const

Autorotate image by exif tag.

Parameters

options Set of options.

Returns: Output image.

◆ avg()

double VImage::avg ( VOption * options = 0 ) const

Find image average.

Parameters

options Set of options.

Returns: Output value.

◆ bandbool()

VImage VImage::bandbool	(	VipsOperationBoolean	boolean,
		VOption *	options = `0`
	)		const

Boolean operation across image bands.

Parameters

boolean	boolean to perform.
options	Set of options.

Returns: Output image.

◆ bandfold()

VImage VImage::bandfold ( VOption * options = 0 ) const

Fold up x axis into bands.

Optional parameters

factor – Fold by this factor, int.

Parameters

options Set of options.

Returns: Output image.

◆ bandjoin()

VImage VImage::bandjoin	(	std::vector< VImage >	in,
		VOption *	options = `0`
	)

static

Bandwise join a set of images.

Parameters

in	Array of input images.
options	Set of options.

Returns: Output image.

◆ bandjoin_const()

VImage VImage::bandjoin_const	(	std::vector< double >	c,
		VOption *	options = `0`
	)		const

Append a constant band to an image.

Parameters

c	Array of constants to add.
options	Set of options.

Returns: Output image.

◆ bandmean()

VImage VImage::bandmean ( VOption * options = 0 ) const

Band-wise average.

Parameters

options Set of options.

Returns: Output image.

◆ bandrank()

VImage VImage::bandrank	(	std::vector< VImage >	in,
		VOption *	options = `0`
	)

static

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.

◆ bandunfold()

VImage VImage::bandunfold ( VOption * options = 0 ) const

Unfold image bands into x axis.

Optional parameters

factor – Unfold by this factor, int.

Parameters

options Set of options.

Returns: Output image.

◆ black()

VImage VImage::black	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

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 = `0`
	)		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 = `0`
	)		const

Boolean operations against a constant.

Parameters

boolean	boolean to perform.
c	Array of constants.
options	Set of options.

Returns: Output image.

◆ buildlut()

VImage VImage::buildlut ( VOption * options = 0 ) const

Build a look-up table.

Parameters

options Set of options.

Returns: Output image.

◆ byteswap()

VImage VImage::byteswap ( VOption * options = 0 ) const

Byteswap an image.

Parameters

options Set of options.

Returns: Output image.

◆ cache()

VImage VImage::cache ( VOption * options = 0 ) const

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.

◆ canny()

VImage VImage::canny ( VOption * options = 0 ) const

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()

VImage VImage::case_image	(	std::vector< VImage >	cases,
		VOption *	options = `0`
	)		const

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 = `0`
	)		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.

◆ CMC2LCh()

VImage VImage::CMC2LCh ( VOption * options = 0 ) const

Transform lch to cmc.

Parameters

options Set of options.

Returns: Output image.

◆ CMYK2XYZ()

VImage VImage::CMYK2XYZ ( VOption * options = 0 ) const

Transform cmyk to xyz.

Parameters

options Set of options.

Returns: Output image.

◆ colourspace()

VImage VImage::colourspace	(	VipsInterpretation	space,
		VOption *	options = `0`
	)		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()

VImage VImage::compass	(	VImage	mask,
		VOption *	options = `0`
	)		const

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()

VImage VImage::complex	(	VipsOperationComplex	cmplx,
		VOption *	options = `0`
	)		const

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 = `0`
	)		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()

VImage VImage::complexform	(	VImage	right,
		VOption *	options = `0`
	)		const

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 = `0`
	)		const

Get a component from a complex image.

Parameters

get	complex to perform.
options	Set of options.

Returns: Output image.

◆ composite()

VImage VImage::composite	(	std::vector< VImage >	in,
		std::vector< int >	mode,
		VOption *	options = `0`
	)

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.

◆ composite2()

VImage VImage::composite2	(	VImage	overlay,
		VipsBlendMode	mode,
		VOption *	options = `0`
	)		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.

◆ conv()

VImage VImage::conv	(	VImage	mask,
		VOption *	options = `0`
	)		const

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()

VImage VImage::conva	(	VImage	mask,
		VOption *	options = `0`
	)		const

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()

VImage VImage::convasep	(	VImage	mask,
		VOption *	options = `0`
	)		const

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()

VImage VImage::convf	(	VImage	mask,
		VOption *	options = `0`
	)		const

Float convolution operation.

Parameters

mask	Input matrix image.
options	Set of options.

Returns: Output image.

◆ convi()

VImage VImage::convi	(	VImage	mask,
		VOption *	options = `0`
	)		const

Int convolution operation.

Parameters

mask	Input matrix image.
options	Set of options.

Returns: Output image.

◆ convsep()

VImage VImage::convsep	(	VImage	mask,
		VOption *	options = `0`
	)		const

Seperable 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()

VImage VImage::copy ( VOption * options = 0 ) const

Copy an image.

Optional parameters

swap – Swap bytes in image between little and big-endian, bool.
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.

◆ countlines()

double VImage::countlines	(	VipsDirection	direction,
		VOption *	options = `0`
	)		const

Count lines in an image.

Parameters

direction	Countlines left-right or up-down.
options	Set of options.

Returns: Number of lines.

◆ crop()

VImage VImage::crop	(	int	left,
		int	top,
		int	width,
		int	height,
		VOption *	options = `0`
	)		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.

◆ csvload()

VImage VImage::csvload	(	const char *	filename,
		VOption *	options = `0`
	)

static

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.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ csvload_source()

VImage VImage::csvload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

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.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ csvsave()

void VImage::csvsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to csv.

Optional parameters

separator – Separator characters, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ csvsave_target()

void VImage::csvsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image to csv.

Optional parameters

separator – Separator characters, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ dE00()

VImage VImage::dE00	(	VImage	right,
		VOption *	options = `0`
	)		const

Calculate de00.

Parameters

right	Right-hand input image.
options	Set of options.

Returns: Output image.

◆ dE76()

VImage VImage::dE76	(	VImage	right,
		VOption *	options = `0`
	)		const

Calculate de76.

Parameters

right	Right-hand input image.
options	Set of options.

Returns: Output image.

◆ dECMC()

VImage VImage::dECMC	(	VImage	right,
		VOption *	options = `0`
	)		const

Calculate decmc.

Parameters

right	Right-hand input image.
options	Set of options.

Returns: Output image.

◆ deviate()

double VImage::deviate ( VOption * options = 0 ) const

Find image standard deviation.

Parameters

options Set of options.

Returns: Output value.

◆ divide()

VImage VImage::divide	(	VImage	right,
		VOption *	options = `0`
	)		const

Divide two images.

Parameters

right	Right-hand image argument.
options	Set of options.

Returns: Output image.

◆ draw_circle()

void VImage::draw_circle	(	std::vector< double >	ink,
		int	cx,
		int	cy,
		int	radius,
		VOption *	options = `0`
	)		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()

void VImage::draw_flood	(	std::vector< double >	ink,
		int	x,
		int	y,
		VOption *	options = `0`
	)		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()

void VImage::draw_image	(	VImage	sub,
		int	x,
		int	y,
		VOption *	options = `0`
	)		const

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()

void VImage::draw_line	(	std::vector< double >	ink,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		VOption *	options = `0`
	)		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()

void VImage::draw_mask	(	std::vector< double >	ink,
		VImage	mask,
		int	x,
		int	y,
		VOption *	options = `0`
	)		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_rect()

void VImage::draw_rect	(	std::vector< double >	ink,
		int	left,
		int	top,
		int	width,
		int	height,
		VOption *	options = `0`
	)		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 = `0`
	)		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()

void VImage::dzsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to deepzoom file.

Optional parameters

dirname – Directory name to save to, const char *.
basename – Base name to save to, 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.
tile_height – Tile height in pixels, int.
tile_width – Tile width in pixels, int.
centre – Center image in tile, bool.
depth – Pyramid depth, VipsForeignDzDepth.
angle – Rotate image during save, VipsAngle.
container – Pyramid container type, VipsForeignDzContainer.
properties – Write a properties file to the output directory, bool.
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.
no_strip – Don't strip tile metadata, bool.
id – Resource ID, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ dzsave_buffer()

VipsBlob * VImage::dzsave_buffer ( VOption * options = 0 ) const

Save image to dz buffer.

Optional parameters

dirname – Directory name to save to, const char *.
basename – Base name to save to, 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.
tile_height – Tile height in pixels, int.
tile_width – Tile width in pixels, int.
centre – Center image in tile, bool.
depth – Pyramid depth, VipsForeignDzDepth.
angle – Rotate image during save, VipsAngle.
container – Pyramid container type, VipsForeignDzContainer.
properties – Write a properties file to the output directory, bool.
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.
no_strip – Don't strip tile metadata, bool.
id – Resource ID, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ embed()

VImage VImage::embed	(	int	x,
		int	y,
		int	width,
		int	height,
		VOption *	options = `0`
	)		const

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.

◆ extract_area()

VImage VImage::extract_area	(	int	left,
		int	top,
		int	width,
		int	height,
		VOption *	options = `0`
	)		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()

VImage VImage::extract_band	(	int	band,
		VOption *	options = `0`
	)		const

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()

VImage VImage::eye	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

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()

VImage VImage::falsecolour ( VOption * options = 0 ) const

False-color an image.

Parameters

options Set of options.

Returns: Output image.

◆ fastcor()

VImage VImage::fastcor	(	VImage	ref,
		VOption *	options = `0`
	)		const

Fast correlation.

Parameters

ref	Input reference image.
options	Set of options.

Returns: Output image.

◆ fill_nearest()

VImage VImage::fill_nearest ( VOption * options = 0 ) const

Fill image zeros with nearest non-zero pixel.

Parameters

options Set of options.

Returns: Value of nearest non-zero pixel.

◆ find_trim()

int VImage::find_trim	(	int *	top,
		int *	width,
		int *	height,
		VOption *	options = `0`
	)		const

Search an image for non-edge areas.

Optional parameters

threshold – Object threshold, double.
background – Color for background pixels, std::vector<double>.

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()

VImage VImage::fitsload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load a fits image.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ fitssave()

void VImage::fitssave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to fits file.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ flatten()

VImage VImage::flatten ( VOption * options = 0 ) const

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 = `0`
	)		const

Flip an image.

Parameters

direction	Direction to flip image.
options	Set of options.

Returns: Output image.

◆ float2rad()

VImage VImage::float2rad ( VOption * options = 0 ) const

Transform float rgb to radiance coding.

Parameters

options Set of options.

Returns: Output image.

◆ fractsurf()

VImage VImage::fractsurf	(	int	width,
		int	height,
		double	fractal_dimension,
		VOption *	options = `0`
	)

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()

VImage VImage::freqmult	(	VImage	mask,
		VOption *	options = `0`
	)		const

Frequency-domain filtering.

Parameters

mask	Input mask image.
options	Set of options.

Returns: Output image.

◆ fwfft()

VImage VImage::fwfft ( VOption * options = 0 ) const

Forward fft.

Parameters

options Set of options.

Returns: Output image.

◆ gamma()

VImage VImage::gamma ( VOption * options = 0 ) const

Gamma an image.

Optional parameters

exponent – Gamma factor, double.

Parameters

options Set of options.

Returns: Output image.

◆ gaussblur()

VImage VImage::gaussblur	(	double	sigma,
		VOption *	options = `0`
	)		const

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()

VImage VImage::gaussmat	(	double	sigma,
		double	min_ampl,
		VOption *	options = `0`
	)

static

Make a gaussian image.

Optional parameters

separable – Generate separable Gaussian, bool.
integer – Generate integer 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()

VImage VImage::gaussnoise	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

Make a gaussnoise image.

Optional parameters

sigma – Standard deviation of pixels in generated image, double.
mean – Mean of pixels in generated image, double.

Parameters

width	Image width in pixels.
height	Image height in pixels.
options	Set of options.

Returns: Output image.

◆ getpoint()

std::vector< double > VImage::getpoint	(	int	x,
		int	y,
		VOption *	options = `0`
	)		const

Read a point from an image.

Parameters

x	Point to read.
y	Point to read.
options	Set of options.

Returns: Array of output values.

◆ gifload()

VImage VImage::gifload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load gif with giflib.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ gifload_buffer()

VImage VImage::gifload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load gif with giflib.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ gifload_source()

VImage VImage::gifload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load gif with giflib.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ globalbalance()

VImage VImage::globalbalance ( VOption * options = 0 ) const

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 = `0`
	)		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()

VImage VImage::grey	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

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()

VImage VImage::grid	(	int	tile_height,
		int	across,
		int	down,
		VOption *	options = `0`
	)		const

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.

◆ heifload()

VImage VImage::heifload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load a heif image.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
thumbnail – Fetch thumbnail image, bool.
autorotate – Rotate image using exif orientation, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ heifload_buffer()

VImage VImage::heifload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load a heif image.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
thumbnail – Fetch thumbnail image, bool.
autorotate – Rotate image using exif orientation, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ heifload_source()

VImage VImage::heifload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load a heif image.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
thumbnail – Fetch thumbnail image, bool.
autorotate – Rotate image using exif orientation, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ heifsave()

void VImage::heifsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image in heif format.

Optional parameters

Q – Q factor, int.
lossless – Enable lossless compression, bool.
compression – Compression format, VipsForeignHeifCompression.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to load from.
options	Set of options.

◆ heifsave_buffer()

VipsBlob * VImage::heifsave_buffer ( VOption * options = 0 ) const

Save image in heif format.

Optional parameters

Q – Q factor, int.
lossless – Enable lossless compression, bool.
compression – Compression format, VipsForeignHeifCompression.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ heifsave_target()

void VImage::heifsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image in heif format.

Optional parameters

Q – Q factor, int.
lossless – Enable lossless compression, bool.
compression – Compression format, VipsForeignHeifCompression.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ hist_cum()

VImage VImage::hist_cum ( VOption * options = 0 ) const

Form cumulative histogram.

Parameters

options Set of options.

Returns: Output image.

◆ hist_entropy()

double VImage::hist_entropy ( VOption * options = 0 ) const

Estimate image entropy.

Parameters

options Set of options.

Returns: Output value.

◆ hist_equal()

VImage VImage::hist_equal ( VOption * options = 0 ) const

Histogram equalisation.

Optional parameters

band – Equalise with this band, int.

Parameters

options Set of options.

Returns: Output image.

◆ hist_find()

VImage VImage::hist_find ( VOption * options = 0 ) const

Find image histogram.

Optional parameters

band – Find histogram of band, int.

Parameters

options Set of options.

Returns: Output histogram.

◆ hist_find_indexed()

VImage VImage::hist_find_indexed	(	VImage	index,
		VOption *	options = `0`
	)		const

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()

VImage VImage::hist_find_ndim ( VOption * options = 0 ) const

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()

bool VImage::hist_ismonotonic ( VOption * options = 0 ) const

Test for monotonicity.

Parameters

options Set of options.

Returns: true if in is monotonic.

◆ hist_local()

VImage VImage::hist_local	(	int	width,
		int	height,
		VOption *	options = `0`
	)		const

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()

VImage VImage::hist_match	(	VImage	ref,
		VOption *	options = `0`
	)		const

Match two histograms.

Parameters

ref	Reference histogram.
options	Set of options.

Returns: Output image.

◆ hist_norm()

VImage VImage::hist_norm ( VOption * options = 0 ) const

Normalise histogram.

Parameters

options Set of options.

Returns: Output image.

◆ hist_plot()

VImage VImage::hist_plot ( VOption * options = 0 ) const

Plot histogram.

Parameters

options Set of options.

Returns: Output image.

◆ hough_circle()

VImage VImage::hough_circle ( VOption * options = 0 ) const

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()

VImage VImage::hough_line ( VOption * options = 0 ) const

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()

VImage VImage::HSV2sRGB ( VOption * options = 0 ) const

Transform hsv to srgb.

Parameters

options Set of options.

Returns: Output image.

◆ icc_export()

VImage VImage::icc_export ( VOption * options = 0 ) const

Output to device with icc profile.

Optional parameters

pcs – Set Profile Connection Space, VipsPCS.
intent – Rendering intent, VipsIntent.
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()

VImage VImage::icc_import ( VOption * options = 0 ) const

Import from device with icc profile.

Optional parameters

pcs – Set Profile Connection Space, VipsPCS.
intent – Rendering intent, VipsIntent.
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()

VImage VImage::icc_transform	(	const char *	output_profile,
		VOption *	options = `0`
	)		const

Transform between devices with icc profiles.

Optional parameters

pcs – Set Profile Connection Space, VipsPCS.
intent – Rendering intent, VipsIntent.
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()

VImage VImage::identity ( VOption * options = 0 )

static

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()

VImage VImage::ifthenelse	(	VImage	in1,
		VImage	in2,
		VOption *	options = `0`
	)		const

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.

◆ insert()

VImage VImage::insert	(	VImage	sub,
		int	x,
		int	y,
		VOption *	options = `0`
	)		const

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.

◆ invert()

VImage VImage::invert ( VOption * options = 0 ) const

Invert an image.

Parameters

options Set of options.

Returns: Output image.

◆ invertlut()

VImage VImage::invertlut ( VOption * options = 0 ) const

Build an inverted look-up table.

Optional parameters

size – LUT size to generate, int.

Parameters

options Set of options.

Returns: Output image.

◆ invfft()

VImage VImage::invfft ( VOption * options = 0 ) const

Inverse fft.

Optional parameters

real – Output only the real part of the transform, bool.

Parameters

options Set of options.

Returns: Output image.

◆ join()

VImage VImage::join	(	VImage	in2,
		VipsDirection	direction,
		VOption *	options = `0`
	)		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.

◆ jpegload()

VImage VImage::jpegload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load jpeg from file.

Optional parameters

shrink – Shrink factor on load, int.
autorotate – Rotate image using exif orientation, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ jpegload_buffer()

VImage VImage::jpegload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load jpeg from buffer.

Optional parameters

shrink – Shrink factor on load, int.
autorotate – Rotate image using exif orientation, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ jpegload_source()

VImage VImage::jpegload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load image from jpeg source.

Optional parameters

shrink – Shrink factor on load, int.
autorotate – Rotate image using exif orientation, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ jpegsave()

void VImage::jpegsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to jpeg file.

Optional parameters

Q – Q factor, int.
profile – ICC profile to embed, const char *.
optimize_coding – Compute optimal Huffman coding tables, bool.
interlace – Generate an interlaced (progressive) jpeg, bool.
no_subsample – Disable chroma subsample, 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, VipsForeignJpegSubsample.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ jpegsave_buffer()

VipsBlob * VImage::jpegsave_buffer ( VOption * options = 0 ) const

Save image to jpeg buffer.

Optional parameters

Q – Q factor, int.
profile – ICC profile to embed, const char *.
optimize_coding – Compute optimal Huffman coding tables, bool.
interlace – Generate an interlaced (progressive) jpeg, bool.
no_subsample – Disable chroma subsample, 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, VipsForeignJpegSubsample.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ jpegsave_mime()

void VImage::jpegsave_mime ( VOption * options = 0 ) const

Save image to jpeg mime.

Optional parameters

Q – Q factor, int.
profile – ICC profile to embed, const char *.
optimize_coding – Compute optimal Huffman coding tables, bool.
interlace – Generate an interlaced (progressive) jpeg, bool.
no_subsample – Disable chroma subsample, 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, VipsForeignJpegSubsample.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

◆ jpegsave_target()

void VImage::jpegsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image to jpeg target.

Optional parameters

Q – Q factor, int.
profile – ICC profile to embed, const char *.
optimize_coding – Compute optimal Huffman coding tables, bool.
interlace – Generate an interlaced (progressive) jpeg, bool.
no_subsample – Disable chroma subsample, 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, VipsForeignJpegSubsample.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ Lab2LabQ()

VImage VImage::Lab2LabQ ( VOption * options = 0 ) const

Transform float lab to labq coding.

Parameters

options Set of options.

Returns: Output image.

◆ Lab2LabS()

VImage VImage::Lab2LabS ( VOption * options = 0 ) const

Transform float lab to signed short.

Parameters

options Set of options.

Returns: Output image.

◆ Lab2LCh()

VImage VImage::Lab2LCh ( VOption * options = 0 ) const

Transform lab to lch.

Parameters

options Set of options.

Returns: Output image.

◆ Lab2XYZ()

VImage VImage::Lab2XYZ ( VOption * options = 0 ) const

Transform cielab to xyz.

Optional parameters

temp – Color temperature, std::vector<double>.

Parameters

options Set of options.

Returns: Output image.

◆ labelregions()

VImage VImage::labelregions ( VOption * options = 0 ) const

Label regions in an image.

Parameters

options Set of options.

Returns: Mask of region labels.

◆ LabQ2Lab()

VImage VImage::LabQ2Lab ( VOption * options = 0 ) const

Unpack a labq image to float lab.

Parameters

options Set of options.

Returns: Output image.

◆ LabQ2LabS()

VImage VImage::LabQ2LabS ( VOption * options = 0 ) const

Unpack a labq image to short lab.

Parameters

options Set of options.

Returns: Output image.

◆ LabQ2sRGB()

VImage VImage::LabQ2sRGB ( VOption * options = 0 ) const

Convert a labq image to srgb.

Parameters

options Set of options.

Returns: Output image.

◆ LabS2Lab()

VImage VImage::LabS2Lab ( VOption * options = 0 ) const

Transform signed short lab to float.

Parameters

options Set of options.

Returns: Output image.

◆ LabS2LabQ()

VImage VImage::LabS2LabQ ( VOption * options = 0 ) const

Transform short lab to labq coding.

Parameters

options Set of options.

Returns: Output image.

◆ LCh2CMC()

VImage VImage::LCh2CMC ( VOption * options = 0 ) const

Transform lch to cmc.

Parameters

options Set of options.

Returns: Output image.

◆ LCh2Lab()

VImage VImage::LCh2Lab ( VOption * options = 0 ) const

Transform lch to lab.

Parameters

options Set of options.

Returns: Output image.

◆ linear()

VImage VImage::linear	(	std::vector< double >	a,
		std::vector< double >	b,
		VOption *	options = `0`
	)		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()

VImage VImage::linecache ( VOption * options = 0 ) const

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.

◆ logmat()

VImage VImage::logmat	(	double	sigma,
		double	min_ampl,
		VOption *	options = `0`
	)

static

Make a laplacian of gaussian image.

Optional parameters

separable – Generate separable Logmatian, bool.
integer – Generate integer Logmatian, bool.
precision – Generate with this precision, VipsPrecision.

Parameters

sigma	Radius of Logmatian.
min_ampl	Minimum amplitude of Logmatian.
options	Set of options.

Returns: Output image.

◆ magickload()

VImage VImage::magickload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load file with imagemagick.

Optional parameters

all_frames – Read all frames from an image, bool.
density – Canvas resolution for rendering vector formats like SVG, const char *.
page – Load this page from the file, int.
n – Load this many pages, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ magickload_buffer()

VImage VImage::magickload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load buffer with imagemagick.

Optional parameters

all_frames – Read all frames from an image, bool.
density – Canvas resolution for rendering vector formats like SVG, const char *.
page – Load this page from the file, int.
n – Load this many pages, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ magicksave()

void VImage::magicksave	(	const char *	filename,
		VOption *	options = `0`
	)		const

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.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ magicksave_buffer()

VipsBlob * VImage::magicksave_buffer ( VOption * options = 0 ) const

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.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ mapim()

VImage VImage::mapim	(	VImage	index,
		VOption *	options = `0`
	)		const

Resample with a map image.

Optional parameters

interpolate – Interpolate pixels with this, <unknown type>.

Parameters

index	Index pixels with this.
options	Set of options.

Returns: Output image.

◆ maplut()

VImage VImage::maplut	(	VImage	lut,
		VOption *	options = `0`
	)		const

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()

VImage VImage::mask_butterworth	(	int	width,
		int	height,
		double	order,
		double	frequency_cutoff,
		double	amplitude_cutoff,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_butterworth_band	(	int	width,
		int	height,
		double	order,
		double	frequency_cutoff_x,
		double	frequency_cutoff_y,
		double	radius,
		double	amplitude_cutoff,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_butterworth_ring	(	int	width,
		int	height,
		double	order,
		double	frequency_cutoff,
		double	amplitude_cutoff,
		double	ringwidth,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_fractal	(	int	width,
		int	height,
		double	fractal_dimension,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_gaussian	(	int	width,
		int	height,
		double	frequency_cutoff,
		double	amplitude_cutoff,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_gaussian_band	(	int	width,
		int	height,
		double	frequency_cutoff_x,
		double	frequency_cutoff_y,
		double	radius,
		double	amplitude_cutoff,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_gaussian_ring	(	int	width,
		int	height,
		double	frequency_cutoff,
		double	amplitude_cutoff,
		double	ringwidth,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_ideal	(	int	width,
		int	height,
		double	frequency_cutoff,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_ideal_band	(	int	width,
		int	height,
		double	frequency_cutoff_x,
		double	frequency_cutoff_y,
		double	radius,
		VOption *	options = `0`
	)

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()

VImage VImage::mask_ideal_ring	(	int	width,
		int	height,
		double	frequency_cutoff,
		double	ringwidth,
		VOption *	options = `0`
	)

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 = `0`
	)		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, <unknown type>.

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 = `0`
	)		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 = `0`
	)		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 = `0`
	)		const

Binary math operations with a constant.

Parameters

math2	math to perform.
c	Array of constants.
options	Set of options.

Returns: Output image.

◆ matload()

VImage VImage::matload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load mat from file.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ matrixinvert()

VImage VImage::matrixinvert ( VOption * options = 0 ) const

Invert an matrix.

Parameters

options Set of options.

Returns: Output matrix.

◆ matrixload()

VImage VImage::matrixload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load matrix.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ matrixload_source()

VImage VImage::matrixload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load matrix.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ matrixprint()

void VImage::matrixprint ( VOption * options = 0 ) const

Print matrix.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

◆ matrixsave()

void VImage::matrixsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to matrix.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ matrixsave_target()

void VImage::matrixsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image to matrix.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ max()

double VImage::max ( VOption * options = 0 ) const

Find image maximum.

Optional parameters

size – Number of maximum values to find, int.

Parameters

options Set of options.

Returns: Output value.

◆ measure()

VImage VImage::measure	(	int	h,
		int	v,
		VOption *	options = `0`
	)		const

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.

◆ merge()

VImage VImage::merge	(	VImage	sec,
		VipsDirection	direction,
		int	dx,
		int	dy,
		VOption *	options = `0`
	)		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()

double VImage::min ( VOption * options = 0 ) const

Find image minimum.

Optional parameters

size – Number of minimum values to find, int.

Parameters

options Set of options.

Returns: Output value.

◆ morph()

VImage VImage::morph	(	VImage	mask,
		VipsOperationMorphology	morph,
		VOption *	options = `0`
	)		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 = `0`
	)		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 = `0`
	)		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, <unknown type>.
mblend – Maximum blend size, int.
bandno – Band to search for features on, 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()

VImage VImage::msb ( VOption * options = 0 ) const

Pick most-significant byte from an image.

Optional parameters

band – Band to msb, int.

Parameters

options Set of options.

Returns: Output image.

◆ multiply()

VImage VImage::multiply	(	VImage	right,
		VOption *	options = `0`
	)		const

Multiply two images.

Parameters

right	Right-hand image argument.
options	Set of options.

Returns: Output image.

◆ niftiload()

VImage VImage::niftiload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load a nifti image.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ niftisave()

void VImage::niftisave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to nifti file.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ openexrload()

VImage VImage::openexrload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load an openexr image.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ openslideload()

VImage VImage::openslideload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load file with openslide.

Optional parameters

attach_associated – Attach all asssociated images, bool.
level – Load this level from the file, int.
autocrop – Crop to image bounds, bool.
associated – Load this associated image, const char *.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ pdfload()

VImage VImage::pdfload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load pdf from file.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
dpi – Render at this DPI, double.
scale – Scale output by this factor, double.
background – Background value, std::vector<double>.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ pdfload_buffer()

VImage VImage::pdfload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load pdf from buffer.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
dpi – Render at this DPI, double.
scale – Scale output by this factor, double.
background – Background value, std::vector<double>.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ pdfload_source()

VImage VImage::pdfload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load pdf from source.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
dpi – Render at this DPI, double.
scale – Scale output by this factor, double.
background – Background value, std::vector<double>.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ percent()

int VImage::percent	(	double	percent,
		VOption *	options = `0`
	)		const

Find threshold for percent of pixels.

Parameters

percent	Percent of pixels.
options	Set of options.

Returns: Threshold above which lie percent of pixels.

◆ perlin()

VImage VImage::perlin	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

Make a perlin noise image.

Optional parameters

cell_size – Size of Perlin cells, int.
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.

◆ phasecor()

VImage VImage::phasecor	(	VImage	in2,
		VOption *	options = `0`
	)		const

Calculate phase correlation.

Parameters

in2	Second input image.
options	Set of options.

Returns: Output image.

◆ pngload()

VImage VImage::pngload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load png from file.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ pngload_buffer()

VImage VImage::pngload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load png from buffer.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ pngload_source()

VImage VImage::pngload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load png from source.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ pngsave()

void VImage::pngsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to png file.

Optional parameters

compression – Compression factor, int.
interlace – Interlace image, bool.
profile – ICC profile to embed, const char *.
filter – libpng row filter flag(s), int.
palette – Quantise to 8bpp palette, bool.
colours – Max number of palette colours, int.
Q – Quantisation quality, int.
dither – Amount of dithering, double.
bitdepth – Write as a 1, 2, 4 or 8 bit image, int.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ pngsave_buffer()

VipsBlob * VImage::pngsave_buffer ( VOption * options = 0 ) const

Save image to png buffer.

Optional parameters

compression – Compression factor, int.
interlace – Interlace image, bool.
profile – ICC profile to embed, const char *.
filter – libpng row filter flag(s), int.
palette – Quantise to 8bpp palette, bool.
colours – Max number of palette colours, int.
Q – Quantisation quality, int.
dither – Amount of dithering, double.
bitdepth – Write as a 1, 2, 4 or 8 bit image, int.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ pngsave_target()

void VImage::pngsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image to target as png.

Optional parameters

compression – Compression factor, int.
interlace – Interlace image, bool.
profile – ICC profile to embed, const char *.
filter – libpng row filter flag(s), int.
palette – Quantise to 8bpp palette, bool.
colours – Max number of palette colours, int.
Q – Quantisation quality, int.
dither – Amount of dithering, double.
bitdepth – Write as a 1, 2, 4 or 8 bit image, int.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ ppmload()

VImage VImage::ppmload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load ppm from file.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ ppmload_source()

VImage VImage::ppmload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load ppm base class.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ ppmsave()

void VImage::ppmsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to ppm file.

Optional parameters

ascii – save as ascii, bool.
squash – save as one bit, bool.
bitdepth – Write as a 1 bit image, int.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ ppmsave_target()

void VImage::ppmsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save to ppm.

Optional parameters

ascii – save as ascii, bool.
squash – save as one bit, bool.
bitdepth – Write as a 1 bit image, int.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ premultiply()

VImage VImage::premultiply ( VOption * options = 0 ) const

Premultiply image alpha.

Optional parameters

max_alpha – Maximum value of alpha channel, double.

Parameters

options Set of options.

Returns: Output image.

◆ profile()

VImage VImage::profile	(	VImage *	rows,
		VOption *	options = `0`
	)		const

Find image profiles.

Parameters

rows	First non-zero pixel in row.
options	Set of options.

Returns: First non-zero pixel in column.

◆ profile_load()

VipsBlob * VImage::profile_load	(	const char *	name,
		VOption *	options = `0`
	)

static

Load named icc profile.

Parameters

name	Profile name.
options	Set of options.

Returns: Loaded profile.

◆ project()

VImage VImage::project	(	VImage *	rows,
		VOption *	options = `0`
	)		const

Find image projections.

Parameters

rows	Sums of rows.
options	Set of options.

Returns: Sums of columns.

◆ quadratic()

VImage VImage::quadratic	(	VImage	coeff,
		VOption *	options = `0`
	)		const

Resample an image with a quadratic transform.

Optional parameters

interpolate – Interpolate values with this, <unknown type>.

Parameters

coeff	Coefficient matrix.
options	Set of options.

Returns: Output image.

◆ rad2float()

VImage VImage::rad2float ( VOption * options = 0 ) const

Unpack radiance coding to float rgb.

Parameters

options Set of options.

Returns: Output image.

◆ radload()

VImage VImage::radload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load a radiance image from a file.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ radload_buffer()

VImage VImage::radload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load rad from buffer.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ radload_source()

VImage VImage::radload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load rad from source.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ radsave()

void VImage::radsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to radiance file.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ radsave_buffer()

VipsBlob * VImage::radsave_buffer ( VOption * options = 0 ) const

Save image to radiance buffer.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ radsave_target()

void VImage::radsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image to radiance target.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ rank()

VImage VImage::rank	(	int	width,
		int	height,
		int	index,
		VOption *	options = `0`
	)		const

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()

VImage VImage::rawload	(	const char *	filename,
		int	width,
		int	height,
		int	bands,
		VOption *	options = `0`
	)

static

Load raw data from a file.

Optional parameters

offset – Offset in bytes from start of file, <unknown type>.
format – Pixel format in image, VipsBandFormat.
interpretation – Pixel interpretation, VipsInterpretation.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, 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()

void VImage::rawsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to raw file.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ rawsave_fd()

void VImage::rawsave_fd	(	int	fd,
		VOption *	options = `0`
	)		const

Write raw image to file descriptor.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

fd	File descriptor to write to.
options	Set of options.

◆ recomb()

VImage VImage::recomb	(	VImage	m,
		VOption *	options = `0`
	)		const

Linear recombination with matrix.

Parameters

m	matrix of coefficients.
options	Set of options.

Returns: Output image.

◆ reduce()

VImage VImage::reduce	(	double	hshrink,
		double	vshrink,
		VOption *	options = `0`
	)		const

Reduce an image.

Optional parameters

kernel – Resampling kernel, VipsKernel.
centre – Use centre sampling convention, bool.

Parameters

hshrink	Horizontal shrink factor.
vshrink	Vertical shrink factor.
options	Set of options.

Returns: Output image.

◆ reduceh()

VImage VImage::reduceh	(	double	hshrink,
		VOption *	options = `0`
	)		const

Shrink an image horizontally.

Optional parameters

kernel – Resampling kernel, VipsKernel.
centre – Use centre sampling convention, bool.

Parameters

hshrink	Horizontal shrink factor.
options	Set of options.

Returns: Output image.

◆ reducev()

VImage VImage::reducev	(	double	vshrink,
		VOption *	options = `0`
	)		const

Shrink an image vertically.

Optional parameters

kernel – Resampling kernel, VipsKernel.
centre – Use centre sampling convention, bool.

Parameters

vshrink	Vertical shrink factor.
options	Set of options.

Returns: Output image.

◆ relational()

VImage VImage::relational	(	VImage	right,
		VipsOperationRelational	relational,
		VOption *	options = `0`
	)		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 = `0`
	)		const

Relational operations against a constant.

Parameters

relational	relational to perform.
c	Array of constants.
options	Set of options.

Returns: Output image.

◆ remainder()

VImage VImage::remainder	(	VImage	right,
		VOption *	options = `0`
	)		const

Remainder after integer division of two images.

Parameters

right	Right-hand image argument.
options	Set of options.

Returns: Output image.

◆ remainder_const()

VImage VImage::remainder_const	(	std::vector< double >	c,
		VOption *	options = `0`
	)		const

Remainder after integer division of an image and a constant.

Parameters

c	Array of constants.
options	Set of options.

Returns: Output image.

◆ replicate()

VImage VImage::replicate	(	int	across,
		int	down,
		VOption *	options = `0`
	)		const

Replicate an image.

Parameters

across	Repeat this many times horizontally.
down	Repeat this many times vertically.
options	Set of options.

Returns: Output image.

◆ resize()

VImage VImage::resize	(	double	scale,
		VOption *	options = `0`
	)		const

Resize an image.

Optional parameters

interpolate – Interpolate pixels with this, <unknown type>.
kernel – Resampling kernel, VipsKernel.
centre – Use centre sampling convention, bool.
vscale – Vertical scale image by this factor, double.
idx – Horizontal input displacement, double.
idy – Vertical input displacement, double.

Parameters

scale	Scale image by this factor.
options	Set of options.

Returns: Output image.

◆ rot()

VImage VImage::rot	(	VipsAngle	angle,
		VOption *	options = `0`
	)		const

Rotate an image.

Parameters

angle	Angle to rotate image.
options	Set of options.

Returns: Output image.

◆ rot45()

VImage VImage::rot45 ( VOption * options = 0 ) const

Rotate an image.

Optional parameters

angle – Angle to rotate image, VipsAngle45.

Parameters

options Set of options.

Returns: Output image.

◆ rotate()

VImage VImage::rotate	(	double	angle,
		VOption *	options = `0`
	)		const

Rotate an image by a number of degrees.

Optional parameters

interpolate – Interpolate pixels with this, <unknown type>.
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 anticlockwise by this many degrees.
options	Set of options.

Returns: Output image.

◆ round()

VImage VImage::round	(	VipsOperationRound	round,
		VOption *	options = `0`
	)		const

Perform a round function on an image.

Parameters

round	rounding operation to perform.
options	Set of options.

Returns: Output image.

◆ scale()

VImage VImage::scale ( VOption * options = 0 ) const

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.

◆ scRGB2BW()

VImage VImage::scRGB2BW ( VOption * options = 0 ) const

Convert scrgb to bw.

Optional parameters

depth – Output device space depth in bits, int.

Parameters

options Set of options.

Returns: Output image.

◆ scRGB2sRGB()

VImage VImage::scRGB2sRGB ( VOption * options = 0 ) const

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()

VImage VImage::scRGB2XYZ ( VOption * options = 0 ) const

Transform scrgb to xyz.

Parameters

options Set of options.

Returns: Output image.

◆ sequential()

VImage VImage::sequential ( VOption * options = 0 ) const

Check sequential access.

Optional parameters

trace – trace pixel requests, bool.
tile_height – Tile height in pixels, int.
access – Expected access pattern, VipsAccess.

Parameters

options Set of options.

Returns: Output image.

◆ sharpen()

VImage VImage::sharpen ( VOption * options = 0 ) const

Unsharp masking for print.

Optional parameters

radius – radius of Gaussian, int.
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()

VImage VImage::shrink	(	double	hshrink,
		double	vshrink,
		VOption *	options = `0`
	)		const

Shrink an image.

Parameters

hshrink	Horizontal shrink factor.
vshrink	Vertical shrink factor.
options	Set of options.

Returns: Output image.

◆ shrinkh()

VImage VImage::shrinkh	(	int	hshrink,
		VOption *	options = `0`
	)		const

Shrink an image horizontally.

Parameters

hshrink	Horizontal shrink factor.
options	Set of options.

Returns: Output image.

◆ shrinkv()

VImage VImage::shrinkv	(	int	vshrink,
		VOption *	options = `0`
	)		const

Shrink an image vertically.

Parameters

vshrink	Vertical shrink factor.
options	Set of options.

Returns: Output image.

◆ sign()

VImage VImage::sign ( VOption * options = 0 ) const

Unit vector of pixel.

Parameters

options Set of options.

Returns: Output image.

◆ similarity()

VImage VImage::similarity ( VOption * options = 0 ) const

Similarity transform of an image.

Optional parameters

scale – Scale by this factor, double.
angle – Rotate anticlockwise by this many degrees, double.
interpolate – Interpolate pixels with this, <unknown type>.
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.

◆ sines()

VImage VImage::sines	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

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.

◆ smartcrop()

VImage VImage::smartcrop	(	int	width,
		int	height,
		VOption *	options = `0`
	)		const

Extract an area from an image.

Optional parameters

interesting – How to measure interestingness, VipsInteresting.

Parameters

width	Width of extract area.
height	Height of extract area.
options	Set of options.

Returns: Output image.

◆ sobel()

VImage VImage::sobel ( VOption * options = 0 ) const

Sobel edge detector.

Parameters

options Set of options.

Returns: Output image.

◆ spcor()

VImage VImage::spcor	(	VImage	ref,
		VOption *	options = `0`
	)		const

Spatial correlation.

Parameters

ref	Input reference image.
options	Set of options.

Returns: Output image.

◆ spectrum()

VImage VImage::spectrum ( VOption * options = 0 ) const

Make displayable power spectrum.

Parameters

options Set of options.

Returns: Output image.

◆ sRGB2HSV()

VImage VImage::sRGB2HSV ( VOption * options = 0 ) const

Transform srgb to hsv.

Parameters

options Set of options.

Returns: Output image.

◆ sRGB2scRGB()

VImage VImage::sRGB2scRGB ( VOption * options = 0 ) const

Convert an srgb image to scrgb.

Parameters

options Set of options.

Returns: Output image.

◆ stats()

VImage VImage::stats ( VOption * options = 0 ) const

Find many image stats.

Parameters

options Set of options.

Returns: Output array of statistics.

◆ stdif()

VImage VImage::stdif	(	int	width,
		int	height,
		VOption *	options = `0`
	)		const

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()

VImage VImage::subsample	(	int	xfac,
		int	yfac,
		VOption *	options = `0`
	)		const

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()

VImage VImage::subtract	(	VImage	right,
		VOption *	options = `0`
	)		const

Subtract two images.

Parameters

right	Right-hand image argument.
options	Set of options.

Returns: Output image.

◆ sum()

VImage VImage::sum	(	std::vector< VImage >	in,
		VOption *	options = `0`
	)

static

Sum an array of images.

Parameters

in	Array of input images.
options	Set of options.

Returns: Output image.

◆ svgload()

VImage VImage::svgload	(	const char *	filename,
		VOption *	options = `0`
	)

static

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.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ svgload_buffer()

VImage VImage::svgload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

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.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ svgload_source()

VImage VImage::svgload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

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.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ switch_image()

VImage VImage::switch_image	(	std::vector< VImage >	tests,
		VOption *	options = `0`
	)

static

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()

void VImage::system	(	const char *	cmd_format,
		VOption *	options = `0`
	)

static

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.

◆ text()

VImage VImage::text	(	const char *	text,
		VOption *	options = `0`
	)

static

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.
dpi – DPI to render at, int.
justify – Justify lines, bool.
spacing – Line spacing, int.
fontfile – Load this font file, const char *.

Parameters

text	Text to render.
options	Set of options.

Returns: Output image.

◆ thumbnail()

VImage VImage::thumbnail	(	const char *	filename,
		int	width,
		VOption *	options = `0`
	)

static

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.
auto_rotate – Use orientation tags to rotate image upright, bool.

Parameters

filename	Filename to read from.
width	Size to this width.
options	Set of options.

Returns: Output image.

◆ thumbnail_buffer()

VImage VImage::thumbnail_buffer	(	VipsBlob *	buffer,
		int	width,
		VOption *	options = `0`
	)

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.
auto_rotate – Use orientation tags to rotate image upright, bool.

Parameters

buffer	Buffer to load from.
width	Size to this width.
options	Set of options.

Returns: Output image.

◆ thumbnail_image()

VImage VImage::thumbnail_image	(	int	width,
		VOption *	options = `0`
	)		const

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.
auto_rotate – Use orientation tags to rotate image upright, bool.

Parameters

width	Size to this width.
options	Set of options.

Returns: Output image.

◆ thumbnail_source()

VImage VImage::thumbnail_source	(	VSource	source,
		int	width,
		VOption *	options = `0`
	)

static

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.
auto_rotate – Use orientation tags to rotate image upright, bool.

Parameters

source	Source to load from.
width	Size to this width.
options	Set of options.

Returns: Output image.

◆ tiffload()

VImage VImage::tiffload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load tiff from file.

Optional parameters

page – Load this page from the image, int.
subifd – Select subifd index, int.
n – Load this many pages, int.
autorotate – Rotate image using orientation tag, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ tiffload_buffer()

VImage VImage::tiffload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load tiff from buffer.

Optional parameters

page – Load this page from the image, int.
subifd – Select subifd index, int.
n – Load this many pages, int.
autorotate – Rotate image using orientation tag, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ tiffload_source()

VImage VImage::tiffload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load tiff from source.

Optional parameters

page – Load this page from the image, int.
subifd – Select subifd index, int.
n – Load this many pages, int.
autorotate – Rotate image using orientation tag, bool.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ tiffsave()

void VImage::tiffsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to tiff file.

Optional parameters

compression – Compression for this file, VipsForeignTiffCompression.
Q – Q factor, int.
predictor – Compression prediction, VipsForeignTiffPredictor.
profile – ICC profile to embed, const char *.
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.
squash – Squash images down to 1 bit, 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.
rgbjpeg – Output RGB JPEG rather than YCbCr, bool.
properties – Write a properties document to IMAGEDESCRIPTION, bool.
region_shrink – Method to shrink regions, VipsRegionShrink.
level – ZSTD compression level, int.
subifd – Save pyr layers as sub-IFDs, bool.
lossless – Enable WEBP lossless mode, bool.
depth – Pyramid depth, VipsForeignDzDepth.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ tiffsave_buffer()

VipsBlob * VImage::tiffsave_buffer ( VOption * options = 0 ) const

Save image to tiff buffer.

Optional parameters

compression – Compression for this file, VipsForeignTiffCompression.
Q – Q factor, int.
predictor – Compression prediction, VipsForeignTiffPredictor.
profile – ICC profile to embed, const char *.
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.
squash – Squash images down to 1 bit, 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.
rgbjpeg – Output RGB JPEG rather than YCbCr, bool.
properties – Write a properties document to IMAGEDESCRIPTION, bool.
region_shrink – Method to shrink regions, VipsRegionShrink.
level – ZSTD compression level, int.
subifd – Save pyr layers as sub-IFDs, bool.
lossless – Enable WEBP lossless mode, bool.
depth – Pyramid depth, VipsForeignDzDepth.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ tilecache()

VImage VImage::tilecache ( VOption * options = 0 ) const

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()

VImage VImage::tonelut ( VOption * options = 0 )

static

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()

VImage VImage::transpose3d ( VOption * options = 0 ) const

Transpose3d an image.

Optional parameters

page_height – Height of each input page, int.

Parameters

options Set of options.

Returns: Output image.

◆ unpremultiply()

VImage VImage::unpremultiply ( VOption * options = 0 ) const

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()

VImage VImage::vipsload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load vips from file.

Optional parameters

memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ vipssave()

void VImage::vipssave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to vips file.

Optional parameters

strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ webpload()

VImage VImage::webpload	(	const char *	filename,
		VOption *	options = `0`
	)

static

Load webp from file.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
scale – Scale factor on load, double.
shrink – Shrink factor on load, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

filename	Filename to load from.
options	Set of options.

Returns: Output image.

◆ webpload_buffer()

VImage VImage::webpload_buffer	(	VipsBlob *	buffer,
		VOption *	options = `0`
	)

static

Load webp from buffer.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
scale – Scale factor on load, double.
shrink – Shrink factor on load, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

buffer	Buffer to load from.
options	Set of options.

Returns: Output image.

◆ webpload_source()

VImage VImage::webpload_source	(	VSource	source,
		VOption *	options = `0`
	)

static

Load webp from source.

Optional parameters

page – Load this page from the file, int.
n – Load this many pages, int.
scale – Scale factor on load, double.
shrink – Shrink factor on load, int.
memory – Force open via memory, bool.
access – Required access pattern for this file, VipsAccess.
sequential – Sequential read only, bool.
fail – Fail on first error, bool.
disc – Open to disc, bool.

Parameters

source	Source to load from.
options	Set of options.

Returns: Output image.

◆ webpsave()

void VImage::webpsave	(	const char *	filename,
		VOption *	options = `0`
	)		const

Save image to webp file.

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 minium size, bool.
kmin – Minimum number of frames between key frames, int.
kmax – Maximum number of frames between key frames, int.
reduction_effort – Level of CPU effort to reduce file size, int.
profile – ICC profile to embed, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

filename	Filename to save to.
options	Set of options.

◆ webpsave_buffer()

VipsBlob * VImage::webpsave_buffer ( VOption * options = 0 ) const

Save image to webp buffer.

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 minium size, bool.
kmin – Minimum number of frames between key frames, int.
kmax – Maximum number of frames between key frames, int.
reduction_effort – Level of CPU effort to reduce file size, int.
profile – ICC profile to embed, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

options Set of options.

Returns: Buffer to save to.

◆ webpsave_target()

void VImage::webpsave_target	(	VTarget	target,
		VOption *	options = `0`
	)		const

Save image to webp target.

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 minium size, bool.
kmin – Minimum number of frames between key frames, int.
kmax – Maximum number of frames between key frames, int.
reduction_effort – Level of CPU effort to reduce file size, int.
profile – ICC profile to embed, const char *.
strip – Strip all metadata from image, bool.
background – Background value, std::vector<double>.
page_height – Set page height for multipage save, int.

Parameters

target	Target to save to.
options	Set of options.

◆ worley()

VImage VImage::worley	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

Make a worley noise image.

Optional parameters

cell_size – Size of Worley cells, int.

Parameters

width	Image width in pixels.
height	Image height in pixels.
options	Set of options.

Returns: Output image.

◆ wrap()

VImage VImage::wrap ( VOption * options = 0 ) const

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.

◆ xyz()

VImage VImage::xyz	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

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()

VImage VImage::XYZ2CMYK ( VOption * options = 0 ) const

Transform xyz to cmyk.

Parameters

options Set of options.

Returns: Output image.

◆ XYZ2Lab()

VImage VImage::XYZ2Lab ( VOption * options = 0 ) const

Transform xyz to lab.

Optional parameters

temp – Colour temperature, std::vector<double>.

Parameters

options Set of options.

Returns: Output image.

◆ XYZ2scRGB()

VImage VImage::XYZ2scRGB ( VOption * options = 0 ) const

Transform xyz to scrgb.

Parameters

options Set of options.

Returns: Output image.

◆ XYZ2Yxy()

VImage VImage::XYZ2Yxy ( VOption * options = 0 ) const

Transform xyz to yxy.

Parameters

options Set of options.

Returns: Output image.

◆ Yxy2XYZ()

VImage VImage::Yxy2XYZ ( VOption * options = 0 ) const

Transform yxy to xyz.

Parameters

options Set of options.

Returns: Output image.

◆ zone()

VImage VImage::zone	(	int	width,
		int	height,
		VOption *	options = `0`
	)

static

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()

VImage VImage::zoom	(	int	xfac,
		int	yfac,
		VOption *	options = `0`
	)		const

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:

include/vips/VImage8.h
VImage.cpp
vips-operators.cpp

Public Member Functions

Static Public Member Functions

Friends

Member Function Documentation

◆ abs()

◆ add()

◆ affine()

◆ analyzeload()

◆ arrayjoin()

◆ autorot()

◆ avg()

◆ bandbool()

◆ bandfold()

◆ bandjoin()

◆ bandjoin_const()

◆ bandmean()

◆ bandrank()

◆ bandunfold()

◆ black()

◆ boolean()

◆ boolean_const()

◆ buildlut()

◆ byteswap()

◆ cache()

◆ canny()

◆ case_image()

◆ cast()

◆ CMC2LCh()

◆ CMYK2XYZ()

◆ colourspace()

◆ compass()

◆ complex()

◆ complex2()

◆ complexform()

◆ complexget()

◆ composite()

◆ composite2()

◆ conv()

◆ conva()

◆ convasep()

◆ convf()

◆ convi()

◆ convsep()

◆ copy()

◆ countlines()

◆ crop()

◆ csvload()

◆ csvload_source()

◆ csvsave()

◆ csvsave_target()

◆ dE00()

◆ dE76()

◆ dECMC()

◆ deviate()

◆ divide()

◆ draw_circle()

◆ draw_flood()

◆ draw_image()

◆ draw_line()

◆ draw_mask()

◆ draw_rect()

◆ draw_smudge()

◆ dzsave()

◆ dzsave_buffer()

◆ embed()

◆ extract_area()

◆ extract_band()

◆ eye()

◆ falsecolour()

◆ fastcor()

◆ fill_nearest()

◆ find_trim()

◆ fitsload()

◆ fitssave()

◆ flatten()

◆ flip()

◆ float2rad()

◆ fractsurf()

◆ freqmult()

◆ fwfft()