php-vips

ImageAutodoc extends VipsObject
in package

AbstractYes

Autodocs for the Image class.

Tags
category

Images

author

John Cupitt jcupitt@gmail.com

copyright

2016 John Cupitt

license

https://opensource.org/licenses/MIT MIT

link
https://github.com/jcupitt/php-vips

Table of Contents

Properties

$bands  : int
$coding  : string
$filename  : string
$format  : string
$height  : int
$interpretation  : string
$width  : int
$xoffset  : int
$xres  : float
$yoffset  : int
$yres  : float
$check_max_stack_size  : bool
libvips 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`.

Methods

__clone()  : mixed
__construct()  : mixed
__destruct()  : mixed
__get()  : mixed
__set()  : mixed
abs()  : Image
addalpha()  : Image
affine()  : Image
analyzeload()  : Image
arrayjoin()  : Image
autorot()  : Image
avg()  : float
bandbool()  : Image
bandfold()  : Image
bandjoin_const()  : Image
bandmean()  : Image
bandunfold()  : Image
black()  : Image
boolean()  : Image
boolean_const()  : Image
buildlut()  : Image
byteswap()  : Image
canny()  : Image
case()  : Image
cast()  : Image
clamp()  : Image
CMC2LCh()  : Image
CMYK2XYZ()  : Image
colourspace()  : Image
compass()  : Image
complex()  : Image
complex2()  : Image
complexform()  : Image
complexget()  : Image
composite2()  : Image
conv()  : Image
conva()  : Image
convasep()  : Image
convf()  : Image
convi()  : Image
convsep()  : Image
copy()  : Image
countlines()  : float
crop()  : Image
csvload()  : Image
csvload_source()  : Image
csvsave()  : void
csvsave_target()  : void
dE00()  : Image
dE76()  : Image
dECMC()  : Image
deviate()  : float
draw_circle()  : Image
draw_flood()  : Image
draw_image()  : Image
draw_line()  : Image
draw_mask()  : Image
draw_rect()  : Image
draw_smudge()  : Image
dzsave()  : void
dzsave_buffer()  : string
dzsave_target()  : void
embed()  : Image
extract_area()  : Image
extract_band()  : Image
eye()  : Image
falsecolour()  : Image
fastcor()  : Image
fill_nearest()  : Image
find_trim()  : array<string|int, mixed>
fitsload()  : Image
fitsload_source()  : Image
fitssave()  : void
flatten()  : Image
flip()  : Image
float2rad()  : Image
fractsurf()  : Image
freqmult()  : Image
fwfft()  : Image
gamma()  : Image
gaussblur()  : Image
gaussmat()  : Image
gaussnoise()  : Image
get()  : mixed
getArgumentDescription()  : string
getBlurb()  : string
getDescription()  : string
getpoint()  : array<string|int, mixed>
getPspec()  : CData|null
getType()  : int
gifload()  : Image
gifload_buffer()  : Image
gifload_source()  : Image
gifsave()  : void
gifsave_buffer()  : string
gifsave_target()  : void
globalbalance()  : Image
gravity()  : Image
grey()  : Image
grid()  : Image
heifload()  : Image
heifload_buffer()  : Image
heifload_source()  : Image
heifsave()  : void
heifsave_buffer()  : string
heifsave_target()  : void
hist_cum()  : Image
hist_entropy()  : float
hist_equal()  : Image
hist_find()  : Image
hist_find_indexed()  : Image
hist_find_ndim()  : Image
hist_ismonotonic()  : bool
hist_local()  : Image
hist_match()  : Image
hist_norm()  : Image
hist_plot()  : Image
hough_circle()  : Image
hough_line()  : Image
HSV2sRGB()  : Image
icc_export()  : Image
icc_import()  : Image
icc_transform()  : Image
identity()  : Image
insert()  : Image
invert()  : Image
invertlut()  : Image
invfft()  : Image
join()  : Image
jp2kload()  : Image
jp2kload_buffer()  : Image
jp2kload_source()  : Image
jp2ksave()  : void
jp2ksave_buffer()  : string
jp2ksave_target()  : void
jpegload()  : Image
jpegload_buffer()  : Image
jpegload_source()  : Image
jpegsave()  : void
jpegsave_buffer()  : string
jpegsave_mime()  : void
jpegsave_target()  : void
jxlload()  : Image
jxlload_buffer()  : Image
jxlload_source()  : Image
jxlsave()  : void
jxlsave_buffer()  : string
jxlsave_target()  : void
Lab2LabQ()  : Image
Lab2LabS()  : Image
Lab2LCh()  : Image
Lab2XYZ()  : Image
labelregions()  : Image
LabQ2Lab()  : Image
LabQ2LabS()  : Image
LabQ2sRGB()  : Image
LabS2Lab()  : Image
LabS2LabQ()  : Image
LCh2CMC()  : Image
LCh2Lab()  : Image
linear()  : Image
linecache()  : Image
logmat()  : Image
magickload()  : Image
magickload_buffer()  : Image
magicksave()  : void
magicksave_buffer()  : string
mapim()  : Image
maplut()  : Image
mask_butterworth()  : Image
mask_butterworth_band()  : Image
mask_butterworth_ring()  : Image
mask_fractal()  : Image
mask_gaussian()  : Image
mask_gaussian_band()  : Image
mask_gaussian_ring()  : Image
mask_ideal()  : Image
mask_ideal_band()  : Image
mask_ideal_ring()  : Image
match()  : Image
math()  : Image
math2()  : Image
math2_const()  : Image
matload()  : Image
matrixinvert()  : Image
matrixload()  : Image
matrixload_source()  : Image
matrixmultiply()  : Image
matrixprint()  : void
matrixsave()  : void
matrixsave_target()  : void
max()  : float
maxpair()  : Image
measure()  : Image
merge()  : Image
min()  : float
minpair()  : Image
morph()  : Image
mosaic()  : Image
mosaic1()  : Image
msb()  : Image
niftiload()  : Image
niftiload_source()  : Image
niftisave()  : void
openexrload()  : Image
openslideload()  : Image
openslideload_source()  : Image
pdfload()  : Image
pdfload_buffer()  : Image
pdfload_source()  : Image
percent()  : int
perlin()  : Image
phasecor()  : Image
pngload()  : Image
pngload_buffer()  : Image
pngload_source()  : Image
pngsave()  : void
pngsave_buffer()  : string
pngsave_target()  : void
ppmload()  : Image
ppmload_buffer()  : Image
ppmload_source()  : Image
ppmsave()  : void
ppmsave_target()  : void
premultiply()  : Image
prewitt()  : Image
printAll()  : void
profile()  : array<string|int, mixed>
profile_load()  : string
project()  : array<string|int, mixed>
quadratic()  : Image
rad2float()  : Image
radload()  : Image
radload_buffer()  : Image
radload_source()  : Image
radsave()  : void
radsave_buffer()  : string
radsave_target()  : void
rank()  : Image
rawload()  : Image
rawsave()  : void
rawsave_buffer()  : string
rawsave_target()  : void
recomb()  : Image
reduce()  : Image
reduceh()  : Image
reducev()  : Image
ref()  : void
relational()  : Image
relational_const()  : Image
remainder_const()  : Image
remosaic()  : Image
replicate()  : Image
resize()  : Image
rot()  : Image
rot45()  : Image
rotate()  : Image
round()  : Image
scale()  : Image
scharr()  : Image
scRGB2BW()  : Image
scRGB2sRGB()  : Image
scRGB2XYZ()  : Image
sdf()  : Image
sequential()  : Image
set()  : void
setString()  : bool
sharpen()  : Image
shrink()  : Image
shrinkh()  : Image
shrinkv()  : Image
sign()  : Image
signalConnect()  : void
Connect to a signal on this object.
similarity()  : Image
sines()  : Image
smartcrop()  : Image
sobel()  : Image
spcor()  : Image
spectrum()  : Image
sRGB2HSV()  : Image
sRGB2scRGB()  : Image
stats()  : Image
stdif()  : Image
subsample()  : Image
sum()  : Image
svgload()  : Image
svgload_buffer()  : Image
svgload_source()  : Image
switch()  : Image
system()  : void
text()  : Image
thumbnail()  : Image
thumbnail_buffer()  : Image
thumbnail_image()  : Image
thumbnail_source()  : Image
tiffload()  : Image
tiffload_buffer()  : Image
tiffload_source()  : Image
tiffsave()  : void
tiffsave_buffer()  : string
tiffsave_target()  : void
tilecache()  : Image
tonelut()  : Image
transpose3d()  : Image
unpremultiply()  : Image
unref()  : void
unrefOutputs()  : void
vipsload()  : Image
vipsload_source()  : Image
vipssave()  : void
vipssave_target()  : void
webpload()  : Image
webpload_buffer()  : Image
webpload_source()  : Image
webpsave()  : void
webpsave_buffer()  : string
webpsave_mime()  : void
webpsave_target()  : void
worley()  : Image
wrap()  : Image
xyz()  : Image
XYZ2CMYK()  : Image
XYZ2Lab()  : Image
XYZ2scRGB()  : Image
XYZ2Yxy()  : Image
Yxy2XYZ()  : Image
zone()  : Image
zoom()  : Image
getMarshaler()  : Closure|null

Properties

$coding

public string $coding

Pixel coding @see Coding for possible values

$format

public string $format

Pixel format in image @see BandFormat for possible values

$interpretation

public string $interpretation

Pixel interpretation @see Interpretation for possible values

$xres

public float $xres

Horizontal resolution in pixels/mm

$yres

public float $yres

Vertical resolution in pixels/mm

$check_max_stack_size

libvips 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.

Methods

__construct()

public __construct(CData $pointer) : mixed
Parameters
$pointer : CData

__destruct()

public __destruct() : mixed

__get()

public abstract __get(string $name) : mixed
Parameters
$name : string

__set()

public abstract __set(string $name, mixed $value) : mixed
Parameters
$name : string
$value : mixed

abs()

public abs([array<string|int, mixed> $options = = '[]' ]) : Image

Absolute value of an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

addalpha()

public addalpha([array<string|int, mixed> $options = = '[]' ]) : Image

Append an alpha channel.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

affine()

public affine(array<string|int, float>|float $matrix[, array<string|int, mixed> $options = = '[]' ]) : Image

Affine transform of an image.

Parameters
$matrix : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

analyzeload()

public static analyzeload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load an Analyze6 image.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

arrayjoin()

public static arrayjoin(array<string|int, Image>|Image $in[, array<string|int, mixed> $options = = '[]' ]) : Image

Join an array of images.

Parameters
$in : array<string|int, Image>|Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

autorot()

public autorot([array<string|int, mixed> $options = = '[]' ]) : Image

Autorotate image by exif tag.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

avg()

public avg([array<string|int, mixed> $options = = '[]' ]) : float

Find image average.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
float

bandbool()

public bandbool(string $boolean[, array<string|int, mixed> $options = = '[]' ]) : Image

Boolean operation across image bands.

Parameters
$boolean : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

bandfold()

public bandfold([array<string|int, mixed> $options = = '[]' ]) : Image

Fold up x axis into bands.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

bandjoin_const()

public bandjoin_const(array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image

Append a constant band to an image.

Parameters
$c : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

bandmean()

public bandmean([array<string|int, mixed> $options = = '[]' ]) : Image

Band-wise average.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

bandunfold()

public bandunfold([array<string|int, mixed> $options = = '[]' ]) : Image

Unfold image bands into x axis.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

black()

public static black(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a black image.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

boolean()

public boolean(Image $right, string $boolean[, array<string|int, mixed> $options = = '[]' ]) : Image

Boolean operation on two images.

Parameters
$right : Image
$boolean : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

boolean_const()

public boolean_const(string $boolean, array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image

Boolean operations against a constant.

Parameters
$boolean : string
$c : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

buildlut()

public buildlut([array<string|int, mixed> $options = = '[]' ]) : Image

Build a look-up table.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

byteswap()

public byteswap([array<string|int, mixed> $options = = '[]' ]) : Image

Byteswap an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

canny()

public canny([array<string|int, mixed> $options = = '[]' ]) : Image

Canny edge detector.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

case()

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
$cases : array<string|int, Image>|Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

cast()

public cast(string $format[, array<string|int, mixed> $options = = '[]' ]) : Image

Cast an image.

Parameters
$format : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

clamp()

public clamp([array<string|int, mixed> $options = = '[]' ]) : Image

Clamp values of an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

CMC2LCh()

public CMC2LCh([array<string|int, mixed> $options = = '[]' ]) : Image

Transform LCh to CMC.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

CMYK2XYZ()

public CMYK2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image

Transform CMYK to XYZ.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

colourspace()

public colourspace(string $space[, array<string|int, mixed> $options = = '[]' ]) : Image

Convert to a new colorspace.

Parameters
$space : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

compass()

public compass(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Convolve with rotating mask.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

complex()

public complex(string $cmplx[, array<string|int, mixed> $options = = '[]' ]) : Image

Perform a complex operation on an image.

Parameters
$cmplx : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

complex2()

public complex2(Image $right, string $cmplx[, array<string|int, mixed> $options = = '[]' ]) : Image

Complex binary operations on two images.

Parameters
$right : Image
$cmplx : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

complexform()

public complexform(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Form a complex image from two real images.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

complexget()

public complexget(string $get[, array<string|int, mixed> $options = = '[]' ]) : Image

Get a component from a complex image.

Parameters
$get : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

composite2()

public composite2(Image $overlay, string $mode[, array<string|int, mixed> $options = = '[]' ]) : Image

Blend a pair of images with a blend mode.

Parameters
$overlay : Image
$mode : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

conv()

public conv(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Convolution operation.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

conva()

public conva(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Approximate integer convolution.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

convasep()

public convasep(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Approximate separable integer convolution.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

convf()

public convf(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Float convolution operation.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

convi()

public convi(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Int convolution operation.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

convsep()

public convsep(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Separable convolution operation.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

copy()

public copy([array<string|int, mixed> $options = = '[]' ]) : Image

Copy an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

countlines()

public countlines(string $direction[, array<string|int, mixed> $options = = '[]' ]) : float

Count lines in an image.

Parameters
$direction : string
$options : array<string|int, mixed> = = '[]'
Return values
float

crop()

public crop(int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Extract an area from an image.

Parameters
$left : int
$top : int
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

csvload()

public static csvload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load csv.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

csvload_source()

public static csvload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load csv.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

csvsave()

public csvsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to csv.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

csvsave_target()

public csvsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to csv.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

dE00()

public dE00(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Calculate dE00.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

dE76()

public dE76(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Calculate dE76.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

dECMC()

public dECMC(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Calculate dECMC.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

deviate()

public deviate([array<string|int, mixed> $options = = '[]' ]) : float

Find image standard deviation.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
float

draw_circle()

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
$ink : array<string|int, float>|float
$cx : int
$cy : int
$radius : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

draw_flood()

public draw_flood(array<string|int, float>|float $ink, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image

Flood-fill an area.

Parameters
$ink : array<string|int, float>|float
$x : int
$y : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

draw_image()

public draw_image(Image $sub, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image

Paint an image into another image.

Parameters
$sub : Image
$x : int
$y : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

draw_line()

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
$ink : array<string|int, float>|float
$x1 : int
$y1 : int
$x2 : int
$y2 : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

draw_mask()

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
$ink : array<string|int, float>|float
$mask : Image
$x : int
$y : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

draw_rect()

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
$ink : array<string|int, float>|float
$left : int
$top : int
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

draw_smudge()

public draw_smudge(int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Blur a rectangle on an image.

Parameters
$left : int
$top : int
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

dzsave()

public dzsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to deepzoom file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

dzsave_buffer()

public dzsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image to dz buffer.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

dzsave_target()

public dzsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to deepzoom target.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

embed()

public embed(int $x, int $y, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Embed an image in a larger image.

Parameters
$x : int
$y : int
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

extract_area()

public extract_area(int $left, int $top, int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Extract an area from an image.

Parameters
$left : int
$top : int
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

extract_band()

public extract_band(int $band[, array<string|int, mixed> $options = = '[]' ]) : Image

Extract band from an image.

Parameters
$band : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

eye()

public static eye(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make an image showing the eye's spatial response.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

falsecolour()

public falsecolour([array<string|int, mixed> $options = = '[]' ]) : Image

False-color an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

fastcor()

public fastcor(Image $ref[, array<string|int, mixed> $options = = '[]' ]) : Image

Fast correlation.

Parameters
$ref : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

fill_nearest()

public fill_nearest([array<string|int, mixed> $options = = '[]' ]) : Image

Fill image zeros with nearest non-zero pixel.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

find_trim()

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 ];

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, mixed>

fitsload()

public static fitsload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load a FITS image.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

fitsload_source()

public static fitsload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load FITS from a source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

fitssave()

public fitssave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to fits file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

flatten()

public flatten([array<string|int, mixed> $options = = '[]' ]) : Image

Flatten alpha out of an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

flip()

public flip(string $direction[, array<string|int, mixed> $options = = '[]' ]) : Image

Flip an image.

Parameters
$direction : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

float2rad()

public float2rad([array<string|int, mixed> $options = = '[]' ]) : Image

Transform float RGB to Radiance coding.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

fractsurf()

public static fractsurf(int $width, int $height, float $fractal_dimension[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a fractal surface.

Parameters
$width : int
$height : int
$fractal_dimension : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

freqmult()

public freqmult(Image $mask[, array<string|int, mixed> $options = = '[]' ]) : Image

Frequency-domain filtering.

Parameters
$mask : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

fwfft()

public fwfft([array<string|int, mixed> $options = = '[]' ]) : Image

Forward FFT.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

gamma()

public gamma([array<string|int, mixed> $options = = '[]' ]) : Image

Gamma an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

gaussblur()

public gaussblur(float $sigma[, array<string|int, mixed> $options = = '[]' ]) : Image

Gaussian blur.

Parameters
$sigma : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

gaussmat()

public static gaussmat(float $sigma, float $min_ampl[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a gaussian image.

Parameters
$sigma : float
$min_ampl : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

gaussnoise()

public static gaussnoise(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a gaussnoise image.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

getArgumentDescription()

public getArgumentDescription(string $name) : string
Parameters
$name : string
Return values
string

getBlurb()

public getBlurb(string $name) : string
Parameters
$name : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getpoint()

public getpoint(int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, mixed>

Read a point from an image.

Parameters
$x : int
$y : int
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, mixed>

getPspec()

public getPspec(string $name) : CData|null
Parameters
$name : string
Return values
CData|null

getType()

public getType(string $name) : int
Parameters
$name : string
Return values
int

gifload()

public static gifload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load GIF with libnsgif.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

gifload_buffer()

public static gifload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load GIF with libnsgif.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

gifload_source()

public static gifload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load gif from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

gifsave()

public gifsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save as gif.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

gifsave_buffer()

public gifsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save as gif.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

gifsave_target()

public gifsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save as gif.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

globalbalance()

public globalbalance([array<string|int, mixed> $options = = '[]' ]) : Image

Global balance an image mosaic.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

gravity()

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
$direction : string
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

grey()

public static grey(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a grey ramp image.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

grid()

public grid(int $tile_height, int $across, int $down[, array<string|int, mixed> $options = = '[]' ]) : Image

Grid an image.

Parameters
$tile_height : int
$across : int
$down : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

heifload()

public static heifload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load a HEIF image.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

heifload_buffer()

public static heifload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load a HEIF image.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

heifload_source()

public static heifload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load a HEIF image.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

heifsave()

public heifsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image in HEIF format.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

heifsave_buffer()

public heifsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image in HEIF format.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

heifsave_target()

public heifsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image in HEIF format.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

hist_cum()

public hist_cum([array<string|int, mixed> $options = = '[]' ]) : Image

Form cumulative histogram.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_entropy()

public hist_entropy([array<string|int, mixed> $options = = '[]' ]) : float

Estimate image entropy.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
float

hist_equal()

public hist_equal([array<string|int, mixed> $options = = '[]' ]) : Image

Histogram equalisation.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_find()

public hist_find([array<string|int, mixed> $options = = '[]' ]) : Image

Find image histogram.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_find_indexed()

public hist_find_indexed(Image $index[, array<string|int, mixed> $options = = '[]' ]) : Image

Find indexed image histogram.

Parameters
$index : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_find_ndim()

public hist_find_ndim([array<string|int, mixed> $options = = '[]' ]) : Image

Find n-dimensional image histogram.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_ismonotonic()

public hist_ismonotonic([array<string|int, mixed> $options = = '[]' ]) : bool

Test for monotonicity.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
bool

hist_local()

public hist_local(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Local histogram equalisation.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_match()

public hist_match(Image $ref[, array<string|int, mixed> $options = = '[]' ]) : Image

Match two histograms.

Parameters
$ref : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_norm()

public hist_norm([array<string|int, mixed> $options = = '[]' ]) : Image

Normalise histogram.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hist_plot()

public hist_plot([array<string|int, mixed> $options = = '[]' ]) : Image

Plot histogram.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hough_circle()

public hough_circle([array<string|int, mixed> $options = = '[]' ]) : Image

Find hough circle transform.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

hough_line()

public hough_line([array<string|int, mixed> $options = = '[]' ]) : Image

Find hough line transform.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

HSV2sRGB()

public HSV2sRGB([array<string|int, mixed> $options = = '[]' ]) : Image

Transform HSV to sRGB.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

icc_export()

public icc_export([array<string|int, mixed> $options = = '[]' ]) : Image

Output to device with ICC profile.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

icc_import()

public icc_import([array<string|int, mixed> $options = = '[]' ]) : Image

Import from device with ICC profile.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

icc_transform()

public icc_transform(string $output_profile[, array<string|int, mixed> $options = = '[]' ]) : Image

Transform between devices with ICC profiles.

Parameters
$output_profile : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

identity()

public static identity([array<string|int, mixed> $options = = '[]' ]) : Image

Make a 1D image where pixel values are indexes.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

insert()

public insert(Image $sub, int $x, int $y[, array<string|int, mixed> $options = = '[]' ]) : Image

Insert image @sub into @main at @x, @y.

Parameters
$sub : Image
$x : int
$y : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

invert()

public invert([array<string|int, mixed> $options = = '[]' ]) : Image

Invert an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

invertlut()

public invertlut([array<string|int, mixed> $options = = '[]' ]) : Image

Build an inverted look-up table.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

invfft()

public invfft([array<string|int, mixed> $options = = '[]' ]) : Image

Inverse FFT.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

join()

public join(Image $in2, string $direction[, array<string|int, mixed> $options = = '[]' ]) : Image

Join a pair of images.

Parameters
$in2 : Image
$direction : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jp2kload()

public static jp2kload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load JPEG2000 image.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jp2kload_buffer()

public static jp2kload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load JPEG2000 image.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jp2kload_source()

public static jp2kload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load JPEG2000 image.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

jp2ksave()

public jp2ksave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image in JPEG2000 format.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

jp2ksave_buffer()

public jp2ksave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image in JPEG2000 format.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

jp2ksave_target()

public jp2ksave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image in JPEG2000 format.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

jpegload()

public static jpegload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load jpeg from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jpegload_buffer()

public static jpegload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load jpeg from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jpegload_source()

public static jpegload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load image from jpeg source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

jpegsave()

public jpegsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to jpeg file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

jpegsave_buffer()

public jpegsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image to jpeg buffer.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

jpegsave_mime()

public jpegsave_mime([array<string|int, mixed> $options = = '[]' ]) : void

Save image to jpeg mime.

Parameters
$options : array<string|int, mixed> = = '[]'

jpegsave_target()

public jpegsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to jpeg target.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

jxlload()

public static jxlload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load JPEG-XL image.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jxlload_buffer()

public static jxlload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load JPEG-XL image.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

jxlload_source()

public static jxlload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load JPEG-XL image.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

jxlsave()

public jxlsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image in JPEG-XL format.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

jxlsave_buffer()

public jxlsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image in JPEG-XL format.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

jxlsave_target()

public jxlsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image in JPEG-XL format.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

Lab2LabQ()

public Lab2LabQ([array<string|int, mixed> $options = = '[]' ]) : Image

Transform float Lab to LabQ coding.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

Lab2LabS()

public Lab2LabS([array<string|int, mixed> $options = = '[]' ]) : Image

Transform float Lab to signed short.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

Lab2LCh()

public Lab2LCh([array<string|int, mixed> $options = = '[]' ]) : Image

Transform Lab to LCh.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

Lab2XYZ()

public Lab2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image

Transform CIELAB to XYZ.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

labelregions()

public labelregions([array<string|int, mixed> $options = = '[]' ]) : Image

Label regions in an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LabQ2Lab()

public LabQ2Lab([array<string|int, mixed> $options = = '[]' ]) : Image

Unpack a LabQ image to float Lab.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LabQ2LabS()

public LabQ2LabS([array<string|int, mixed> $options = = '[]' ]) : Image

Unpack a LabQ image to short Lab.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LabQ2sRGB()

public LabQ2sRGB([array<string|int, mixed> $options = = '[]' ]) : Image

Convert a LabQ image to sRGB.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LabS2Lab()

public LabS2Lab([array<string|int, mixed> $options = = '[]' ]) : Image

Transform signed short Lab to float.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LabS2LabQ()

public LabS2LabQ([array<string|int, mixed> $options = = '[]' ]) : Image

Transform short Lab to LabQ coding.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LCh2CMC()

public LCh2CMC([array<string|int, mixed> $options = = '[]' ]) : Image

Transform LCh to CMC.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

LCh2Lab()

public LCh2Lab([array<string|int, mixed> $options = = '[]' ]) : Image

Transform LCh to Lab.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

linear()

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
$a : array<string|int, float>|float
$b : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

linecache()

public linecache([array<string|int, mixed> $options = = '[]' ]) : Image

Cache an image as a set of lines.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

logmat()

public static logmat(float $sigma, float $min_ampl[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a Laplacian of Gaussian image.

Parameters
$sigma : float
$min_ampl : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

magickload()

public static magickload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load file with ImageMagick7.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

magickload_buffer()

public static magickload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load buffer with ImageMagick7.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

magicksave()

public magicksave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save file with ImageMagick.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

magicksave_buffer()

public magicksave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image to magick buffer.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

mapim()

public mapim(Image $index[, array<string|int, mixed> $options = = '[]' ]) : Image

Resample with a map image.

Parameters
$index : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

maplut()

public maplut(Image $lut[, array<string|int, mixed> $options = = '[]' ]) : Image

Map an image though a lut.

Parameters
$lut : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_butterworth()

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
$width : int
$height : int
$order : float
$frequency_cutoff : float
$amplitude_cutoff : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_butterworth_band()

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
$width : int
$height : int
$order : float
$frequency_cutoff_x : float
$frequency_cutoff_y : float
$radius : float
$amplitude_cutoff : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_butterworth_ring()

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
$width : int
$height : int
$order : float
$frequency_cutoff : float
$amplitude_cutoff : float
$ringwidth : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_fractal()

public static mask_fractal(int $width, int $height, float $fractal_dimension[, array<string|int, mixed> $options = = '[]' ]) : Image

Make fractal filter.

Parameters
$width : int
$height : int
$fractal_dimension : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_gaussian()

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
$width : int
$height : int
$frequency_cutoff : float
$amplitude_cutoff : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_gaussian_band()

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
$width : int
$height : int
$frequency_cutoff_x : float
$frequency_cutoff_y : float
$radius : float
$amplitude_cutoff : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_gaussian_ring()

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
$width : int
$height : int
$frequency_cutoff : float
$amplitude_cutoff : float
$ringwidth : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_ideal()

public static mask_ideal(int $width, int $height, float $frequency_cutoff[, array<string|int, mixed> $options = = '[]' ]) : Image

Make an ideal filter.

Parameters
$width : int
$height : int
$frequency_cutoff : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_ideal_band()

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
$width : int
$height : int
$frequency_cutoff_x : float
$frequency_cutoff_y : float
$radius : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

mask_ideal_ring()

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
$width : int
$height : int
$frequency_cutoff : float
$ringwidth : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

match()

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
$sec : Image
$xr1 : int
$yr1 : int
$xs1 : int
$ys1 : int
$xr2 : int
$yr2 : int
$xs2 : int
$ys2 : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

math()

public math(string $math[, array<string|int, mixed> $options = = '[]' ]) : Image

Apply a math operation to an image.

Parameters
$math : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

math2()

public math2(Image $right, string $math2[, array<string|int, mixed> $options = = '[]' ]) : Image

Binary math operations.

Parameters
$right : Image
$math2 : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

math2_const()

public math2_const(string $math2, array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image

Binary math operations with a constant.

Parameters
$math2 : string
$c : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

matload()

public static matload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load mat from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

matrixinvert()

public matrixinvert([array<string|int, mixed> $options = = '[]' ]) : Image

Invert a matrix.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

matrixload()

public static matrixload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load matrix.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

matrixload_source()

public static matrixload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load matrix.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

matrixmultiply()

public matrixmultiply(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Multiply two matrices.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

matrixprint()

public matrixprint([array<string|int, mixed> $options = = '[]' ]) : void

Print matrix.

Parameters
$options : array<string|int, mixed> = = '[]'

matrixsave()

public matrixsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to matrix.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

matrixsave_target()

public matrixsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to matrix.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

max()

public max([array<string|int, mixed> $options = = '[]' ]) : float

Find image maximum.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
float

maxpair()

public maxpair(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Maximum of a pair of images.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

measure()

public measure(int $h, int $v[, array<string|int, mixed> $options = = '[]' ]) : Image

Measure a set of patches on a color chart.

Parameters
$h : int
$v : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

merge()

public merge(Image $sec, string $direction, int $dx, int $dy[, array<string|int, mixed> $options = = '[]' ]) : Image

Merge two images.

Parameters
$sec : Image
$direction : string
$dx : int
$dy : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

min()

public min([array<string|int, mixed> $options = = '[]' ]) : float

Find image minimum.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
float

minpair()

public minpair(Image $right[, array<string|int, mixed> $options = = '[]' ]) : Image

Minimum of a pair of images.

Parameters
$right : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

morph()

public morph(Image $mask, string $morph[, array<string|int, mixed> $options = = '[]' ]) : Image

Morphology operation.

Parameters
$mask : Image
$morph : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

mosaic()

public mosaic(Image $sec, string $direction, int $xref, int $yref, int $xsec, int $ysec[, array<string|int, mixed> $options = = '[]' ]) : Image

Mosaic two images.

Parameters
$sec : Image
$direction : string
$xref : int
$yref : int
$xsec : int
$ysec : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

mosaic1()

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
$sec : Image
$direction : string
$xr1 : int
$yr1 : int
$xs1 : int
$ys1 : int
$xr2 : int
$yr2 : int
$xs2 : int
$ys2 : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

msb()

public msb([array<string|int, mixed> $options = = '[]' ]) : Image

Pick most-significant byte from an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

niftiload()

public static niftiload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load NIfTI volume.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

niftiload_source()

public static niftiload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load NIfTI volumes.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

niftisave()

public niftisave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to nifti file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

openexrload()

public static openexrload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load an OpenEXR image.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

openslideload()

public static openslideload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load file with OpenSlide.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

openslideload_source()

public static openslideload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load source with OpenSlide.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

pdfload()

public static pdfload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load PDF from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

pdfload_buffer()

public static pdfload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load PDF from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

pdfload_source()

public static pdfload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load PDF from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

percent()

public percent(float $percent[, array<string|int, mixed> $options = = '[]' ]) : int

Find threshold for percent of pixels.

Parameters
$percent : float
$options : array<string|int, mixed> = = '[]'
Return values
int

perlin()

public static perlin(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a perlin noise image.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

phasecor()

public phasecor(Image $in2[, array<string|int, mixed> $options = = '[]' ]) : Image

Calculate phase correlation.

Parameters
$in2 : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

pngload()

public static pngload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load png from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

pngload_buffer()

public static pngload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load png from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

pngload_source()

public static pngload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load png from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

pngsave()

public pngsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to file as PNG.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

pngsave_buffer()

public pngsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image to buffer as PNG.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

pngsave_target()

public pngsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to target as PNG.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

ppmload()

public static ppmload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load ppm from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

ppmload_buffer()

public static ppmload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load ppm from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

ppmload_source()

public static ppmload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load ppm from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

ppmsave()

public ppmsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to ppm file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

ppmsave_target()

public ppmsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save to ppm.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

premultiply()

public premultiply([array<string|int, mixed> $options = = '[]' ]) : Image

Premultiply image alpha.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

prewitt()

public prewitt([array<string|int, mixed> $options = = '[]' ]) : Image

Prewitt edge detector.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

profile()

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
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, mixed>

profile_load()

public static profile_load(string $name[, array<string|int, mixed> $options = = '[]' ]) : string

Load named ICC profile.

Parameters
$name : string
$options : array<string|int, mixed> = = '[]'
Return values
string

project()

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
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, mixed>

quadratic()

public quadratic(Image $coeff[, array<string|int, mixed> $options = = '[]' ]) : Image

Resample an image with a quadratic transform.

Parameters
$coeff : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

rad2float()

public rad2float([array<string|int, mixed> $options = = '[]' ]) : Image

Unpack Radiance coding to float RGB.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

radload()

public static radload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load a Radiance image from a file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

radload_buffer()

public static radload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load rad from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

radload_source()

public static radload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load rad from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

radsave()

public radsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to Radiance file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

radsave_buffer()

public radsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image to Radiance buffer.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

radsave_target()

public radsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to Radiance target.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

rank()

public rank(int $width, int $height, int $index[, array<string|int, mixed> $options = = '[]' ]) : Image

Rank filter.

Parameters
$width : int
$height : int
$index : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

rawload()

public static rawload(string $filename, int $width, int $height, int $bands[, array<string|int, mixed> $options = = '[]' ]) : Image

Load raw data from a file.

Parameters
$filename : string
$width : int
$height : int
$bands : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

rawsave()

public rawsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to raw file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

rawsave_buffer()

public rawsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Write raw image to buffer.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

rawsave_target()

public rawsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Write raw image to target.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

recomb()

public recomb(Image $m[, array<string|int, mixed> $options = = '[]' ]) : Image

Linear recombination with matrix.

Parameters
$m : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

reduce()

public reduce(float $hshrink, float $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image

Reduce an image.

Parameters
$hshrink : float
$vshrink : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

reduceh()

public reduceh(float $hshrink[, array<string|int, mixed> $options = = '[]' ]) : Image

Shrink an image horizontally.

Parameters
$hshrink : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

reducev()

public reducev(float $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image

Shrink an image vertically.

Parameters
$vshrink : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

relational()

public relational(Image $right, string $relational[, array<string|int, mixed> $options = = '[]' ]) : Image

Relational operation on two images.

Parameters
$right : Image
$relational : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

relational_const()

public relational_const(string $relational, array<string|int, float>|float $c[, array<string|int, mixed> $options = = '[]' ]) : Image

Relational operations against a constant.

Parameters
$relational : string
$c : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

remainder_const()

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
$c : array<string|int, float>|float
$options : array<string|int, mixed> = = '[]'
Return values
Image

remosaic()

public remosaic(string $old_str, string $new_str[, array<string|int, mixed> $options = = '[]' ]) : Image

Rebuild an mosaiced image.

Parameters
$old_str : string
$new_str : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

replicate()

public replicate(int $across, int $down[, array<string|int, mixed> $options = = '[]' ]) : Image

Replicate an image.

Parameters
$across : int
$down : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

resize()

public resize(float $scale[, array<string|int, mixed> $options = = '[]' ]) : Image

Resize an image.

Parameters
$scale : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

rot()

public rot(string $angle[, array<string|int, mixed> $options = = '[]' ]) : Image

Rotate an image.

Parameters
$angle : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

rot45()

public rot45([array<string|int, mixed> $options = = '[]' ]) : Image

Rotate an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

rotate()

public rotate(float $angle[, array<string|int, mixed> $options = = '[]' ]) : Image

Rotate an image by a number of degrees.

Parameters
$angle : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

round()

public round(string $round[, array<string|int, mixed> $options = = '[]' ]) : Image

Perform a round function on an image.

Parameters
$round : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

scale()

public scale([array<string|int, mixed> $options = = '[]' ]) : Image

Scale an image to uchar.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

scharr()

public scharr([array<string|int, mixed> $options = = '[]' ]) : Image

Scharr edge detector.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

scRGB2BW()

public scRGB2BW([array<string|int, mixed> $options = = '[]' ]) : Image

Convert scRGB to BW.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

scRGB2sRGB()

public scRGB2sRGB([array<string|int, mixed> $options = = '[]' ]) : Image

Convert scRGB to sRGB.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

scRGB2XYZ()

public scRGB2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image

Transform scRGB to XYZ.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

sdf()

public static sdf(int $width, int $height, string $shape[, array<string|int, mixed> $options = = '[]' ]) : Image

Create an SDF image.

Parameters
$width : int
$height : int
$shape : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

sequential()

public sequential([array<string|int, mixed> $options = = '[]' ]) : Image

Check sequential access.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

set()

public set(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed
Tags
throws
Exception

setString()

public setString(string $string_options) : bool
Parameters
$string_options : string
Return values
bool

sharpen()

public sharpen([array<string|int, mixed> $options = = '[]' ]) : Image

Unsharp masking for print.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

shrink()

public shrink(float $hshrink, float $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image

Shrink an image.

Parameters
$hshrink : float
$vshrink : float
$options : array<string|int, mixed> = = '[]'
Return values
Image

shrinkh()

public shrinkh(int $hshrink[, array<string|int, mixed> $options = = '[]' ]) : Image

Shrink an image horizontally.

Parameters
$hshrink : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

shrinkv()

public shrinkv(int $vshrink[, array<string|int, mixed> $options = = '[]' ]) : Image

Shrink an image vertically.

Parameters
$vshrink : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

sign()

public sign([array<string|int, mixed> $options = = '[]' ]) : Image

Unit vector of pixel.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

signalConnect()

Connect 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
$name : string
$callback : callable
Tags
throws
Exception

similarity()

public similarity([array<string|int, mixed> $options = = '[]' ]) : Image

Similarity transform of an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

sines()

public static sines(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a 2D sine wave.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

smartcrop()

public smartcrop(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Extract an area from an image.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

sobel()

public sobel([array<string|int, mixed> $options = = '[]' ]) : Image

Sobel edge detector.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

spcor()

public spcor(Image $ref[, array<string|int, mixed> $options = = '[]' ]) : Image

Spatial correlation.

Parameters
$ref : Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

spectrum()

public spectrum([array<string|int, mixed> $options = = '[]' ]) : Image

Make displayable power spectrum.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

sRGB2HSV()

public sRGB2HSV([array<string|int, mixed> $options = = '[]' ]) : Image

Transform sRGB to HSV.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

sRGB2scRGB()

public sRGB2scRGB([array<string|int, mixed> $options = = '[]' ]) : Image

Convert an sRGB image to scRGB.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

stats()

public stats([array<string|int, mixed> $options = = '[]' ]) : Image

Find many image stats.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

stdif()

public stdif(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Statistical difference.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

subsample()

public subsample(int $xfac, int $yfac[, array<string|int, mixed> $options = = '[]' ]) : Image

Subsample an image.

Parameters
$xfac : int
$yfac : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

sum()

public static sum(array<string|int, Image>|Image $in[, array<string|int, mixed> $options = = '[]' ]) : Image

Sum an array of images.

Parameters
$in : array<string|int, Image>|Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

svgload()

public static svgload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load SVG with rsvg.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

svgload_buffer()

public static svgload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load SVG with rsvg.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

svgload_source()

public static svgload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load svg from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

switch()

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
$tests : array<string|int, Image>|Image
$options : array<string|int, mixed> = = '[]'
Return values
Image

system()

public static system(string $cmd_format[, array<string|int, mixed> $options = = '[]' ]) : void

Run an external command.

Parameters
$cmd_format : string
$options : array<string|int, mixed> = = '[]'

text()

public static text(string $text[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a text image.

Parameters
$text : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

thumbnail()

public static thumbnail(string $filename, int $width[, array<string|int, mixed> $options = = '[]' ]) : Image

Generate thumbnail from file.

Parameters
$filename : string
$width : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

thumbnail_buffer()

public static thumbnail_buffer(string $buffer, int $width[, array<string|int, mixed> $options = = '[]' ]) : Image

Generate thumbnail from buffer.

Parameters
$buffer : string
$width : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

thumbnail_image()

public thumbnail_image(int $width[, array<string|int, mixed> $options = = '[]' ]) : Image

Generate thumbnail from image.

Parameters
$width : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

thumbnail_source()

public static thumbnail_source(Source $source, int $width[, array<string|int, mixed> $options = = '[]' ]) : Image

Generate thumbnail from source.

Parameters
$source : Source
$width : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

tiffload()

public static tiffload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load tiff from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

tiffload_buffer()

public static tiffload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load tiff from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

tiffload_source()

public static tiffload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load tiff from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

tiffsave()

public tiffsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to tiff file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

tiffsave_buffer()

public tiffsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save image to tiff buffer.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

tiffsave_target()

public tiffsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to tiff target.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

tilecache()

public tilecache([array<string|int, mixed> $options = = '[]' ]) : Image

Cache an image as a set of tiles.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

tonelut()

public static tonelut([array<string|int, mixed> $options = = '[]' ]) : Image

Build a look-up table.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

transpose3d()

public transpose3d([array<string|int, mixed> $options = = '[]' ]) : Image

Transpose3d an image.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

unpremultiply()

public unpremultiply([array<string|int, mixed> $options = = '[]' ]) : Image

Unpremultiply image alpha.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

vipsload()

public static vipsload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load vips from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

vipsload_source()

public static vipsload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load vips from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

vipssave()

public vipssave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to file in vips format.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

vipssave_target()

public vipssave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save image to target in vips format.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

webpload()

public static webpload(string $filename[, array<string|int, mixed> $options = = '[]' ]) : Image

Load webp from file.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

webpload_buffer()

public static webpload_buffer(string $buffer[, array<string|int, mixed> $options = = '[]' ]) : Image

Load webp from buffer.

Parameters
$buffer : string
$options : array<string|int, mixed> = = '[]'
Return values
Image

webpload_source()

public static webpload_source(Source $source[, array<string|int, mixed> $options = = '[]' ]) : Image

Load webp from source.

Parameters
$source : Source
$options : array<string|int, mixed> = = '[]'
Return values
Image

webpsave()

public webpsave(string $filename[, array<string|int, mixed> $options = = '[]' ]) : void

Save as WebP.

Parameters
$filename : string
$options : array<string|int, mixed> = = '[]'

webpsave_buffer()

public webpsave_buffer([array<string|int, mixed> $options = = '[]' ]) : string

Save as WebP.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
string

webpsave_mime()

public webpsave_mime([array<string|int, mixed> $options = = '[]' ]) : void

Save image to webp mime.

Parameters
$options : array<string|int, mixed> = = '[]'

webpsave_target()

public webpsave_target(Target $target[, array<string|int, mixed> $options = = '[]' ]) : void

Save as WebP.

Parameters
$target : Target
$options : array<string|int, mixed> = = '[]'

worley()

public static worley(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a worley noise image.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

wrap()

public wrap([array<string|int, mixed> $options = = '[]' ]) : Image

Wrap image origin.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

xyz()

public static xyz(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make an image where pixel values are coordinates.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

XYZ2CMYK()

public XYZ2CMYK([array<string|int, mixed> $options = = '[]' ]) : Image

Transform XYZ to CMYK.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

XYZ2Lab()

public XYZ2Lab([array<string|int, mixed> $options = = '[]' ]) : Image

Transform XYZ to Lab.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

XYZ2scRGB()

public XYZ2scRGB([array<string|int, mixed> $options = = '[]' ]) : Image

Transform XYZ to scRGB.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

XYZ2Yxy()

public XYZ2Yxy([array<string|int, mixed> $options = = '[]' ]) : Image

Transform XYZ to Yxy.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

Yxy2XYZ()

public Yxy2XYZ([array<string|int, mixed> $options = = '[]' ]) : Image

Transform Yxy to XYZ.

Parameters
$options : array<string|int, mixed> = = '[]'
Return values
Image

zone()

public static zone(int $width, int $height[, array<string|int, mixed> $options = = '[]' ]) : Image

Make a zone plate.

Parameters
$width : int
$height : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

zoom()

public zoom(int $xfac, int $yfac[, array<string|int, mixed> $options = = '[]' ]) : Image

Zoom an image.

Parameters
$xfac : int
$yfac : int
$options : array<string|int, mixed> = = '[]'
Return values
Image

getMarshaler()

private static getMarshaler(string $name, callable $callback) : Closure|null
Parameters
$name : string
$callback : callable
Return values
Closure|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results