This class represents a Vips image object.
This module provides a binding for the vips image processing library version 8.7 and later, and requires PHP 7.4 and later.
Example<?php
use Jcupitt\Vips;
$im = Vips\Image::newFromFile($argv[1], ['access' => 'sequential']);
$im = $im->crop(100, 100, $im->width - 200, $im->height - 200);
$im = $im->reduce(1.0 / 0.9, 1.0 / 0.9, ['kernel' => 'linear']);
$mask = Vips\Image::newFromArray(
[[-1, -1, -1],
[-1, 16, -1],
[-1, -1, -1]], 8);
$im = $im->conv($mask);
$im->writeToFile($argv[2]);
?>
You'll need this in your composer.json:
"require": {
"jcupitt/vips" : "2.0.0"
}
And run with:
$ composer install
$ ./try1.php ~/pics/k2.jpg x.tif
This example loads a file, crops 100 pixels from every edge, reduces by 10% using a bilinear interpolator (the default is lanczos3), sharpens the image, and saves it back to disc again.
Reading this example line by line, we have:
$im = Vips\Image::newFromFile($argv[1], ['access' => 'sequential']);
Image::newFromFile can load any image file supported by vips. Almost all operations can be given an array of options as a final argument.
In this example, we will be accessing pixels top-to-bottom as we sweep through the image reading and writing, so sequential access mode is best for us. The default mode is random, this allows for full random access to image pixels, but is slower and needs more memory.
You can also load formatted images from strings or create images from PHP arrays.
See the main libvips documentation for a more detailed explaination.
The next line:
$im = $im->crop(100, 100, $im->width - 200, $im->height - 200);
Crops 100 pixels from every edge. You can access any vips image property directly as a PHP property. If the vips property name does not conform to PHP naming conventions, you can use something like $image->get('ipct-data').
Use $image->getFields() to get an array of all the possible field names.
Next we have:
$mask = Vips\Image::newFromArray(
[[-1, -1, -1],
[-1, 16, -1],
[-1, -1, -1]], 8);
$im = $im->conv($mask);
Image::newFromArray creates an image from an array constant. The 8 at the end sets the scale: the amount to divide the image by after integer convolution. See the libvips API docs for vips_conv() (the operation invoked by Image::conv) for details on the convolution operator. See Getting more help below.
Finally:
$im->writeToFile($argv[2]);
Image::writeToFile writes an image back to the filesystem. It can write any format supported by vips: the file type is set from the filename suffix. You can write formatted images to strings, and pixel values to arrays.
This binding lets you call the complete C API almost directly. You should consult the C docs for full details on the operations that are available and the arguments they take. There's a handy function list which summarises the operations in the library. You can use the vips command-line interface to get help as well, for example:
$ vips embed
embed an image in a larger image
usage:
embed in out x y width height
where:
in - Input image, input VipsImage
out - Output image, output VipsImage
x - Left edge of input in output, input gint
default: 0
min: -1000000000, max: 1000000000
y - Top edge of input in output, input gint
default: 0
min: -1000000000, max: 1000000000
width - Image width in pixels, input gint
default: 1
min: 1, max: 1000000000
height - Image height in pixels, input gint
default: 1
min: 1, max: 1000000000
optional arguments:
extend - How to generate the extra pixels, input VipsExtend
default: black
allowed: black, copy, repeat, mirror, white, background
background - Colour for background pixels, input VipsArrayDouble
operation flags: sequential-unbuffered
You can call this from PHP as:
$out = $in->embed($x, $y, $width, $height,
['extend' => 'copy', 'background' => [1, 2, 3]]);
'background' can also be a simple constant, such as 12, see below.
The vipsheader command-line program is an easy way to see all the properties of an image. For example:
$ vipsheader -a ~/pics/k2.jpg
/home/john/pics/k2.jpg: 1450x2048 uchar, 3 bands, srgb, jpegload
width: 1450
height: 2048
bands: 3
format: 0 - uchar
coding: 0 - none
interpretation: 22 - srgb
xoffset: 0
yoffset: 0
xres: 2.834646
yres: 2.834646
filename: "/home/john/pics/k2.jpg"
vips-loader: jpegload
jpeg-multiscan: 0
ipct-data: VIPS_TYPE_BLOB, data = 0x20f0010, length = 332
You can access any of these fields as PHP properties of the Image class. Use $image->get('ipct-data') for property names which are not valid under PHP syntax.
This binding has a __call() method and uses it to look up vips operations. For example, the libvips operation embed, which appears in C as vips_embed(), appears in PHP as Image::embed.
The operation's list of required arguments is searched and the first input image is set to the value of self. Operations which do not take an input image, such as Image::black, appear as static methods. The remainder of the arguments you supply in the function call are used to set the other required input arguments. If the final supplied argument is an array, it is used to set any optional input arguments. The result is the required output argument if there is only one result, or an array of values if the operation produces several results.
For example, Image::min, the vips operation that searches an image for the minimum value, has a large number of optional arguments. You can use it to find the minimum value like this:
$min_value = $image->min();
You can ask it to return the position of the minimum with x and y.
$result = $image->min(['x' => true, 'y' => true]);
$min_value = $result['out'];
$x_pos = $result['x'];
$y_pos = $result['y'];
Now x_pos and y_pos will have the coordinates of the minimum value. There's actually a convenience function for this, Image::minpos, see below.
You can also ask for the top n minimum, for example:
$result = $image->min(['size' => 10, 'x_array' => true, 'y_array' => true]);
$x_pos = $result['x_array'];
$y_pos = $result['y_array'];
Now x_pos and y_pos will be 10-element arrays.
Because operations are member functions and return the result image, you can chain them. For example, you can write:
$result_image = $image->real()->cos();
to calculate the cosine of the real part of a complex image.
libvips types are also automatically wrapped and unwrapped. The binding looks at the type of argument required by the operation and converts the value you supply, when it can. For example, Image::linear takes a VipsArrayDouble as an argument for the set of constants to use for multiplication. You can supply this value as an integer, a float, or some kind of compound object and it will be converted for you. You can write:
$result = $image->linear(1, 3);
$result = $image->linear(12.4, 13.9);
$result = $image->linear([1, 2, 3], [4, 5, 6]);
$result = $image->linear(1, [4, 5, 6]);
And so on. You can also use Image::add() and friends, see below.
It does a couple of more ambitious conversions. It will automatically convert to and from the various vips types, like VipsBlob and VipsArrayImage. For example, you can read the ICC profile out of an image like this:
$profile = $image->get('icc-profile-data');
and $profile will be a PHP string.
If an operation takes several input images, you can use a constant for all but one of them and the wrapper will expand the constant to an image for you. For example, Image::ifthenelse() uses a condition image to pick pixels between a then and an else image:
$result = $condition->ifthenelse($then_image, $else_image);
You can use a constant instead of either the then or the else parts and it will be expanded to an image for you. If you use a constant for both then and else, it will be expanded to match the condition image. For example:
$result = $condition->ifthenelse([0, 255, 0], [255, 0, 0]);
Will make an image where true pixels are green and false pixels are red.
This is useful for Image::bandjoin, the thing to join two or more images up bandwise. You can write:
$rgba = $rgb->bandjoin(255);
to append a constant 255 band to an image, perhaps to add an alpha channel. Of course you can also write:
$result = $image->bandjoin($image2);
$result = $image->bandjoin([image2, image3]);
$result = Image::bandjoin([image1, image2, image3]);
$result = $image->bandjoin([image2, 255]);
and so on.
Array accessImages can be treated as arrays of bands. You can write:
$result = $image[1];
to get band 1 from an image (green, in an RGB image).
You can assign to bands as well. You can write:
$image[1] = $other_image;
And band 1 will be replaced by all the bands in $other_image using bandjoin. Use no offset to mean append, use -1 to mean prepend:
$image[] = $other_image; // append bands from other
$image[-1] = $other_image; // prepend bands from other
You can use number and array constants as well, for example:
$image[] = 255; // append a constant 255
$image[1] = [1, 2, 3]; // swap band 1 for three constant bands
Finally, you can delete bands with unset:
unset($image[1]); // remove band 1
The wrapper spots errors from vips operations and throws Vips\Exception. You can catch it in the usual way.
Paint operations like Image::draw_circle and Image::draw_line modify their input image. This makes them hard to use with the rest of libvips: you need to be very careful about the order in which operations execute or you can get nasty crashes.
The wrapper spots operations of this type and makes a private copy of the image in memory before calling the operation. This stops crashes, but it does make it inefficient. If you draw 100 lines on an image, for example, you'll copy the image 100 times. The wrapper does make sure that memory is recycled where possible, so you won't have 100 copies in memory.
If you want to avoid the copies, you'll need to call drawing operations yourself.
ThumbnailingThe thumbnailing functionality is implemented by Vips\Image::thumbnail and Vips\Image::thumbnail_buffer (which thumbnails an image held as a string).
You could write:
$filename = 'image.jpg';
$image = Vips\Image::thumbnail($filename, 200, ['height' => 200]);
$image->writeToFile('my-thumbnail.jpg');
There are three types of operation in this section.
First, ->affine() applies an affine transform to an image. This is any sort of 2D transform which preserves straight lines; so any combination of stretch, sheer, rotate and translate. You supply an interpolator for it to use to generate pixels (@see Image::newInterpolator()). It will not produce good results for very large shrinks: you'll see aliasing.
->reduce() is like ->affine(), but it can only shrink images, it can't enlarge, rotate, or skew. It's very fast and uses an adaptive kernel (@see Kernel for possible values) for interpolation. It will be slow for very large shrink factors.
->shrink() is a fast block shrinker. It can quickly reduce images by large integer factors. It will give poor results for small size reductions: again, you'll see aliasing.
Next, ->resize() specialises in the common task of image reduce and enlarge. It strings together combinations of ->shrink(), ->reduce(), ->affine() and others to implement a general, high-quality image resizer.
Finally, ->mapim() can apply arbitrary 2D image transforms to an image.
Some vips operators take an enum to select an action, for example Image::math can be used to calculate sine of every pixel like this:
$result = $image->math('sin');
This is annoying, so the wrapper expands all these enums into separate members named after the enum. So you can write:
$result = $image->sin();
The wrapper defines a few extra useful utility functions: Image::get, Image::set, Image::bandsplit, Image::maxpos, Image::minpos, Image::median. See below.
Use Config::setLogger to enable logging in the usual manner. A sample logger, handy for debugging, is defined in Vips\DebugLogger. You can enable debug logging with:
Vips\Config::setLogger(new Vips\DebugLogger);
You can use the methods in Vips\Config to set various global properties of the library. For example, you can control the size of the libvips cache, or the size of the worker threadpools that libvips uses to evaluate images.
Images
John Cupitt jcupitt@gmail.com
2016 John Cupitt
https://opensource.org/licenses/MIT MIT
public int $bands
Number of bands in image
$coding ImageAutodoc.php : 0 public string $coding
Pixel coding @see Coding for possible values
$filename ImageAutodoc.php : 0 public string $filename
Image filename
$format ImageAutodoc.php : 0 public string $format
Pixel format in image @see BandFormat for possible values
$height ImageAutodoc.php : 0 public int $height
Image height in pixels
$interpretation ImageAutodoc.php : 0 public string $interpretation
Pixel interpretation @see Interpretation for possible values
$width ImageAutodoc.php : 0 public int $width
Image width in pixels
$xoffset ImageAutodoc.php : 0 public int $xoffset
Horizontal offset of origin
$xres ImageAutodoc.php : 0 public float $xres
Horizontal resolution in pixels/mm
$yoffset ImageAutodoc.php : 0 public int $yoffset
Vertical offset of origin
$yres ImageAutodoc.php : 0 public float $yres
Vertical resolution in pixels/mm
$check_max_stack_size GObject.php : 69libvips executes FFI callbacks off the main thread and this confuses the stack limit checks available since PHP 8.3.0. We need to check if `zend.max_allowed_stack_size` is set to `-1`.
private static bool $check_max_stack_size = true
See: https://github.com/libvips/php-vips/pull/237.
__call() Image.php : 1401Call any vips operation as an instance method.
public __call(string $name, array<string|int, mixed> $arguments) : mixed Parameters
The thing we call.
The arguments to the thing.
The result.
__callStatic() Image.php : 1416Call any vips operation as a class method.
public static __callStatic(string $name, array<string|int, mixed> $arguments) : mixed Parameters
The thing we call.
The arguments to the thing.
The result.
__clone() GObject.php : 93 public __clone() : mixed __construct() VipsObject.php : 69 public __construct(CData $pointer) : mixed Parameters
public __destruct() : mixed __get() Image.php : 1168
Get any property from the underlying image.
public __get(string $name) : mixed Parameters
The property name.
Check if the GType of a property from the underlying image exists.
public __isset(string $name) : bool Parameters
The property name.
Set any property on the underlying image.
public __set(string $name, mixed $value) : void Parameters
The property name.
The value to set for this property.
Makes a string-ified version of the Image.
public __toString() : string Return valuesstring abs() ImageAutodoc.php : 0 public abs([array<string|int, mixed> $options = = '[]' ]) : Image
Absolute value of an image.
ParametersReturn the inverse cosine of an image in degrees.
public acos() : Image Tags
A new image.
add() Image.php : 1585Add $other to this image.
public add(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The thing to add to this image.
An array of options to pass to the operation.
A new image.
addalpha() ImageAutodoc.php : 0 public addalpha([array<string|int, mixed> $options = = '[]' ]) : Image
Append an alpha channel.
Parameters public affine(array<string|int, float>|float $matrix[, array<string|int, mixed> $options = = '[]' ]) : Image
Affine transform of an image.
Parameters public static analyzeload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load an Analyze6 image.
ParametersBitwise AND of $this and $other. This has to be called ->andimage() rather than ->and() to avoid confusion in phpdoc.
public andimage(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
arrayjoin() ImageAutodoc.php : 0 public static arrayjoin(array<string|int, Image>|Image $in[, array<string|int, mixed> $options = = '[]' ]) : Image
Join an array of images.
ParametersReturn the inverse sine of an image in degrees.
public asin() : Image Tags
A new image.
atan() Image.php : 2358Return the inverse tangent of an image in degrees.
public atan() : Image Tags
A new image.
autorot() ImageAutodoc.php : 0 public autorot([array<string|int, mixed> $options = = '[]' ]) : Image
Autorotate image by exif tag.
Parameters public avg([array<string|int, mixed> $options = = '[]' ]) : float
Find image average.
ParametersAND image bands together.
public bandand() : Image Tags
A new image.
bandbool() ImageAutodoc.php : 0 public bandbool(string $boolean[, array<string|int, mixed> $options = = '[]' ]) : Image
Boolean operation across image bands.
ParametersEOR image bands together.
public bandeor() : Image Tags
A new image.
bandfold() ImageAutodoc.php : 0 public bandfold([array<string|int, mixed> $options = = '[]' ]) : Image
Fold up x axis into bands.
ParametersJoin $this and $other bandwise.
public bandjoin(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
bandjoin_const() ImageAutodoc.php : 0 public bandjoin_const(array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image
Append a constant band to an image.
Parameters public bandmean([array<string|int, mixed> $options = = '[]' ]) : Image
Band-wise average.
ParametersOR image bands together.
public bandor() : Image Tags
A new image.
bandrank() Image.php : 1999For each band element, sort the array of input images and pick the median. Use the index option to pick something else.
public bandrank(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
bandsplit() Image.php : 1977Split $this into an array of single-band images.
public bandsplit([array<string|int, mixed> $options = [] ]) : array<string|int, mixed> Parameters
An array of options to pass to the operation.
An array of images.
bandunfold() ImageAutodoc.php : 0 public bandunfold([array<string|int, mixed> $options = = '[]' ]) : Image
Unfold image bands into x axis.
Parameters public static black(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a black image.
Parameters public boolean(Image $right, string $boolean[, array<string|int, mixed> $options = = '[]' ]) : Image
Boolean operation on two images.
Parameters public boolean_const(string $boolean, array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image
Boolean operations against a constant.
Parameters public buildlut([array<string|int, mixed> $options = = '[]' ]) : Image
Build a look-up table.
Parameters public byteswap([array<string|int, mixed> $options = = '[]' ]) : Image
Byteswap an image.
Parameters public canny([array<string|int, mixed> $options = = '[]' ]) : Image
Canny edge detector.
Parameters public case(array<string|int, Image>|Image $cases[, array<string|int, mixed> $options = = '[]' ]) : Image
Use pixel values to pick cases from an array of images.
Parameters public cast(string $format[, array<string|int, mixed> $options = = '[]' ]) : Image
Cast an image.
ParametersReturn the smallest integral value not less than the argument.
public ceil() : Image Tags
A new image.
clamp() ImageAutodoc.php : 0 public clamp([array<string|int, mixed> $options = = '[]' ]) : Image
Clamp values of an image.
Parameters public CMC2LCh([array<string|int, mixed> $options = = '[]' ]) : Image
Transform LCh to CMC.
Parameters public CMYK2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image
Transform CMYK to XYZ.
Parameters public colourspace(string $space[, array<string|int, mixed> $options = = '[]' ]) : Image
Convert to a new colorspace.
Parameters public compass(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Convolve with rotating mask.
Parameters public complex(string $cmplx[, array<string|int, mixed> $options = = '[]' ]) : Image
Perform a complex operation on an image.
Parameters public complex2(Image $right, string $cmplx[, array<string|int, mixed> $options = = '[]' ]) : Image
Complex binary operations on two images.
Parameters public complexform(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Form a complex image from two real images.
Parameters public complexget(string $get[, array<string|int, mixed> $options = = '[]' ]) : Image
Get a component from a complex image.
ParametersComposite $other on top of $this with $mode.
public composite(mixed $other, BlendMode|array<string|int, mixed> $mode[, array<string|int, mixed> $options = [] ]) : Image Parameters
The overlay.
The mode to composite with.
An array of options to pass to the operation.
A new image.
composite2() ImageAutodoc.php : 0 public composite2(Image $overlay, string $mode[, array<string|int, mixed> $options = = '[]' ]) : Image
Blend a pair of images with a blend mode.
ParametersReturn the complex conjugate of an image.
public conj() : Image Tags
A new image.
conv() ImageAutodoc.php : 0 public conv(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Convolution operation.
Parameters public conva(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Approximate integer convolution.
Parameters public convasep(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Approximate separable integer convolution.
Parameters public convf(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Float convolution operation.
Parameters public convi(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Int convolution operation.
Parameters public convsep(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Separable convolution operation.
Parameters public copy([array<string|int, mixed> $options = = '[]' ]) : Image
Copy an image.
ParametersCopy to memory.
public copyMemory() : Image
An area of memory large enough to hold the complete image is allocated, the image is rendered into it, and a new Image is returned which wraps this memory area.
This is useful for ending a pipeline and starting a new random access one, but can obviously use a lot of memory if the image is large.
TagsA new Image.
cos() Image.php : 2310Return the cosine of an image in degrees.
public cos() : Image Tags
A new image.
countlines() ImageAutodoc.php : 0 public countlines(string $direction[, array<string|int, mixed> $options = = '[]' ]) : float
Count lines in an image.
Parameters public crop(int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Extract an area from an image.
ParametersFind the cross-phase of this image with $other.
public crossPhase(mixed $other) : Image Parameters
The thing to cross-phase by.
A new image.
csvload() ImageAutodoc.php : 0 public static csvload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load csv.
Parameters public static csvload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load csv.
Parameters public csvsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to csv.
Parameters public csvsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to csv.
Parameters public dE00(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Calculate dE00.
Parameters public dE76(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Calculate dE76.
Parameters public dECMC(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Calculate dECMC.
Parameters public deviate([array<string|int, mixed> $options = = '[]' ]) : float
Find image standard deviation.
ParametersDilate with a structuring element.
public dilate(mixed $mask) : Image Parameters
Dilate with this structuring element.
A new image.
divide() Image.php : 1645Divide this image by $other.
public divide(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The thing to divide this image by.
An array of options to pass to the operation.
A new image.
draw_circle() ImageAutodoc.php : 0 public draw_circle(array<string|int, float>|float $ink, int $cx, int $cy, int $radius[, array<string|int, mixed> $options = = '[]' ]) : Image
Draw a circle on an image.
Parameters public draw_flood(array<string|int, float>|float $ink, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image
Flood-fill an area.
Parameters public draw_image(Image $sub, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image
Paint an image into another image.
Parameters public draw_line(array<string|int, float>|float $ink, int $x1, int $y1, int $x2, int $y2[, array<string|int, mixed> $options = = '[]' ]) : Image
Draw a line on an image.
Parameters public draw_mask(array<string|int, float>|float $ink, Image $mask, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image
Draw a mask on an image.
Parameters public draw_rect(array<string|int, float>|float $ink, int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Paint a rectangle on an image.
Parameters public draw_smudge(int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Blur a rectangle on an image.
Parameters public dzsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to deepzoom file.
Parameters public dzsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image to dz buffer.
Parameters public dzsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to deepzoom target.
Parameters public embed(int $x, int $y, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Embed an image in a larger image.
ParametersBitwise EOR of $this and $other.
public eorimage(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
equal() Image.php : 1889255 where $this is equal to $other.
public equal(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
erode() Image.php : 2420Erode with a structuring element.
public erode(mixed $mask) : Image Parameters
Erode with this structuring element.
A new image.
exp() Image.php : 2394Return e ** pixel.
public exp() : Image Tags
A new image.
exp10() Image.php : 2406Return 10 ** pixel.
public exp10() : Image Tags
A new image.
ImageAutodoc.php : 0 public extract_area(int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Extract an area from an image.
Parameters public extract_band(int $band[, array<string|int, mixed> $options = = '[]' ]) : Image
Extract band from an image.
Parameters public static eye(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make an image showing the eye's spatial response.
Parameters public falsecolour([array<string|int, mixed> $options = = '[]' ]) : Image
False-color an image.
Parameters public fastcor(Image $ref[, array<string|int, mixed> $options = = '[]' ]) : Image
Fast correlation.
Parameters public fill_nearest([array<string|int, mixed> $options = = '[]' ]) : Image
Fill image zeros with nearest non-zero pixel.
Parameters public find_trim([array<string|int, mixed> $options = = '[]' ]) : array<string|int, mixed>
Search an image for non-edge areas. Return array with: [ 'left' => @type integer Left edge of image 'top' => @type integer Top edge of extract area 'width' => @type integer Width of extract area 'height' => @type integer Height of extract area ];
ParametersFind the name of the load operation vips will use to load a file, for example "VipsForeignLoadJpegFile". You can use this to work out what options to pass to newFromFile().
public static findLoad(string $filename) : string|null Parameters
The file to test.
The name of the load operation, or null.
findLoadBuffer() Image.php : 745Find the name of the load operation vips will use to load a buffer, for example 'VipsForeignLoadJpegBuffer'. You can use this to work out what options to pass to newFromBuffer().
public static findLoadBuffer(string $buffer) : string|null Parameters
The formatted image to test.
The name of the load operation, or null.
findLoadSource() Image.php : 922Find the name of the load operation vips will use to load a VipsSource, for example 'VipsForeignLoadJpegSource'. You can use this to work out what options to pass to newFromSource().
public static findLoadSource(Source $source) : string|null Parameters
The source to test
The name of the load operation, or null.
fitsload() ImageAutodoc.php : 0 public static fitsload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load a FITS image.
Parameters public static fitsload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load FITS from a source.
Parameters public fitssave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to fits file.
Parameters public flatten([array<string|int, mixed> $options = = '[]' ]) : Image
Flatten alpha out of an image.
Parameters public flip(string $direction[, array<string|int, mixed> $options = = '[]' ]) : Image
Flip an image.
ParametersFlip horizontally.
public fliphor() : Image Tags
A new image.
flipver() Image.php : 2472Flip vertically.
public flipver() : Image Tags
A new image.
float2rad() ImageAutodoc.php : 0 public float2rad([array<string|int, mixed> $options = = '[]' ]) : Image
Transform float RGB to Radiance coding.
ParametersReturn the largest integral value not greater than the argument.
public floor() : Image Tags
A new image.
fractsurf() ImageAutodoc.php : 0 public static fractsurf(int $width, int $height, float $fractal_dimension[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a fractal surface.
Parameters public freqmult(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image
Frequency-domain filtering.
Parameters public fwfft([array<string|int, mixed> $options = = '[]' ]) : Image
Forward FFT.
Parameters public gamma([array<string|int, mixed> $options = = '[]' ]) : Image
Gamma an image.
Parameters public gaussblur(float $sigma[, array<string|int, mixed> $options = = '[]' ]) : Image
Gaussian blur.
Parameters public static gaussmat(float $sigma, float $min_ampl[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a gaussian image.
Parameters public static gaussnoise(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a gaussnoise image.
ParametersGet any property from the underlying image.
public get(string $name) : mixed
This is handy for fields whose name does not match PHP's variable naming conventions, like 'exif-data'.
It will throw an exception if $name does not exist. Use Image::getType() to test for the existence of a field.
ParametersThe property name.
public getArgumentDescription(string $name) : string Parameters
public getBlurb(string $name) : string Parameters
public getDescription() : string Return valuesstring getFields() Image.php : 1256
Get the field names available for an image.
public getFields() : array<string|int, mixed> Return valuesarray<string|int, mixed> getpoint() ImageAutodoc.php : 0 public getpoint(int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, mixed>
Read a point from an image.
Parameters public getPspec(string $name) : CData|null Parameters
Get the GType of a property from the underlying image. GTypes are integer type identifiers. This function will return 0 if the field does not exist.
public getType(string $name) : int Parameters
The property name.
public static gifload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load GIF with libnsgif.
Parameters public static gifload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load GIF with libnsgif.
Parameters public static gifload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load gif from source.
Parameters public gifsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save as gif.
Parameters public gifsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save as gif.
Parameters public gifsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save as gif.
Parameters public globalbalance([array<string|int, mixed> $options = = '[]' ]) : Image
Global balance an image mosaic.
Parameters public gravity(string $direction, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Place an image within a larger image with a certain gravity.
Parameters public static grey(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a grey ramp image.
Parameters public grid(int $tile_height, int $across, int $down[, array<string|int, mixed> $options = = '[]' ]) : Image
Grid an image.
ParametersDoes this image have an alpha channel?
public hasAlpha() : bool
Uses colour space interpretation with number of channels to guess this.
Return valuesbool —indicating if this image has an alpha channel.
heifload() ImageAutodoc.php : 0 public static heifload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load a HEIF image.
Parameters public static heifload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load a HEIF image.
Parameters public static heifload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load a HEIF image.
Parameters public heifsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image in HEIF format.
Parameters public heifsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image in HEIF format.
Parameters public heifsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image in HEIF format.
Parameters public hist_cum([array<string|int, mixed> $options = = '[]' ]) : Image
Form cumulative histogram.
Parameters public hist_entropy([array<string|int, mixed> $options = = '[]' ]) : float
Estimate image entropy.
Parameters public hist_equal([array<string|int, mixed> $options = = '[]' ]) : Image
Histogram equalisation.
Parameters public hist_find([array<string|int, mixed> $options = = '[]' ]) : Image
Find image histogram.
Parameters public hist_find_indexed(Image $index[, array<string|int, mixed> $options = = '[]' ]) : Image
Find indexed image histogram.
Parameters public hist_find_ndim([array<string|int, mixed> $options = = '[]' ]) : Image
Find n-dimensional image histogram.
Parameters public hist_ismonotonic([array<string|int, mixed> $options = = '[]' ]) : bool
Test for monotonicity.
Parameters public hist_local(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Local histogram equalisation.
Parameters public hist_match(Image $ref[, array<string|int, mixed> $options = = '[]' ]) : Image
Match two histograms.
Parameters public hist_norm([array<string|int, mixed> $options = = '[]' ]) : Image
Normalise histogram.
Parameters public hist_plot([array<string|int, mixed> $options = = '[]' ]) : Image
Plot histogram.
Parameters public hough_circle([array<string|int, mixed> $options = = '[]' ]) : Image
Find hough circle transform.
Parameters public hough_line([array<string|int, mixed> $options = = '[]' ]) : Image
Find hough line transform.
Parameters public HSV2sRGB([array<string|int, mixed> $options = = '[]' ]) : Image
Transform HSV to sRGB.
Parameters public icc_export([array<string|int, mixed> $options = = '[]' ]) : Image
Output to device with ICC profile.
Parameters public icc_import([array<string|int, mixed> $options = = '[]' ]) : Image
Import from device with ICC profile.
Parameters public icc_transform(string $output_profile[, array<string|int, mixed> $options = = '[]' ]) : Image
Transform between devices with ICC profiles.
Parameters public static identity([array<string|int, mixed> $options = = '[]' ]) : Image
Make a 1D image where pixel values are indexes.
ParametersUse $this as a condition image to pick pixels from either $then or $else.
public ifthenelse(mixed $then, mixed $else[, array<string|int, mixed> $options = [] ]) : Image Parameters
The true side of the operator
The false side of the operator.
An array of options to pass to the operation.
A new image.
imag() Image.php : 2232Return the imaginary part of a complex image.
public imag() : Image Tags
A new image.
insert() ImageAutodoc.php : 0 public insert(Image $sub, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image
Insert image @sub into @main at @x, @y.
Parameters public invert([array<string|int, mixed> $options = = '[]' ]) : Image
Invert an image.
Parameters public invertlut([array<string|int, mixed> $options = = '[]' ]) : Image
Build an inverted look-up table.
Parameters public invfft([array<string|int, mixed> $options = = '[]' ]) : Image
Inverse FFT.
Parameters public join(Image $in2, string $direction[, array<string|int, mixed> $options = = '[]' ]) : Image
Join a pair of images.
Parameters public static jp2kload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load JPEG2000 image.
Parameters public static jp2kload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load JPEG2000 image.
Parameters public static jp2kload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load JPEG2000 image.
Parameters public jp2ksave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image in JPEG2000 format.
Parameters public jp2ksave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image in JPEG2000 format.
Parameters public jp2ksave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image in JPEG2000 format.
Parameters public static jpegload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load jpeg from file.
Parameters public static jpegload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load jpeg from buffer.
Parameters public static jpegload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load image from jpeg source.
Parameters public jpegsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to jpeg file.
Parameters public jpegsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image to jpeg buffer.
Parameters public jpegsave_mime([array<string|int, mixed> $options = = '[]' ]) : void
Save image to jpeg mime.
Parameters public jpegsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to jpeg target.
Parameters public static jxlload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load JPEG-XL image.
Parameters public static jxlload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load JPEG-XL image.
Parameters public static jxlload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load JPEG-XL image.
Parameters public jxlsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image in JPEG-XL format.
Parameters public jxlsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image in JPEG-XL format.
Parameters public jxlsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image in JPEG-XL format.
Parameters public Lab2LabQ([array<string|int, mixed> $options = = '[]' ]) : Image
Transform float Lab to LabQ coding.
Parameters public Lab2LabS([array<string|int, mixed> $options = = '[]' ]) : Image
Transform float Lab to signed short.
Parameters public Lab2LCh([array<string|int, mixed> $options = = '[]' ]) : Image
Transform Lab to LCh.
Parameters public Lab2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image
Transform CIELAB to XYZ.
Parameters public labelregions([array<string|int, mixed> $options = = '[]' ]) : Image
Label regions in an image.
Parameters public LabQ2Lab([array<string|int, mixed> $options = = '[]' ]) : Image
Unpack a LabQ image to float Lab.
Parameters public LabQ2LabS([array<string|int, mixed> $options = = '[]' ]) : Image
Unpack a LabQ image to short Lab.
Parameters public LabQ2sRGB([array<string|int, mixed> $options = = '[]' ]) : Image
Convert a LabQ image to sRGB.
Parameters public LabS2Lab([array<string|int, mixed> $options = = '[]' ]) : Image
Transform signed short Lab to float.
Parameters public LabS2LabQ([array<string|int, mixed> $options = = '[]' ]) : Image
Transform short Lab to LabQ coding.
Parameters public LCh2CMC([array<string|int, mixed> $options = = '[]' ]) : Image
Transform LCh to CMC.
Parameters public LCh2Lab([array<string|int, mixed> $options = = '[]' ]) : Image
Transform LCh to Lab.
Parameters255 where $this is less than $other.
public less(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
lessEq() Image.php : 1869255 where $this is less than or equal to $other.
public lessEq(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
linear() ImageAutodoc.php : 0 public linear(array<string|int, float>|float $a, array<string|int, float>|float $b[, array<string|int, mixed> $options = = '[]' ]) : Image
Calculate (a * in + b).
Parameters public linecache([array<string|int, mixed> $options = = '[]' ]) : Image
Cache an image as a set of lines.
ParametersReturn the natural log of an image.
public log() : Image Tags
A new image.
log10() Image.php : 2382Return the log base 10 of an image.
public log10() : Image Tags
A new image.
logmat() ImageAutodoc.php : 0 public static logmat(float $sigma, float $min_ampl[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a Laplacian of Gaussian image.
ParametersShift $this left by $other.
public lshift(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
magickload() ImageAutodoc.php : 0 public static magickload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load file with ImageMagick7.
Parameters public static magickload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load buffer with ImageMagick7.
Parameters public magicksave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save file with ImageMagick.
Parameters public magicksave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image to magick buffer.
Parameters public mapim(Image $index[, array<string|int, mixed> $options = = '[]' ]) : Image
Resample with a map image.
Parameters public maplut(Image $lut[, array<string|int, mixed> $options = = '[]' ]) : Image
Map an image though a lut.
Parameters public static mask_butterworth(int $width, int $height, float $order, float $frequency_cutoff, float $amplitude_cutoff[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a butterworth filter.
Parameters public static mask_butterworth_band(int $width, int $height, float $order, float $frequency_cutoff_x, float $frequency_cutoff_y, float $radius, float $amplitude_cutoff[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a butterworth_band filter.
Parameters public static mask_butterworth_ring(int $width, int $height, float $order, float $frequency_cutoff, float $amplitude_cutoff, float $ringwidth[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a butterworth ring filter.
Parameters public static mask_fractal(int $width, int $height, float $fractal_dimension[, array<string|int, mixed> $options = = '[]' ]) : Image
Make fractal filter.
Parameters public static mask_gaussian(int $width, int $height, float $frequency_cutoff, float $amplitude_cutoff[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a gaussian filter.
Parameters public static mask_gaussian_band(int $width, int $height, float $frequency_cutoff_x, float $frequency_cutoff_y, float $radius, float $amplitude_cutoff[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a gaussian filter.
Parameters public static mask_gaussian_ring(int $width, int $height, float $frequency_cutoff, float $amplitude_cutoff, float $ringwidth[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a gaussian ring filter.
Parameters public static mask_ideal(int $width, int $height, float $frequency_cutoff[, array<string|int, mixed> $options = = '[]' ]) : Image
Make an ideal filter.
Parameters public static mask_ideal_band(int $width, int $height, float $frequency_cutoff_x, float $frequency_cutoff_y, float $radius[, array<string|int, mixed> $options = = '[]' ]) : Image
Make an ideal band filter.
Parameters public static mask_ideal_ring(int $width, int $height, float $frequency_cutoff, float $ringwidth[, array<string|int, mixed> $options = = '[]' ]) : Image
Make an ideal ring filter.
Parameters public match(Image $sec, int $xr1, int $yr1, int $xs1, int $ys1, int $xr2, int $yr2, int $xs2, int $ys2[, array<string|int, mixed> $options = = '[]' ]) : Image
First-order match of two images.
Parameters public math(string $math[, array<string|int, mixed> $options = = '[]' ]) : Image
Apply a math operation to an image.
Parameters public math2(Image $right, string $math2[, array<string|int, mixed> $options = = '[]' ]) : Image
Binary math operations.
Parameters public math2_const(string $math2, array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image
Binary math operations with a constant.
Parameters public static matload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load mat from file.
Parameters public matrixinvert([array<string|int, mixed> $options = = '[]' ]) : Image
Invert a matrix.
Parameters public static matrixload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load matrix.
Parameters public static matrixload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load matrix.
Parameters public matrixmultiply(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Multiply two matrices.
Parameters public matrixprint([array<string|int, mixed> $options = = '[]' ]) : void
Print matrix.
Parameters public matrixsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to matrix.
Parameters public matrixsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to matrix.
Parameters public max([array<string|int, mixed> $options = = '[]' ]) : float
Find image maximum.
Parameters public maxpair(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Maximum of a pair of images.
ParametersPosition of max is awkward with plain self::max.
public maxpos() : array<string|int, mixed> Tags
(float, int, int) The value and position of the maximum.
measure() ImageAutodoc.php : 0 public measure(int $h, int $v[, array<string|int, mixed> $options = = '[]' ]) : Image
Measure a set of patches on a color chart.
Parameters$size x $size median filter.
public median(int $size) : Image Parameters
Size of median filter.
A new image.
merge() ImageAutodoc.php : 0 public merge(Image $sec, string $direction, int $dx, int $dy[, array<string|int, mixed> $options = = '[]' ]) : Image
Merge two images.
Parameters public min([array<string|int, mixed> $options = = '[]' ]) : float
Find image minimum.
Parameters public minpair(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image
Minimum of a pair of images.
ParametersPosition of min is awkward with plain self::max.
public minpos() : array<string|int, mixed> Tags
(float, int, int) The value and position of the minimum.
more() Image.php : 1809255 where $this is more than $other.
public more(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
moreEq() Image.php : 1829255 where $this is more than or equal to $other.
public moreEq(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
morph() ImageAutodoc.php : 0 public morph(Image $mask, string $morph[, array<string|int, mixed> $options = = '[]' ]) : Image
Morphology operation.
Parameters public mosaic(Image $sec, string $direction, int $xref, int $yref, int $xsec, int $ysec[, array<string|int, mixed> $options = = '[]' ]) : Image
Mosaic two images.
Parameters public mosaic1(Image $sec, string $direction, int $xr1, int $yr1, int $xs1, int $ys1, int $xr2, int $yr2, int $xs2, int $ys2[, array<string|int, mixed> $options = = '[]' ]) : Image
First-order mosaic of two images.
Parameters public msb([array<string|int, mixed> $options = = '[]' ]) : Image
Pick most-significant byte from an image.
ParametersMultiply this image by $other.
public multiply(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The thing to multiply this image by.
An array of options to pass to the operation.
A new image.
newFromArray() Image.php : 797Create a new Image from a php array.
public static newFromArray(array<string|int, mixed> $array[, float $scale = 1.0 ][, float $offset = 0.0 ]) : Image
2D arrays become 2D images. 1D arrays become 2D images with height 1.
ParametersThe array to make the image from.
The "scale" metadata item. Useful for integer convolution masks.
The "offset" metadata item. Useful for integer convolution masks.
A new Image.
newFromBuffer() Image.php : 763Create a new Image from a compressed image held as a string.
public static newFromBuffer(string $buffer[, string $string_options = '' ][, array<string|int, mixed> $options = [] ]) : Image Parameters
The formatted image to open.
Any text-style options to pass to the selected loader.
Options to pass on to the load operation.
A new Image.
newFromFile() Image.php : 715Create a new Image from a file on disc.
public static newFromFile(string $name[, array<string|int, mixed> $options = [] ]) : Image
See the main libvips documentation for a more detailed explaination.
ParametersThe file to open.
Any options to pass on to the load operation.
A new Image.
newFromImage() Image.php : 895Create a new image from a constant.
public newFromImage(mixed $value) : Image
The new image has the same width, height, format, interpretation, xres, yres, xoffset, yoffset as $this, but each pixel has the constant value $value.
Pass a single number to make a one-band image, pass an array of numbers to make an N-band image.
ParametersThe value to set each pixel to.
A new Image.
newFromMemory() Image.php : 843Wraps an Image around an area of memory containing a C-style array.
public static newFromMemory(mixed $data, int $width, int $height, int $bands, string $format) : Image Parameters
C-style array.
Image width in pixels.
Image height in pixels.
Number of bands.
Band format. (@see BandFormat)
A new Image.
newFromSource() Image.php : 932 public static newFromSource(Source $source[, string $string_options = '' ][, array<string|int, mixed> $options = [] ]) : self Parameters
Deprecated thing to make an interpolator.
public static newInterpolator(string $name) : Interpolate
See Interpolator::newFromName() for the new thing.
Parameters public static niftiload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load NIfTI volume.
Parameters public static niftiload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load NIfTI volumes.
Parameters public niftisave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to nifti file.
Parameters255 where $this is not equal to $other.
public notEq(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
offsetExists() Image.php : 1444Does band exist in image.
public offsetExists(mixed $offset) : bool Parameters
The index to fetch.
true if the index exists.
offsetGet() Image.php : 1458Get band from image.
public offsetGet(mixed $offset) : Image|null Parameters
The index to fetch.
the extracted band or null.
offsetSet() Image.php : 1488Set a band.
public offsetSet(int $offset, Image $value) : void
Use $image[1] = $other_image;' to remove band 1 from this image, replacing it with all the bands in $other_image`.
Use $image[] = $other_image;' to append all the bands in $other_imageto$image`.
Use $image[-1] = $other_image; to prepend all the bands in $other_image to $image.
You can use constants or arrays in place of $other_image. Use $image[] = 255; to append a constant 255 band, for example, or $image[1] = [1, 2]; to replace band 1 with two constant bands.
The index to set.
The band to insert
if the offset is not integer or null
Remove a band from an image.
public offsetUnset(int $offset) : void Parameters
The index to remove.
if there is only one band left in the image
public static openexrload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load an OpenEXR image.
Parameters public static openslideload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load file with OpenSlide.
Parameters public static openslideload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load source with OpenSlide.
ParametersBitwise OR of $this and $other.
public orimage(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
pdfload() ImageAutodoc.php : 0 public static pdfload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load PDF from file.
Parameters public static pdfload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load PDF from buffer.
Parameters public static pdfload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load PDF from source.
Parameters public percent(float $percent[, array<string|int, mixed> $options = = '[]' ]) : int
Find threshold for percent of pixels.
Parameters public static perlin(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a perlin noise image.
Parameters public phasecor(Image $in2[, array<string|int, mixed> $options = = '[]' ]) : Image
Calculate phase correlation.
Parameters public static pngload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load png from file.
Parameters public static pngload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load png from buffer.
Parameters public static pngload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load png from source.
Parameters public pngsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to file as PNG.
Parameters public pngsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image to buffer as PNG.
Parameters public pngsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to target as PNG.
ParametersReturn an image converted to polar coordinates.
public polar() : Image Tags
A new image.
pow() Image.php : 1691Find $this to the power of $other.
public pow(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
ppmload() ImageAutodoc.php : 0 public static ppmload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load ppm from file.
Parameters public static ppmload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load ppm from buffer.
Parameters public static ppmload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load ppm from source.
Parameters public ppmsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to ppm file.
Parameters public ppmsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save to ppm.
Parameters public premultiply([array<string|int, mixed> $options = = '[]' ]) : Image
Premultiply image alpha.
Parameters public prewitt([array<string|int, mixed> $options = = '[]' ]) : Image
Prewitt edge detector.
Parameters public static printAll() : void profile() ImageAutodoc.php : 0 public profile([array<string|int, mixed> $options = = '[]' ]) : array<string|int, mixed>
Find image profiles. Return array with: [ 'columns' => @type Image First non-zero pixel in column 'rows' => @type Image First non-zero pixel in row ];
Parameters public static profile_load(string $name[, array<string|int, mixed> $options = = '[]' ]) : string
Load named ICC profile.
Parameters public project([array<string|int, mixed> $options = = '[]' ]) : array<string|int, mixed>
Find image projections. Return array with: [ 'columns' => @type Image Sums of columns 'rows' => @type Image Sums of rows ];
Parameters public quadratic(Image $coeff[, array<string|int, mixed> $options = = '[]' ]) : Image
Resample an image with a quadratic transform.
Parameters public rad2float([array<string|int, mixed> $options = = '[]' ]) : Image
Unpack Radiance coding to float RGB.
Parameters public static radload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load a Radiance image from a file.
Parameters public static radload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load rad from buffer.
Parameters public static radload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load rad from source.
Parameters public radsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to Radiance file.
Parameters public radsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image to Radiance buffer.
Parameters public radsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to Radiance target.
Parameters public rank(int $width, int $height, int $index[, array<string|int, mixed> $options = = '[]' ]) : Image
Rank filter.
Parameters public static rawload(string $filename, int $width, int $height, int $bands[, array<string|int, mixed> $options = = '[]' ]) : Image
Load raw data from a file.
Parameters public rawsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to raw file.
Parameters public rawsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Write raw image to buffer.
Parameters public rawsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Write raw image to target.
ParametersReturn the real part of a complex image.
public real() : Image Tags
A new image.
recomb() ImageAutodoc.php : 0 public recomb(Image $m[, array<string|int, mixed> $options = = '[]' ]) : Image
Linear recombination with matrix.
ParametersReturn an image converted to rectangular coordinates.
public rect() : Image Tags
A new image.
reduce() ImageAutodoc.php : 0 public reduce(float $hshrink, float $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image
Reduce an image.
Parameters public reduceh(float $hshrink[, array<string|int, mixed> $options = = '[]' ]) : Image
Shrink an image horizontally.
Parameters public reducev(float $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image
Shrink an image vertically.
Parameters public ref() : void relational() ImageAutodoc.php : 0 public relational(Image $right, string $relational[, array<string|int, mixed> $options = = '[]' ]) : Image
Relational operation on two images.
Parameters public relational_const(string $relational, array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image
Relational operations against a constant.
ParametersRemainder of this image and $other.
public remainder(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The thing to take the remainder with.
An array of options to pass to the operation.
A new image.
remainder_const() ImageAutodoc.php : 0 public remainder_const(array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image
Remainder after integer division of an image and a constant.
Parameters public remosaic(string $old_str, string $new_str[, array<string|int, mixed> $options = = '[]' ]) : Image
Rebuild an mosaiced image.
ParametersRemove a field from the underlying image.
public remove(string $name) : void Parameters
The property name.
public replicate(int $across, int $down[, array<string|int, mixed> $options = = '[]' ]) : Image
Replicate an image.
Parameters public resize(float $scale[, array<string|int, mixed> $options = = '[]' ]) : Image
Resize an image.
ParametersReturn the nearest integral value.
public rint() : Image Tags
A new image.
rot() ImageAutodoc.php : 0 public rot(string $angle[, array<string|int, mixed> $options = = '[]' ]) : Image
Rotate an image.
ParametersRotate 180 degrees.
public rot180() : Image Tags
A new image.
rot270() Image.php : 2508Rotate 270 degrees clockwise.
public rot270() : Image Tags
A new image.
rot45() ImageAutodoc.php : 0 public rot45([array<string|int, mixed> $options = = '[]' ]) : Image
Rotate an image.
ParametersRotate 90 degrees clockwise.
public rot90() : Image Tags
A new image.
rotate() ImageAutodoc.php : 0 public rotate(float $angle[, array<string|int, mixed> $options = = '[]' ]) : Image
Rotate an image by a number of degrees.
Parameters public round(string $round[, array<string|int, mixed> $options = = '[]' ]) : Image
Perform a round function on an image.
ParametersShift $this right by $other.
public rshift(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
scale() ImageAutodoc.php : 0 public scale([array<string|int, mixed> $options = = '[]' ]) : Image
Scale an image to uchar.
Parameters public scharr([array<string|int, mixed> $options = = '[]' ]) : Image
Scharr edge detector.
Parameters public scRGB2BW([array<string|int, mixed> $options = = '[]' ]) : Image
Convert scRGB to BW.
Parameters public scRGB2sRGB([array<string|int, mixed> $options = = '[]' ]) : Image
Convert scRGB to sRGB.
Parameters public scRGB2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image
Transform scRGB to XYZ.
Parameters public static sdf(int $width, int $height, string $shape[, array<string|int, mixed> $options = = '[]' ]) : Image
Create an SDF image.
Parameters public sequential([array<string|int, mixed> $options = = '[]' ]) : Image
Check sequential access.
ParametersSet any property on the underlying image.
public set(string $name, mixed $value) : void
This is handy for fields whose name does not match PHP's variable naming conventions, like 'exif-data'.
The property name.
The value to set for this property.
Enable progress reporting on an image.
public setProgress(bool $progress) : void
The preeval, eval and posteval signals will be emitted on the most-downstream image for which setProgress() was enabled. @see GObject::signalConnect().
ParametersTRUE to enable progress reporting.
public setString(string $string_options) : bool Parameters
Set the type and value for any property on the underlying image.
public setType(string|int $type, string $name, mixed $value) : void
This is useful if the type of the property cannot be determined from the php type of the value.
Pass the type name directly, or use Utils::typeFromName() to look up types by name.
ParametersThe type of the property.
The property name.
The value to set for this property.
public sharpen([array<string|int, mixed> $options = = '[]' ]) : Image
Unsharp masking for print.
Parameters public shrink(float $hshrink, float $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image
Shrink an image.
Parameters public shrinkh(int $hshrink[, array<string|int, mixed> $options = = '[]' ]) : Image
Shrink an image horizontally.
Parameters public shrinkv(int $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image
Shrink an image vertically.
Parameters public sign([array<string|int, mixed> $options = = '[]' ]) : Image
Unit vector of pixel.
ParametersConnect to a signal on this object.
public signalConnect(string $name, callable $callback) : void
The callback will be triggered every time this signal is issued on this instance.
Parameters public similarity([array<string|int, mixed> $options = = '[]' ]) : Image
Similarity transform of an image.
ParametersReturn the sine of an image in degrees.
public sin() : Image Tags
A new image.
sines() ImageAutodoc.php : 0 public static sines(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a 2D sine wave.
Parameters public smartcrop(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Extract an area from an image.
Parameters public sobel([array<string|int, mixed> $options = = '[]' ]) : Image
Sobel edge detector.
Parameters public spcor(Image $ref[, array<string|int, mixed> $options = = '[]' ]) : Image
Spatial correlation.
Parameters public spectrum([array<string|int, mixed> $options = = '[]' ]) : Image
Make displayable power spectrum.
Parameters public sRGB2HSV([array<string|int, mixed> $options = = '[]' ]) : Image
Transform sRGB to HSV.
Parameters public sRGB2scRGB([array<string|int, mixed> $options = = '[]' ]) : Image
Convert an sRGB image to scRGB.
Parameters public stats([array<string|int, mixed> $options = = '[]' ]) : Image
Find many image stats.
Parameters public stdif(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Statistical difference.
Parameters public subsample(int $xfac, int $yfac[, array<string|int, mixed> $options = = '[]' ]) : Image
Subsample an image.
ParametersSubtract $other from this image.
public subtract(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The thing to subtract from this image.
An array of options to pass to the operation.
A new image.
sum() ImageAutodoc.php : 0 public static sum(array<string|int, Image>|Image $in[, array<string|int, mixed> $options = = '[]' ]) : Image
Sum an array of images.
Parameters public static svgload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load SVG with rsvg.
Parameters public static svgload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load SVG with rsvg.
Parameters public static svgload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load svg from source.
Parameters public static switch(array<string|int, Image>|Image $tests[, array<string|int, mixed> $options = = '[]' ]) : Image
Find the index of the first non-zero pixel in tests.
Parameters public static system(string $cmd_format[, array<string|int, mixed> $options = = '[]' ]) : void
Run an external command.
ParametersReturn the tangent of an image in degrees.
public tan() : Image Tags
A new image.
text() ImageAutodoc.php : 0 public static text(string $text[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a text image.
Parameters public static thumbnail(string $filename, int $width[, array<string|int, mixed> $options = = '[]' ]) : Image
Generate thumbnail from file.
Parameters public static thumbnail_buffer(string $buffer, int $width[, array<string|int, mixed> $options = = '[]' ]) : Image
Generate thumbnail from buffer.
Parameters public thumbnail_image(int $width[, array<string|int, mixed> $options = = '[]' ]) : Image
Generate thumbnail from image.
Parameters public static thumbnail_source(Source $source, int $width[, array<string|int, mixed> $options = = '[]' ]) : Image
Generate thumbnail from source.
Parameters public static tiffload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load tiff from file.
Parameters public static tiffload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load tiff from buffer.
Parameters public static tiffload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load tiff from source.
Parameters public tiffsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to tiff file.
Parameters public tiffsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save image to tiff buffer.
Parameters public tiffsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to tiff target.
Parameters public tilecache([array<string|int, mixed> $options = = '[]' ]) : Image
Cache an image as a set of tiles.
Parameters public static tonelut([array<string|int, mixed> $options = = '[]' ]) : Image
Build a look-up table.
Parameters public transpose3d([array<string|int, mixed> $options = = '[]' ]) : Image
Transpose3d an image.
ParametersA deprecated synonym for getType().
public typeOf(string $name) : int Parameters
The property name.
public unpremultiply([array<string|int, mixed> $options = = '[]' ]) : Image
Unpremultiply image alpha.
Parameters public unref() : void unrefOutputs() VipsObject.php : 194 public unrefOutputs() : void vipsload() ImageAutodoc.php : 0 public static vipsload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load vips from file.
Parameters public static vipsload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load vips from source.
Parameters public vipssave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to file in vips format.
Parameters public vipssave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save image to target in vips format.
Parameters public static webpload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image
Load webp from file.
Parameters public static webpload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image
Load webp from buffer.
Parameters public static webpload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image
Load webp from source.
Parameters public webpsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void
Save as WebP.
Parameters public webpsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string
Save as WebP.
Parameters public webpsave_mime([array<string|int, mixed> $options = = '[]' ]) : void
Save image to webp mime.
Parameters public webpsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void
Save as WebP.
ParametersFind $other to the power of $this.
public wop(mixed $other[, array<string|int, mixed> $options = [] ]) : Image Parameters
The right-hand side of the operator.
An array of options to pass to the operation.
A new image.
worley() ImageAutodoc.php : 0 public static worley(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a worley noise image.
Parameters public wrap([array<string|int, mixed> $options = = '[]' ]) : Image
Wrap image origin.
ParametersWrite an image to a PHP array.
public writeToArray() : array<string|int, mixed>
Pixels are written as a simple one-dimensional array, for example, if you write:
$result = $image->crop(100, 100, 10, 1)->writeToArray();
This will crop out 10 pixels and write them to the array. If $image is an RGB image, then $array will contain 30 numbers, with the first three being R, G and B for the first pixel.
You'll need to slice and repack the array if you want more dimensions.
This method is much faster than repeatedly calling getpoint(). It will use a lot of memory.
The pixel values as a PHP array.
writeToBuffer() Image.php : 993Write an image to a formatted string.
public writeToBuffer(string $suffix[, array<string|int, mixed> $options = [] ]) : string Parameters
The file type suffix, eg. ".jpg".
Any options to pass on to the selected save operation.
The formatted image.
writeToFile() Image.php : 959Write an image to a file.
public writeToFile(string $name[, array<string|int, mixed> $options = [] ]) : void Parameters
The file to write the image to.
Any options to pass on to the selected save operation.
Write an image to a large memory array.
public writeToMemory() : string Tags
The memory array.
writeToTarget() Image.php : 1117 public writeToTarget(Target $target, string $suffix[, array<string|int, mixed> $options = [] ]) : void Parameters
public static xyz(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make an image where pixel values are coordinates.
Parameters public XYZ2CMYK([array<string|int, mixed> $options = = '[]' ]) : Image
Transform XYZ to CMYK.
Parameters public XYZ2Lab([array<string|int, mixed> $options = = '[]' ]) : Image
Transform XYZ to Lab.
Parameters public XYZ2scRGB([array<string|int, mixed> $options = = '[]' ]) : Image
Transform XYZ to scRGB.
Parameters public XYZ2Yxy([array<string|int, mixed> $options = = '[]' ]) : Image
Transform XYZ to Yxy.
Parameters public Yxy2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image
Transform Yxy to XYZ.
Parameters public static zone(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image
Make a zone plate.
Parameters public zoom(int $xfac, int $yfac[, array<string|int, mixed> $options = = '[]' ]) : Image
Zoom an image.
Parameters private static getMarshaler(string $name, callable $callback) : Closure|null Parameters
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4