Class Image

Wrap a NetVips.Internal.VipsImage object.

Inheritance

System.Object

System.Runtime.ConstrainedExecution.CriticalFinalizerObject

System.Runtime.InteropServices.SafeHandle

GObject

VipsObject

Image

MutableImage

Implements

System.IDisposable

Inherited Members

VipsObject.OnPostClose

VipsObject.GetBlurb(String)

VipsObject.GetDescription()

GObject.SignalConnect(String, Delegate, IntPtr)

GObject.SignalHandlerDisconnect(UInt64)

GObject.SignalHandlersDisconnectByFunc(Delegate, IntPtr)

GObject.SignalHandlersDisconnectByData(IntPtr)

GObject.ReleaseHandle()

GObject.IsInvalid

System.Runtime.InteropServices.SafeHandle.handle

System.Runtime.InteropServices.SafeHandle.Close()

System.Runtime.InteropServices.SafeHandle.DangerousAddRef(System.Boolean)

System.Runtime.InteropServices.SafeHandle.DangerousGetHandle()

System.Runtime.InteropServices.SafeHandle.DangerousRelease()

System.Runtime.InteropServices.SafeHandle.Dispose()

System.Runtime.InteropServices.SafeHandle.Dispose(System.Boolean)

System.Runtime.InteropServices.SafeHandle.SetHandle(System.IntPtr)

System.Runtime.InteropServices.SafeHandle.SetHandleAsInvalid()

System.Runtime.InteropServices.SafeHandle.IsClosed

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NetVips

Assembly: NetVips.dll

Syntax

public class Image : VipsObject, IDisposable

Properties

| Improve this Doc View Source

Bands

Number of bands in image

Declaration

public int Bands { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Coding

Pixel coding

Declaration

public Enums.Coding Coding { get; }

Property Value

Type	Description
Enums.Coding

| Improve this Doc View Source

Filename

Image filename

Declaration

public string Filename { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Format

Pixel format in image

Declaration

public Enums.BandFormat Format { get; }

Property Value

Type	Description
Enums.BandFormat

| Improve this Doc View Source

Height

Image height in pixels

Declaration

public int Height { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Interpretation

Pixel interpretation

Declaration

public Enums.Interpretation Interpretation { get; }

Property Value

Type	Description
Enums.Interpretation

| Improve this Doc View Source

Item[Int32]

Overload [].

Declaration

public Image this[int i] { get; }

Parameters

Type	Name	Description
System.Int32	i	The band element to pull out.

Property Value

Type	Description
Image	A new Image.

Remarks

Use [] to pull out band elements from an image. For example:

using var green = rgbImage[1];

Will make a new one-band image from band 1 (the middle band).

| Improve this Doc View Source

Item[Int32, Int32]

A synonym for Getpoint(Int32, Int32).

Declaration

public double[] this[int x, int y] { get; }

Parameters

Type	Name	Description
System.Int32	x	Point to read.
System.Int32	y	Point to read.

Property Value

Type	Description
System.Double[]	An array of doubles.

Examples

double[] outArray = in[x, y];

| Improve this Doc View Source

PageHeight

Multi-page images can have a page height. If page-height is not set, it defaults to the image height.

Declaration

public int PageHeight { get; }

Property Value

Type	Description
System.Int32

Remarks

At least libvips 8.8 is needed.

| Improve this Doc View Source

Width

Image width in pixels

Declaration

public int Width { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Xoffset

Horizontal offset of origin

Declaration

public int Xoffset { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Xres

Horizontal resolution in pixels/mm

Declaration

public double Xres { get; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

Yoffset

Vertical offset of origin

Declaration

public int Yoffset { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Yres

Vertical resolution in pixels/mm

Declaration

public double Yres { get; }

Property Value

Type	Description
System.Double

Methods

| Improve this Doc View Source

Abs()

Absolute value of an image.

Declaration

public Image Abs()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Abs();

| Improve this Doc View Source

Acos()

Return the inverse cosine of an image in degrees.

Declaration

public Image Acos()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Acosh()

Return the inverse hyperbolic cosine of an image in radians.

Declaration

public Image Acosh()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Add(Image)

Add two images.

Declaration

public Image Add(Image right)

Parameters

Type	Name	Description
Image	right	Right-hand image argument.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.Add(right);

| Improve this Doc View Source

AddAlpha()

Append an alpha channel to an image.

Declaration

public Image AddAlpha()

Returns

Type	Description
Image	A new Image.

Examples

using rgba = rgb.AddAlpha();

| Improve this Doc View Source

Affine(Double[], GObject, Int32[], Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Double[], Nullable<Boolean>, Nullable<Enums.Extend>)

Affine transform of an image.

Declaration

public Image Affine(double[] matrix, GObject interpolate = null, int[] oarea = null, double? odx = null, double? ody = null, double? idx = null, double? idy = null, double[] background = null, bool? premultiplied = null, Enums.Extend? extend = null)

Parameters

Type	Name	Description
System.Double[]	matrix	Transformation matrix.
GObject	interpolate	Interpolate pixels with this.
System.Int32[]	oarea	Area of output to generate.
System.Nullable<System.Double>	odx	Horizontal output displacement.
System.Nullable<System.Double>	ody	Vertical output displacement.
System.Nullable<System.Double>	idx	Horizontal input displacement.
System.Nullable<System.Double>	idy	Vertical input displacement.
System.Double[]	background	Background value.
System.Nullable<System.Boolean>	premultiplied	Images have premultiplied alpha.
System.Nullable<Enums.Extend>	extend	How to generate the extra pixels.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Affine(matrix, interpolate: GObject, oarea: int[], odx: double, ody: double, idx: double, idy: double, background: double[], premultiplied: bool, extend: Enums.Extend);

| Improve this Doc View Source

Analyzeload(String, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load an Analyze6 image.

Declaration

public static Image Analyzeload(string filename, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Analyzeload(filename, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Analyzeload(String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load an Analyze6 image.

Declaration

public static Image Analyzeload(string filename, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Analyzeload(filename, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Arrayjoin(Image[], Nullable<Int32>, Nullable<Int32>, Double[], Nullable<Enums.Align>, Nullable<Enums.Align>, Nullable<Int32>, Nullable<Int32>)

Join an array of images.

Declaration

public static Image Arrayjoin(Image[] in, int? across = null, int? shim = null, double[] background = null, Enums.Align? halign = null, Enums.Align? valign = null, int? hspacing = null, int? vspacing = null)

Parameters

Type	Name	Description
Image[]	in	Array of input images.
System.Nullable<System.Int32>	across	Number of images across grid.
System.Nullable<System.Int32>	shim	Pixels between images.
System.Double[]	background	Colour for new pixels.
System.Nullable<Enums.Align>	halign	Align on the left, centre or right.
System.Nullable<Enums.Align>	valign	Align on the top, centre or bottom.
System.Nullable<System.Int32>	hspacing	Horizontal spacing between images.
System.Nullable<System.Int32>	vspacing	Vertical spacing between images.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Arrayjoin(@in, across: int, shim: int, background: double[], halign: Enums.Align, valign: Enums.Align, hspacing: int, vspacing: int);

| Improve this Doc View Source

Asin()

Return the inverse sine of an image in degrees.

Declaration

public Image Asin()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Asinh()

Return the inverse hyperbolic sine of an image in radians.

Declaration

public Image Asinh()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Atan()

Return the inverse tangent of an image in degrees.

Declaration

public Image Atan()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Atan2(Image)

Arc tangent of an image in degrees.

Declaration

public Image Atan2(Image x)

Parameters

Type	Name	Description
Image	x	Arc tangent of y / `x`.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Atan2(Double)

Arc tangent of an constant in degrees.

Declaration

public Image Atan2(double x)

Parameters

Type	Name	Description
System.Double	x	Arc tangent of y / `x`.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Atan2(Double[])

Arc tangent of an array in degrees.

Declaration

public Image Atan2(double[] x)

Parameters

Type	Name	Description
System.Double[]	x	Arc tangent of y / `x`.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Atan2(Int32[])

Arc tangent of an array in degrees.

Declaration

public Image Atan2(int[] x)

Parameters

Type	Name	Description
System.Int32[]	x	Arc tangent of y / `x`.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Atanh()

Return the inverse hyperbolic tangent of an image in radians.

Declaration

public Image Atanh()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Autorot()

Autorotate image by exif tag.

Declaration

public Image Autorot()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Autorot();

| Improve this Doc View Source

Autorot(out Enums.Angle)

Autorotate image by exif tag.

Declaration

public Image Autorot(out Enums.Angle angle)

Parameters

Type	Name	Description
Enums.Angle	angle	Angle image was rotated by.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Autorot(out var angle);

| Improve this Doc View Source

Autorot(out Enums.Angle, out Boolean)

Autorotate image by exif tag.

Declaration

public Image Autorot(out Enums.Angle angle, out bool flip)

Parameters

Type	Name	Description
Enums.Angle	angle	Angle image was rotated by.
System.Boolean	flip	Whether the image was flipped or not.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Autorot(out var angle, out var flip);

| Improve this Doc View Source

Avg()

Find image average.

Declaration

public double Avg()

Returns

Type	Description
System.Double	A double.

Examples

double @out = in.Avg();

| Improve this Doc View Source

BandAnd()

AND image bands together.

Declaration

public Image BandAnd()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Bandbool(Enums.OperationBoolean)

Boolean operation across image bands.

Declaration

public Image Bandbool(Enums.OperationBoolean boolean)

Parameters

Type	Name	Description
Enums.OperationBoolean	boolean	Boolean to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Bandbool(boolean);

| Improve this Doc View Source

BandEor()

EOR image bands together.

Declaration

public Image BandEor()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

BandExists(Int32)

Does band exist in image.

Declaration

public bool BandExists(int i)

Parameters

Type	Name	Description
System.Int32	i	The index to fetch.

Returns

Type	Description
System.Boolean	true if the index exists.

| Improve this Doc View Source

Bandfold(Nullable<Int32>)

Fold up x axis into bands.

Declaration

public Image Bandfold(int? factor = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	factor	Fold by this factor.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Bandfold(factor: int);

| Improve this Doc View Source

Bandjoin(Image[])

Append a set of images bandwise.

Declaration

public Image Bandjoin(params Image[] images)

Parameters

Type	Name	Description
Image[]	images	Array of images.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandjoin(image2, image3);

| Improve this Doc View Source

Bandjoin(Double[])

Append a set of constants bandwise.

Declaration

public Image Bandjoin(params double[] doubles)

Parameters

Type	Name	Description
System.Double[]	doubles	Array of constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandjoin(127.5, 255.0);

| Improve this Doc View Source

Bandjoin(Int32[])

Append a set of constants bandwise.

Declaration

public Image Bandjoin(params int[] ints)

Parameters

Type	Name	Description
System.Int32[]	ints	Array of constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandjoin(255, 128);

| Improve this Doc View Source

Bandjoin(Object[])

Append a set of mixed images and constants bandwise.

Declaration

public Image Bandjoin(params object[] objects)

Parameters

Type	Name	Description
System.Object[]	objects	Array of mixed images and constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandjoin(image2, 255);

| Improve this Doc View Source

BandjoinConst(Double[])

Append a constant band to an image.

Declaration

public Image BandjoinConst(double[] c)

Parameters

Type	Name	Description
System.Double[]	c	Array of constants to add.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.BandjoinConst(c);

| Improve this Doc View Source

Bandmean()

Band-wise average.

Declaration

public Image Bandmean()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Bandmean();

| Improve this Doc View Source

BandOr()

OR image bands together.

Declaration

public Image BandOr()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Bandrank(Image, Nullable<Int32>)

Band-wise rank a image.

Declaration

public Image Bandrank(Image other, int? index = null)

Parameters

Type	Name	Description
Image	other	Input image.
System.Nullable<System.Int32>	index	Select this band element from sorted list.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandrank(other, index: int);

| Improve this Doc View Source

Bandrank(Image[], Nullable<Int32>)

Band-wise rank a set of images.

Declaration

public Image Bandrank(Image[] images, int? index = null)

Parameters

Type	Name	Description
Image[]	images	Array of input images.
System.Nullable<System.Int32>	index	Select this band element from sorted list.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandrank(other, index: int);

| Improve this Doc View Source

Bandrank(Double[], Nullable<Int32>)

Band-wise rank a set of constants.

Declaration

public Image Bandrank(double[] doubles, int? index = null)

Parameters

Type	Name	Description
System.Double[]	doubles	Array of constants.
System.Nullable<System.Int32>	index	Select this band element from sorted list.

Returns

Type	Description
Image	A new Image

Examples

using Image @out = image.Bandrank(other, index: int);

| Improve this Doc View Source

Bandrank(Int32[], Nullable<Int32>)

Band-wise rank a set of constants.

Declaration

public Image Bandrank(int[] ints, int? index = null)

Parameters

Type	Name	Description
System.Int32[]	ints	Array of constants.
System.Nullable<System.Int32>	index	Select this band element from sorted list.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandrank(other, index: int);

| Improve this Doc View Source

Bandrank(Object[], Nullable<Int32>)

Band-wise rank a set of mixed images and constants.

Declaration

public Image Bandrank(object[] objects, int? index = null)

Parameters

Type	Name	Description
System.Object[]	objects	Array of mixed images and constants.
System.Nullable<System.Int32>	index	Select this band element from sorted list.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Bandrank(new object[] { image2, 255 }, index: int);

| Improve this Doc View Source

Bandsplit()

Split an n-band image into n separate images.

Declaration

public Image[] Bandsplit()

Returns

Type	Description
Image[]	An array of Image.

| Improve this Doc View Source

Bandunfold(Nullable<Int32>)

Unfold image bands into x axis.

Declaration

public Image Bandunfold(int? factor = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	factor	Unfold by this factor.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Bandunfold(factor: int);

| Improve this Doc View Source

Black(Int32, Int32, Nullable<Int32>)

Make a black image.

Declaration

public static Image Black(int width, int height, int? bands = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Nullable<System.Int32>	bands	Number of bands in image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Black(width, height, bands: int);

| Improve this Doc View Source

Boolean(Image, Enums.OperationBoolean)

Boolean operation on two images.

Declaration

public Image Boolean(Image right, Enums.OperationBoolean boolean)

Parameters

Type	Name	Description
Image	right	Right-hand image argument.
Enums.OperationBoolean	boolean	Boolean to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.Boolean(right, boolean);

| Improve this Doc View Source

BooleanConst(Enums.OperationBoolean, Double[])

Boolean operations against a constant.

Declaration

public Image BooleanConst(Enums.OperationBoolean boolean, double[] c)

Parameters

Type	Name	Description
Enums.OperationBoolean	boolean	Boolean to perform.
System.Double[]	c	Array of constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.BooleanConst(boolean, c);

| Improve this Doc View Source

Buildlut()

Build a look-up table.

Declaration

public Image Buildlut()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Buildlut();

| Improve this Doc View Source

Byteswap()

Byteswap an image.

Declaration

public Image Byteswap()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Byteswap();

| Improve this Doc View Source

Cache(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>)

Cache an image.

Declaration

public Image Cache(int? maxTiles = null, int? tileHeight = null, int? tileWidth = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	maxTiles	Maximum number of tiles to cache.
System.Nullable<System.Int32>	tileHeight	Tile height in pixels.
System.Nullable<System.Int32>	tileWidth	Tile width in pixels.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Cache(maxTiles: int, tileHeight: int, tileWidth: int);

| Improve this Doc View Source

Canny(Nullable<Double>, Nullable<Enums.Precision>)

Canny edge detector.

Declaration

public Image Canny(double? sigma = null, Enums.Precision? precision = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	sigma	Sigma of Gaussian.
System.Nullable<Enums.Precision>	precision	Convolve with this precision.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Canny(sigma: double, precision: Enums.Precision);

| Improve this Doc View Source

Case(Image[])

Use pixel values to pick cases from an array of images.

Declaration

public Image Case(params Image[] images)

Parameters

Type	Name	Description
Image[]	images	Array of case images.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = index.Case(images);

| Improve this Doc View Source

Case(Double[])

Use pixel values to pick cases from an array of constants.

Declaration

public Image Case(params double[] doubles)

Parameters

Type	Name	Description
System.Double[]	doubles	Array of constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = index.Case(10.5, 20.5);

| Improve this Doc View Source

Case(Int32[])

Use pixel values to pick cases from an array of constants.

Declaration

public Image Case(params int[] ints)

Parameters

Type	Name	Description
System.Int32[]	ints	Array of constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = index.Case(10, 20);

| Improve this Doc View Source

Case(Object[])

Use pixel values to pick cases from an a set of mixed images and constants.

Declaration

public Image Case(params object[] objects)

Parameters

Type	Name	Description
System.Object[]	objects	Array of mixed images and constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = index.Case(image, 10);

| Improve this Doc View Source

Cast(Enums.BandFormat, Nullable<Boolean>)

Cast an image.

Declaration

public Image Cast(Enums.BandFormat format, bool? shift = null)

Parameters

Type	Name	Description
Enums.BandFormat	format	Format to cast to.
System.Nullable<System.Boolean>	shift	Shift integer values up and down.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Cast(format, shift: bool);

| Improve this Doc View Source

Ceil()

Return the largest integral value not greater than the argument.

Declaration

public Image Ceil()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

CMC2LCh()

Transform LCh to CMC.

Declaration

public Image CMC2LCh()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.CMC2LCh();

| Improve this Doc View Source

CMYK2XYZ()

Transform CMYK to XYZ.

Declaration

public Image CMYK2XYZ()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.CMYK2XYZ();

| Improve this Doc View Source

Colourspace(Enums.Interpretation, Nullable<Enums.Interpretation>)

Convert to a new colorspace.

Declaration

public Image Colourspace(Enums.Interpretation space, Enums.Interpretation? sourceSpace = null)

Parameters

Type	Name	Description
Enums.Interpretation	space	Destination color space.
System.Nullable<Enums.Interpretation>	sourceSpace	Source color space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Colourspace(space, sourceSpace: Enums.Interpretation);

| Improve this Doc View Source

Compass(Image, Nullable<Int32>, Nullable<Enums.Angle45>, Nullable<Enums.Combine>, Nullable<Enums.Precision>, Nullable<Int32>, Nullable<Int32>)

Convolve with rotating mask.

Declaration

public Image Compass(Image mask, int? times = null, Enums.Angle45? angle = null, Enums.Combine? combine = null, Enums.Precision? precision = null, int? layers = null, int? cluster = null)

Parameters

Type	Name	Description
Image	mask	Input matrix image.
System.Nullable<System.Int32>	times	Rotate and convolve this many times.
System.Nullable<Enums.Angle45>	angle	Rotate mask by this much between convolutions.
System.Nullable<Enums.Combine>	combine	Combine convolution results like this.
System.Nullable<Enums.Precision>	precision	Convolve with this precision.
System.Nullable<System.Int32>	layers	Use this many layers in approximation.
System.Nullable<System.Int32>	cluster	Cluster lines closer than this in approximation.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Compass(mask, times: int, angle: Enums.Angle45, combine: Enums.Combine, precision: Enums.Precision, layers: int, cluster: int);

| Improve this Doc View Source

Complex(Enums.OperationComplex)

Perform a complex operation on an image.

Declaration

public Image Complex(Enums.OperationComplex cmplx)

Parameters

Type	Name	Description
Enums.OperationComplex	cmplx	Complex to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Complex(cmplx);

| Improve this Doc View Source

Complex2(Image, Enums.OperationComplex2)

Complex binary operations on two images.

Declaration

public Image Complex2(Image right, Enums.OperationComplex2 cmplx)

Parameters

Type	Name	Description
Image	right	Right-hand image argument.
Enums.OperationComplex2	cmplx	Binary complex operation to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.Complex2(right, cmplx);

| Improve this Doc View Source

Complexform(Image)

Form a complex image from two real images.

Declaration

public Image Complexform(Image right)

Parameters

Type	Name	Description
Image	right	Right-hand image argument.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.Complexform(right);

| Improve this Doc View Source

Complexget(Enums.OperationComplexget)

Get a component from a complex image.

Declaration

public Image Complexget(Enums.OperationComplexget get)

Parameters

Type	Name	Description
Enums.OperationComplexget	get	Complex to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Complexget(get);

| Improve this Doc View Source

Composite(Image, Enums.BlendMode, Nullable<Int32>, Nullable<Int32>, Nullable<Enums.Interpretation>, Nullable<Boolean>)

A synonym for Composite2(Image, Enums.BlendMode, Nullable<Int32>, Nullable<Int32>, Nullable<Enums.Interpretation>, Nullable<Boolean>).

Declaration

public Image Composite(Image overlay, Enums.BlendMode mode, int? x = null, int? y = null, Enums.Interpretation? compositingSpace = null, bool? premultiplied = null)

Parameters

Type	Name	Description
Image	overlay	Overlay image.
Enums.BlendMode	mode	VipsBlendMode to join with.
System.Nullable<System.Int32>	x	x position of overlay.
System.Nullable<System.Int32>	y	y position of overlay.
System.Nullable<Enums.Interpretation>	compositingSpace	Composite images in this colour space.
System.Nullable<System.Boolean>	premultiplied	Images have premultiplied alpha.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = base.Composite(overlay, mode, x: int, y: int, compositingSpace: Enums.Interpretation, premultiplied: bool);

| Improve this Doc View Source

Composite(Image[], Enums.BlendMode[], Int32[], Int32[], Nullable<Enums.Interpretation>, Nullable<Boolean>)

Blend an array of images with an array of blend modes.

Declaration

public Image Composite(Image[] images, Enums.BlendMode[] modes, int[] x = null, int[] y = null, Enums.Interpretation? compositingSpace = null, bool? premultiplied = null)

Parameters

Type	Name	Description
Image[]	images	Array of input images.
Enums.BlendMode[]	modes	Array of VipsBlendMode to join with.
System.Int32[]	x	Array of x coordinates to join at.
System.Int32[]	y	Array of y coordinates to join at.
System.Nullable<Enums.Interpretation>	compositingSpace	Composite images in this colour space.
System.Nullable<System.Boolean>	premultiplied	Images have premultiplied alpha.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = image.Composite(images, modes, x: int[], y: int[], compositingSpace: Enums.Interpretation, premultiplied: bool);

| Improve this Doc View Source

Composite2(Image, Enums.BlendMode, Nullable<Int32>, Nullable<Int32>, Nullable<Enums.Interpretation>, Nullable<Boolean>)

Blend a pair of images with a blend mode.

Declaration

public Image Composite2(Image overlay, Enums.BlendMode mode, int? x = null, int? y = null, Enums.Interpretation? compositingSpace = null, bool? premultiplied = null)

Parameters

Type	Name	Description
Image	overlay	Overlay image.
Enums.BlendMode	mode	VipsBlendMode to join with.
System.Nullable<System.Int32>	x	x position of overlay.
System.Nullable<System.Int32>	y	y position of overlay.
System.Nullable<Enums.Interpretation>	compositingSpace	Composite images in this colour space.
System.Nullable<System.Boolean>	premultiplied	Images have premultiplied alpha.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = base.Composite2(overlay, mode, x: int, y: int, compositingSpace: Enums.Interpretation, premultiplied: bool);

| Improve this Doc View Source

Conj()

Return the complex conjugate of an image.

Declaration

public Image Conj()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Contains(String)

Check if the underlying image contains an property of metadata.

Declaration

public bool Contains(string name)

Parameters

Type	Name	Description
System.String	name	The name of the piece of metadata to check for.

Returns

Type	Description
System.Boolean	true if the metadata exits; otherwise, false.

| Improve this Doc View Source

Conv(Image, Nullable<Enums.Precision>, Nullable<Int32>, Nullable<Int32>)

Convolution operation.

Declaration

public Image Conv(Image mask, Enums.Precision? precision = null, int? layers = null, int? cluster = null)

Parameters

Type	Name	Description
Image	mask	Input matrix image.
System.Nullable<Enums.Precision>	precision	Convolve with this precision.
System.Nullable<System.Int32>	layers	Use this many layers in approximation.
System.Nullable<System.Int32>	cluster	Cluster lines closer than this in approximation.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Conv(mask, precision: Enums.Precision, layers: int, cluster: int);

| Improve this Doc View Source

Conva(Image, Nullable<Int32>, Nullable<Int32>)

Approximate integer convolution.

Declaration

public Image Conva(Image mask, int? layers = null, int? cluster = null)

Parameters

Type	Name	Description
Image	mask	Input matrix image.
System.Nullable<System.Int32>	layers	Use this many layers in approximation.
System.Nullable<System.Int32>	cluster	Cluster lines closer than this in approximation.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Conva(mask, layers: int, cluster: int);

| Improve this Doc View Source

Convasep(Image, Nullable<Int32>)

Approximate separable integer convolution.

Declaration

public Image Convasep(Image mask, int? layers = null)

Parameters

Type	Name	Description
Image	mask	Input matrix image.
System.Nullable<System.Int32>	layers	Use this many layers in approximation.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Convasep(mask, layers: int);

| Improve this Doc View Source

Convf(Image)

Float convolution operation.

Declaration

public Image Convf(Image mask)

Parameters

Type	Name	Description
Image	mask	Input matrix image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Convf(mask);

| Improve this Doc View Source

Convi(Image)

Int convolution operation.

Declaration

public Image Convi(Image mask)

Parameters

Type	Name	Description
Image	mask	Input matrix image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Convi(mask);

| Improve this Doc View Source

Convsep(Image, Nullable<Enums.Precision>, Nullable<Int32>, Nullable<Int32>)

Seperable convolution operation.

Declaration

public Image Convsep(Image mask, Enums.Precision? precision = null, int? layers = null, int? cluster = null)

Parameters

Type	Name	Description
Image	mask	Input matrix image.
System.Nullable<Enums.Precision>	precision	Convolve with this precision.
System.Nullable<System.Int32>	layers	Use this many layers in approximation.
System.Nullable<System.Int32>	cluster	Cluster lines closer than this in approximation.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Convsep(mask, precision: Enums.Precision, layers: int, cluster: int);

| Improve this Doc View Source

Copy(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Enums.BandFormat>, Nullable<Enums.Coding>, Nullable<Enums.Interpretation>, Nullable<Double>, Nullable<Double>, Nullable<Int32>, Nullable<Int32>)

Copy an image.

Declaration

public Image Copy(int? width = null, int? height = null, int? bands = null, Enums.BandFormat? format = null, Enums.Coding? coding = null, Enums.Interpretation? interpretation = null, double? xres = null, double? yres = null, int? xoffset = null, int? yoffset = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	width	Image width in pixels.
System.Nullable<System.Int32>	height	Image height in pixels.
System.Nullable<System.Int32>	bands	Number of bands in image.
System.Nullable<Enums.BandFormat>	format	Pixel format in image.
System.Nullable<Enums.Coding>	coding	Pixel coding.
System.Nullable<Enums.Interpretation>	interpretation	Pixel interpretation.
System.Nullable<System.Double>	xres	Horizontal resolution in pixels/mm.
System.Nullable<System.Double>	yres	Vertical resolution in pixels/mm.
System.Nullable<System.Int32>	xoffset	Horizontal offset of origin.
System.Nullable<System.Int32>	yoffset	Vertical offset of origin.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Copy(width: int, height: int, bands: int, format: Enums.BandFormat, coding: Enums.Coding, interpretation: Enums.Interpretation, xres: double, yres: double, xoffset: int, yoffset: int);

| Improve this Doc View Source

CopyMemory()

Copy an image to memory.

Declaration

public Image CopyMemory()

Returns

Type	Description
Image	A new Image.

Remarks

A large area of memory is allocated, the image is rendered to that memory area, and a new image is returned which wraps that large memory area.

Exceptions

Type	Condition
VipsException	If unable to copy to memory.

| Improve this Doc View Source

Cos()

Return the cosine of an image in degrees.

Declaration

public Image Cos()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Cosh()

Return the hyperbolic cosine of an image in radians.

Declaration

public Image Cosh()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Countlines(Enums.Direction)

Count lines in an image.

Declaration

public double Countlines(Enums.Direction direction)

Parameters

Type	Name	Description
Enums.Direction	direction	Countlines left-right or up-down.

Returns

Type	Description
System.Double	A double.

Examples

double nolines = in.Countlines(direction);

| Improve this Doc View Source

Crop(Int32, Int32, Int32, Int32)

A synonym for ExtractArea(Int32, Int32, Int32, Int32).

Declaration

public Image Crop(int left, int top, int width, int height)

Parameters

Type	Name	Description
System.Int32	left	Left edge of extract area.
System.Int32	top	Top edge of extract area.
System.Int32	width	Width of extract area.
System.Int32	height	Height of extract area.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = input.Crop(left, top, width, height);

| Improve this Doc View Source

Csvload(String, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load csv.

Declaration

public static Image Csvload(string filename, out Enums.ForeignFlags flags, int? skip = null, int? lines = null, string whitespace = null, string separator = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	skip	Skip this many lines at the start of the file.
System.Nullable<System.Int32>	lines	Read this many lines from the file.
System.String	whitespace	Set of whitespace characters.
System.String	separator	Set of separator characters.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Csvload(filename, out var flags, skip: int, lines: int, whitespace: string, separator: string, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Csvload(String, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load csv.

Declaration

public static Image Csvload(string filename, int? skip = null, int? lines = null, string whitespace = null, string separator = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	skip	Skip this many lines at the start of the file.
System.Nullable<System.Int32>	lines	Read this many lines from the file.
System.String	whitespace	Set of whitespace characters.
System.String	separator	Set of separator characters.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Csvload(filename, skip: int, lines: int, whitespace: string, separator: string, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

CsvloadSource(Source, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load csv.

Declaration

public static Image CsvloadSource(Source source, out Enums.ForeignFlags flags, int? skip = null, int? lines = null, string whitespace = null, string separator = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	skip	Skip this many lines at the start of the file.
System.Nullable<System.Int32>	lines	Read this many lines from the file.
System.String	whitespace	Set of whitespace characters.
System.String	separator	Set of separator characters.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.CsvloadSource(source, out var flags, skip: int, lines: int, whitespace: string, separator: string, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

CsvloadSource(Source, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load csv.

Declaration

public static Image CsvloadSource(Source source, int? skip = null, int? lines = null, string whitespace = null, string separator = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Int32>	skip	Skip this many lines at the start of the file.
System.Nullable<System.Int32>	lines	Read this many lines from the file.
System.String	whitespace	Set of whitespace characters.
System.String	separator	Set of separator characters.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.CsvloadSource(source, skip: int, lines: int, whitespace: string, separator: string, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

CsvloadStream(Stream, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load csv.

Declaration

public static Image CsvloadStream(Stream stream, out Enums.ForeignFlags flags, int? skip = null, int? lines = null, string whitespace = null, string separator = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	skip	Skip this many lines at the start of the file.
System.Nullable<System.Int32>	lines	Read this many lines from the file.
System.String	whitespace	Set of whitespace characters.
System.String	separator	Set of separator characters.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.CsvloadStream(stream, out var flags, skip: int, lines: int, whitespace: string, separator: string, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

CsvloadStream(Stream, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load csv.

Declaration

public static Image CsvloadStream(Stream stream, int? skip = null, int? lines = null, string whitespace = null, string separator = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Int32>	skip	Skip this many lines at the start of the file.
System.Nullable<System.Int32>	lines	Read this many lines from the file.
System.String	whitespace	Set of whitespace characters.
System.String	separator	Set of separator characters.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.CsvloadStream(stream, skip: int, lines: int, whitespace: string, separator: string, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Csvsave(String, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to csv.

Declaration

public void Csvsave(string filename, string separator = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.String	separator	Separator characters.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Csvsave(filename, separator: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

CsvsaveStream(Stream, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to csv.

Declaration

public void CsvsaveStream(Stream stream, string separator = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.String	separator	Separator characters.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.CsvsaveStream(stream, separator: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

CsvsaveTarget(Target, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to csv.

Declaration

public void CsvsaveTarget(Target target, string separator = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.String	separator	Separator characters.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.CsvsaveTarget(target, separator: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

DE00(Image)

Calculate dE00.

Declaration

public Image DE00(Image right)

Parameters

Type	Name	Description
Image	right	Right-hand input image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.DE00(right);

| Improve this Doc View Source

DE76(Image)

Calculate dE76.

Declaration

public Image DE76(Image right)

Parameters

Type	Name	Description
Image	right	Right-hand input image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.DE76(right);

| Improve this Doc View Source

DECMC(Image)

Calculate dECMC.

Declaration

public Image DECMC(Image right)

Parameters

Type	Name	Description
Image	right	Right-hand input image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.DECMC(right);

| Improve this Doc View Source

Deviate()

Find image standard deviation.

Declaration

public double Deviate()

Returns

Type	Description
System.Double	A double.

Examples

double @out = in.Deviate();

| Improve this Doc View Source

Dilate(Image)

Dilate with a structuring element.

Declaration

public Image Dilate(Image mask)

Parameters

Type	Name	Description
Image	mask	The structuring element.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Divide(Image)

Divide two images.

Declaration

public Image Divide(Image right)

Parameters

Type	Name	Description
Image	right	Right-hand image argument.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.Divide(right);

| Improve this Doc View Source

Dzsave(String, String, Nullable<Enums.ForeignDzLayout>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignDzDepth>, Nullable<Enums.Angle>, Nullable<Enums.ForeignDzContainer>, Nullable<Int32>, Nullable<Enums.RegionShrink>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to deepzoom file.

Declaration

public void Dzsave(string filename, string basename = null, Enums.ForeignDzLayout? layout = null, string suffix = null, int? overlap = null, int? tileSize = null, bool? centre = null, Enums.ForeignDzDepth? depth = null, Enums.Angle? angle = null, Enums.ForeignDzContainer? container = null, int? compression = null, Enums.RegionShrink? regionShrink = null, int? skipBlanks = null, bool? noStrip = null, string id = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.String	basename	Base name to save to.
System.Nullable<Enums.ForeignDzLayout>	layout	Directory layout.
System.String	suffix	Filename suffix for tiles.
System.Nullable<System.Int32>	overlap	Tile overlap in pixels.
System.Nullable<System.Int32>	tileSize	Tile size in pixels.
System.Nullable<System.Boolean>	centre	Center image in tile.
System.Nullable<Enums.ForeignDzDepth>	depth	Pyramid depth.
System.Nullable<Enums.Angle>	angle	Rotate image during save.
System.Nullable<Enums.ForeignDzContainer>	container	Pyramid container type.
System.Nullable<System.Int32>	compression	ZIP deflate compression level.
System.Nullable<Enums.RegionShrink>	regionShrink	Method to shrink regions.
System.Nullable<System.Int32>	skipBlanks	Skip tiles which are nearly equal to the background.
System.Nullable<System.Boolean>	noStrip	Don't strip tile metadata.
System.String	id	Resource ID.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Dzsave(filename, basename: string, layout: Enums.ForeignDzLayout, suffix: string, overlap: int, tileSize: int, centre: bool, depth: Enums.ForeignDzDepth, angle: Enums.Angle, container: Enums.ForeignDzContainer, compression: int, regionShrink: Enums.RegionShrink, skipBlanks: int, noStrip: bool, id: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

DzsaveBuffer(String, Nullable<Enums.ForeignDzLayout>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignDzDepth>, Nullable<Enums.Angle>, Nullable<Enums.ForeignDzContainer>, Nullable<Int32>, Nullable<Enums.RegionShrink>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to dz buffer.

Declaration

public byte[] DzsaveBuffer(string basename = null, Enums.ForeignDzLayout? layout = null, string suffix = null, int? overlap = null, int? tileSize = null, bool? centre = null, Enums.ForeignDzDepth? depth = null, Enums.Angle? angle = null, Enums.ForeignDzContainer? container = null, int? compression = null, Enums.RegionShrink? regionShrink = null, int? skipBlanks = null, bool? noStrip = null, string id = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	basename	Base name to save to.
System.Nullable<Enums.ForeignDzLayout>	layout	Directory layout.
System.String	suffix	Filename suffix for tiles.
System.Nullable<System.Int32>	overlap	Tile overlap in pixels.
System.Nullable<System.Int32>	tileSize	Tile size in pixels.
System.Nullable<System.Boolean>	centre	Center image in tile.
System.Nullable<Enums.ForeignDzDepth>	depth	Pyramid depth.
System.Nullable<Enums.Angle>	angle	Rotate image during save.
System.Nullable<Enums.ForeignDzContainer>	container	Pyramid container type.
System.Nullable<System.Int32>	compression	ZIP deflate compression level.
System.Nullable<Enums.RegionShrink>	regionShrink	Method to shrink regions.
System.Nullable<System.Int32>	skipBlanks	Skip tiles which are nearly equal to the background.
System.Nullable<System.Boolean>	noStrip	Don't strip tile metadata.
System.String	id	Resource ID.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.DzsaveBuffer(basename: string, layout: Enums.ForeignDzLayout, suffix: string, overlap: int, tileSize: int, centre: bool, depth: Enums.ForeignDzDepth, angle: Enums.Angle, container: Enums.ForeignDzContainer, compression: int, regionShrink: Enums.RegionShrink, skipBlanks: int, noStrip: bool, id: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

DzsaveStream(Stream, String, Nullable<Enums.ForeignDzLayout>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignDzDepth>, Nullable<Enums.Angle>, Nullable<Enums.ForeignDzContainer>, Nullable<Int32>, Nullable<Enums.RegionShrink>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to deepzoom stream.

Declaration

public void DzsaveStream(Stream stream, string basename = null, Enums.ForeignDzLayout? layout = null, string suffix = null, int? overlap = null, int? tileSize = null, bool? centre = null, Enums.ForeignDzDepth? depth = null, Enums.Angle? angle = null, Enums.ForeignDzContainer? container = null, int? compression = null, Enums.RegionShrink? regionShrink = null, int? skipBlanks = null, bool? noStrip = null, string id = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.String	basename	Base name to save to.
System.Nullable<Enums.ForeignDzLayout>	layout	Directory layout.
System.String	suffix	Filename suffix for tiles.
System.Nullable<System.Int32>	overlap	Tile overlap in pixels.
System.Nullable<System.Int32>	tileSize	Tile size in pixels.
System.Nullable<System.Boolean>	centre	Center image in tile.
System.Nullable<Enums.ForeignDzDepth>	depth	Pyramid depth.
System.Nullable<Enums.Angle>	angle	Rotate image during save.
System.Nullable<Enums.ForeignDzContainer>	container	Pyramid container type.
System.Nullable<System.Int32>	compression	ZIP deflate compression level.
System.Nullable<Enums.RegionShrink>	regionShrink	Method to shrink regions.
System.Nullable<System.Int32>	skipBlanks	Skip tiles which are nearly equal to the background.
System.Nullable<System.Boolean>	noStrip	Don't strip tile metadata.
System.String	id	Resource ID.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.DzsaveStream(stream, basename: string, layout: Enums.ForeignDzLayout, suffix: string, overlap: int, tileSize: int, centre: bool, depth: Enums.ForeignDzDepth, angle: Enums.Angle, container: Enums.ForeignDzContainer, compression: int, regionShrink: Enums.RegionShrink, skipBlanks: int, noStrip: bool, id: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

DzsaveTarget(Target, String, Nullable<Enums.ForeignDzLayout>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignDzDepth>, Nullable<Enums.Angle>, Nullable<Enums.ForeignDzContainer>, Nullable<Int32>, Nullable<Enums.RegionShrink>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to deepzoom target.

Declaration

public void DzsaveTarget(Target target, string basename = null, Enums.ForeignDzLayout? layout = null, string suffix = null, int? overlap = null, int? tileSize = null, bool? centre = null, Enums.ForeignDzDepth? depth = null, Enums.Angle? angle = null, Enums.ForeignDzContainer? container = null, int? compression = null, Enums.RegionShrink? regionShrink = null, int? skipBlanks = null, bool? noStrip = null, string id = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.String	basename	Base name to save to.
System.Nullable<Enums.ForeignDzLayout>	layout	Directory layout.
System.String	suffix	Filename suffix for tiles.
System.Nullable<System.Int32>	overlap	Tile overlap in pixels.
System.Nullable<System.Int32>	tileSize	Tile size in pixels.
System.Nullable<System.Boolean>	centre	Center image in tile.
System.Nullable<Enums.ForeignDzDepth>	depth	Pyramid depth.
System.Nullable<Enums.Angle>	angle	Rotate image during save.
System.Nullable<Enums.ForeignDzContainer>	container	Pyramid container type.
System.Nullable<System.Int32>	compression	ZIP deflate compression level.
System.Nullable<Enums.RegionShrink>	regionShrink	Method to shrink regions.
System.Nullable<System.Int32>	skipBlanks	Skip tiles which are nearly equal to the background.
System.Nullable<System.Boolean>	noStrip	Don't strip tile metadata.
System.String	id	Resource ID.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.DzsaveTarget(target, basename: string, layout: Enums.ForeignDzLayout, suffix: string, overlap: int, tileSize: int, centre: bool, depth: Enums.ForeignDzDepth, angle: Enums.Angle, container: Enums.ForeignDzContainer, compression: int, regionShrink: Enums.RegionShrink, skipBlanks: int, noStrip: bool, id: string, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Embed(Int32, Int32, Int32, Int32, Nullable<Enums.Extend>, Double[])

Embed an image in a larger image.

Declaration

public Image Embed(int x, int y, int width, int height, Enums.Extend? extend = null, double[] background = null)

Parameters

Type	Name	Description
System.Int32	x	Left edge of input in output.
System.Int32	y	Top edge of input in output.
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Nullable<Enums.Extend>	extend	How to generate the extra pixels.
System.Double[]	background	Color for background pixels.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Embed(x, y, width, height, extend: Enums.Extend, background: double[]);

| Improve this Doc View Source

Equal(Image)

This operation compares two images on equality.

Declaration

public Image Equal(Image right)

Parameters

Type	Name	Description
Image	right	A Image to compare.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Equal(Double)

This operation compares two images on equality.

Declaration

public Image Equal(double right)

Parameters

Type	Name	Description
System.Double	right	A double constant to compare.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Equal(Double[])

This operation compares two images on equality.

Declaration

public Image Equal(double[] right)

Parameters

Type	Name	Description
System.Double[]	right	A double array to compare.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Equal(Int32[])

This operation compares two images on equality.

Declaration

public Image Equal(int[] right)

Parameters

Type	Name	Description
System.Int32[]	right	A integer array to compare.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Equals(Image)

Compares the hashcode of two images.

Declaration

public bool Equals(Image other)

Parameters

Type	Name	Description
Image	other	The Image to compare.

Returns

Type	Description
System.Boolean	true if equal; otherwise, false.

| Improve this Doc View Source

Equals(Object)

Determines whether the specified object is equal to the current image.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare with the current image.

Returns

Type	Description
System.Boolean	true if the specified object is equal to the current image; otherwise, false.

Overrides

System.Object.Equals(System.Object)

| Improve this Doc View Source

Erode(Image)

Erode with a structuring element.

Declaration

public Image Erode(Image mask)

Parameters

Type	Name	Description
Image	mask	The structuring element.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Exp()

Return e ** pixel.

Declaration

public Image Exp()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Exp10()

Return 10 ** pixel.

Declaration

public Image Exp10()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

ExtractArea(Int32, Int32, Int32, Int32)

Extract an area from an image.

Declaration

public Image ExtractArea(int left, int top, int width, int height)

Parameters

Type	Name	Description
System.Int32	left	Left edge of extract area.
System.Int32	top	Top edge of extract area.
System.Int32	width	Width of extract area.
System.Int32	height	Height of extract area.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = input.ExtractArea(left, top, width, height);

| Improve this Doc View Source

ExtractBand(Int32, Nullable<Int32>)

Extract band from an image.

Declaration

public Image ExtractBand(int band, int? n = null)

Parameters

Type	Name	Description
System.Int32	band	Band to extract.
System.Nullable<System.Int32>	n	Number of bands to extract.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.ExtractBand(band, n: int);

| Improve this Doc View Source

Eye(Int32, Int32, Nullable<Boolean>, Nullable<Double>)

Make an image showing the eye's spatial response.

Declaration

public static Image Eye(int width, int height, bool? uchar = null, double? factor = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Double>	factor	Maximum spatial frequency.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Eye(width, height, uchar: bool, factor: double);

| Improve this Doc View Source

Falsecolour()

False-color an image.

Declaration

public Image Falsecolour()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Falsecolour();

| Improve this Doc View Source

Fastcor(Image)

Fast correlation.

Declaration

public Image Fastcor(Image ref)

Parameters

Type	Name	Description
Image	ref	Input reference image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Fastcor(@ref);

| Improve this Doc View Source

FillNearest()

Fill image zeros with nearest non-zero pixel.

Declaration

public Image FillNearest()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.FillNearest();

| Improve this Doc View Source

FillNearest(out Image)

Fill image zeros with nearest non-zero pixel.

Declaration

public Image FillNearest(out Image distance)

Parameters

Type	Name	Description
Image	distance	Distance to nearest non-zero pixel.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.FillNearest(out var distance);

| Improve this Doc View Source

FindLoad(String)

Find the name of the load operation vips will use to load a file.

Declaration

public static string FindLoad(string filename)

Parameters

Type	Name	Description
System.String	filename	The file to test.

Returns

Type	Description
System.String	The name of the load operation, or null.

Remarks

For example "VipsForeignLoadJpegFile". You can use this to work out what options to pass to NewFromFile(String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>, VOption).

| Improve this Doc View Source

FindLoadBuffer(Byte[])

Find the name of the load operation vips will use to load a buffer.

Declaration

public static string FindLoadBuffer(byte[] data)

Parameters

Type	Name	Description
System.Byte[]	data	The buffer to test.

Returns

Type	Description
System.String	The name of the load operation, or null.

Remarks

For example "VipsForeignLoadJpegBuffer". You can use this to work out what options to pass to NewFromBuffer(Byte[], String, Nullable<Enums.Access>, Nullable<Enums.FailOn>, VOption).

| Improve this Doc View Source

FindLoadBuffer(Char[])

Find the name of the load operation vips will use to load a buffer.

Declaration

public static string FindLoadBuffer(char[] data)

Parameters

Type	Name	Description
System.Char[]	data	The buffer to test.

Returns

Type	Description
System.String	The name of the load operation, or null.

Remarks

For example "VipsForeignLoadJpegBuffer". You can use this to work out what options to pass to NewFromBuffer(Char[], String, Nullable<Enums.Access>, Nullable<Enums.FailOn>, VOption).

| Improve this Doc View Source

FindLoadBuffer(String)

Find the name of the load operation vips will use to load a buffer.

Declaration

public static string FindLoadBuffer(string data)

Parameters

Type	Name	Description
System.String	data	The buffer to test.

Returns

Type	Description
System.String	The name of the load operation, or null.

Remarks

For example "VipsForeignLoadJpegBuffer". You can use this to work out what options to pass to NewFromBuffer(String, String, Nullable<Enums.Access>, Nullable<Enums.FailOn>, VOption).

| Improve this Doc View Source

FindLoadSource(Source)

Find the name of the load operation vips will use to load a source.

Declaration

public static string FindLoadSource(Source source)

Parameters

Type	Name	Description
Source	source	The source to test.

Returns

Type	Description
System.String	The name of the load operation, or null.

Remarks

For example "VipsForeignLoadJpegSource". You can use this to work out what options to pass to NewFromSource(Source, String, Nullable<Enums.Access>, Nullable<Enums.FailOn>, VOption).

| Improve this Doc View Source

FindLoadStream(Stream)

Find the name of the load operation vips will use to load a stream.

Declaration

public static string FindLoadStream(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream to test.

Returns

Type	Description
System.String	The name of the load operation, or null.

Remarks

For example "VipsForeignLoadJpegSource". You can use this to work out what options to pass to NewFromStream(Stream, String, Nullable<Enums.Access>, Nullable<Enums.FailOn>, VOption).

| Improve this Doc View Source

FindTrim(Nullable<Double>, Double[])

Search an image for non-edge areas.

Declaration

public object[] FindTrim(double? threshold = null, double[] background = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	threshold	Object threshold.
System.Double[]	background	Color for background pixels.

Returns

Type	Description
System.Object[]	An array of objects.

Examples

var output = in.FindTrim(threshold: double, background: double[]);

| Improve this Doc View Source

Fitsload(String, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a FITS image.

Declaration

public static Image Fitsload(string filename, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Fitsload(filename, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Fitsload(String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a FITS image.

Declaration

public static Image Fitsload(string filename, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Fitsload(filename, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

FitsloadSource(Source, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load FITS from a source.

Declaration

public static Image FitsloadSource(Source source, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.FitsloadSource(source, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

FitsloadSource(Source, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load FITS from a source.

Declaration

public static Image FitsloadSource(Source source, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.FitsloadSource(source, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

FitsloadStream(Stream, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load FITS from a stream.

Declaration

public static Image FitsloadStream(Stream stream, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.FitsloadStream(stream, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

FitsloadStream(Stream, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load FITS from a stream.

Declaration

public static Image FitsloadStream(Stream stream, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.FitsloadStream(stream, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Fitssave(String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to fits file.

Declaration

public void Fitssave(string filename, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Fitssave(filename, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Flatten(Double[], Nullable<Double>)

Flatten alpha out of an image.

Declaration

public Image Flatten(double[] background = null, double? maxAlpha = null)

Parameters

Type	Name	Description
System.Double[]	background	Background value.
System.Nullable<System.Double>	maxAlpha	Maximum value of alpha channel.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Flatten(background: double[], maxAlpha: double);

| Improve this Doc View Source

Flip(Enums.Direction)

Flip an image.

Declaration

public Image Flip(Enums.Direction direction)

Parameters

Type	Name	Description
Enums.Direction	direction	Direction to flip image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Flip(direction);

| Improve this Doc View Source

FlipHor()

Flip horizontally.

Declaration

public Image FlipHor()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

FlipVer()

Flip vertically.

Declaration

public Image FlipVer()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Float2rad()

Transform float RGB to Radiance coding.

Declaration

public Image Float2rad()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Float2rad();

| Improve this Doc View Source

Floor()

Return the largest integral value not greater than the argument.

Declaration

public Image Floor()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Fractsurf(Int32, Int32, Double)

Make a fractal surface.

Declaration

public static Image Fractsurf(int width, int height, double fractalDimension)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	fractalDimension	Fractal dimension.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Fractsurf(width, height, fractalDimension);

| Improve this Doc View Source

Freqmult(Image)

Frequency-domain filtering.

Declaration

public Image Freqmult(Image mask)

Parameters

Type	Name	Description
Image	mask	Input mask image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Freqmult(mask);

| Improve this Doc View Source

Fwfft()

Forward FFT.

Declaration

public Image Fwfft()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Fwfft();

| Improve this Doc View Source

Gamma(Nullable<Double>)

Gamma an image.

Declaration

public Image Gamma(double? exponent = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	exponent	Gamma factor.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Gamma(exponent: double);

| Improve this Doc View Source

Gaussblur(Double, Nullable<Double>, Nullable<Enums.Precision>)

Gaussian blur.

Declaration

public Image Gaussblur(double sigma, double? minAmpl = null, Enums.Precision? precision = null)

Parameters

Type	Name	Description
System.Double	sigma	Sigma of Gaussian.
System.Nullable<System.Double>	minAmpl	Minimum amplitude of Gaussian.
System.Nullable<Enums.Precision>	precision	Convolve with this precision.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Gaussblur(sigma, minAmpl: double, precision: Enums.Precision);

| Improve this Doc View Source

Gaussmat(Double, Double, Nullable<Boolean>, Nullable<Enums.Precision>)

Make a gaussian image.

Declaration

public static Image Gaussmat(double sigma, double minAmpl, bool? separable = null, Enums.Precision? precision = null)

Parameters

Type	Name	Description
System.Double	sigma	Sigma of Gaussian.
System.Double	minAmpl	Minimum amplitude of Gaussian.
System.Nullable<System.Boolean>	separable	Generate separable Gaussian.
System.Nullable<Enums.Precision>	precision	Generate with this precision.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Gaussmat(sigma, minAmpl, separable: bool, precision: Enums.Precision);

| Improve this Doc View Source

Gaussnoise(Int32, Int32, Nullable<Double>, Nullable<Double>, Nullable<Int32>)

Make a gaussnoise image.

Declaration

public static Image Gaussnoise(int width, int height, double? sigma = null, double? mean = null, int? seed = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Nullable<System.Double>	sigma	Standard deviation of pixels in generated image.
System.Nullable<System.Double>	mean	Mean of pixels in generated image.
System.Nullable<System.Int32>	seed	Random number seed.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Gaussnoise(width, height, sigma: double, mean: double, seed: int);

| Improve this Doc View Source

Get(String)

Get an item of metadata.

Declaration

public object Get(string name)

Parameters

Type	Name	Description
System.String	name	The name of the piece of metadata to get.

Returns

Type	Description
System.Object	The metadata item as a C# value.

Remarks

Fetches an item of metadata as a C# value. For example:

var orientation = image.Get("orientation");

would fetch the image orientation.

Exceptions

Type	Condition
VipsException	If unable to get `name`.

| Improve this Doc View Source

GetFields()

Get a list of all the metadata fields on an image.

Declaration

public string[] GetFields()

Returns

Type	Description
System.String[]	An array of strings or null.

Remarks

At least libvips 8.5 is needed.

| Improve this Doc View Source

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current image.

Overrides

System.Object.GetHashCode()

| Improve this Doc View Source

Getpoint(Int32, Int32)

Read a point from an image.

Declaration

public double[] Getpoint(int x, int y)

Parameters

Type	Name	Description
System.Int32	x	Point to read.
System.Int32	y	Point to read.

Returns

Type	Description
System.Double[]	An array of doubles.

Examples

double[] outArray = in.Getpoint(x, y);

| Improve this Doc View Source

GetTypeOf(String)

Get the GType of an item of metadata.

Declaration

public IntPtr GetTypeOf(string name)

Parameters

Type	Name	Description
System.String	name	The name of the piece of metadata to get the type of.

Returns

Type	Description
System.IntPtr	A new instance of System.IntPtr initialized to the GType or System.IntPtr.Zero if the property does not exist.

Remarks

Fetch the GType of a piece of metadata, or System.IntPtr.Zero if the named item does not exist. See GValue.

| Improve this Doc View Source

Gifload(String, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load GIF with libnsgif.

Declaration

public static Image Gifload(string filename, out Enums.ForeignFlags flags, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Gifload(filename, out var flags, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Gifload(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load GIF with libnsgif.

Declaration

public static Image Gifload(string filename, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Gifload(filename, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

GifloadBuffer(Byte[], out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load GIF with libnsgif.

Declaration

public static Image GifloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.GifloadBuffer(buffer, out var flags, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

GifloadBuffer(Byte[], Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load GIF with libnsgif.

Declaration

public static Image GifloadBuffer(byte[] buffer, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.GifloadBuffer(buffer, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

GifloadSource(Source, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load gif from source.

Declaration

public static Image GifloadSource(Source source, out Enums.ForeignFlags flags, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.GifloadSource(source, out var flags, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

GifloadSource(Source, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load gif from source.

Declaration

public static Image GifloadSource(Source source, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.GifloadSource(source, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

GifloadStream(Stream, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load gif from stream.

Declaration

public static Image GifloadStream(Stream stream, out Enums.ForeignFlags flags, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.GifloadStream(stream, out var flags, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

GifloadStream(Stream, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load gif from stream.

Declaration

public static Image GifloadStream(Stream stream, int? n = null, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.GifloadStream(stream, n: int, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Gifsave(String, Nullable<Double>, Nullable<Int32>, Nullable<Int32>, Nullable<Double>, Nullable<Boolean>, Nullable<Double>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save as gif.

Declaration

public void Gifsave(string filename, double? dither = null, int? effort = null, int? bitdepth = null, double? interframeMaxerror = null, bool? reoptimise = null, double? interpaletteMaxerror = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.Nullable<System.Double>	dither	Amount of dithering.
System.Nullable<System.Int32>	effort	Quantisation effort.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Double>	interframeMaxerror	Maximum inter-frame error for transparency.
System.Nullable<System.Boolean>	reoptimise	Reoptimise colour palettes.
System.Nullable<System.Double>	interpaletteMaxerror	Maximum inter-palette error for palette reusage.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Gifsave(filename, dither: double, effort: int, bitdepth: int, interframeMaxerror: double, reoptimise: bool, interpaletteMaxerror: double, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

GifsaveBuffer(Nullable<Double>, Nullable<Int32>, Nullable<Int32>, Nullable<Double>, Nullable<Boolean>, Nullable<Double>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save as gif.

Declaration

public byte[] GifsaveBuffer(double? dither = null, int? effort = null, int? bitdepth = null, double? interframeMaxerror = null, bool? reoptimise = null, double? interpaletteMaxerror = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	dither	Amount of dithering.
System.Nullable<System.Int32>	effort	Quantisation effort.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Double>	interframeMaxerror	Maximum inter-frame error for transparency.
System.Nullable<System.Boolean>	reoptimise	Reoptimise colour palettes.
System.Nullable<System.Double>	interpaletteMaxerror	Maximum inter-palette error for palette reusage.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.GifsaveBuffer(dither: double, effort: int, bitdepth: int, interframeMaxerror: double, reoptimise: bool, interpaletteMaxerror: double, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

GifsaveStream(Stream, Nullable<Double>, Nullable<Int32>, Nullable<Int32>, Nullable<Double>, Nullable<Boolean>, Nullable<Double>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save as gif.

Declaration

public void GifsaveStream(Stream stream, double? dither = null, int? effort = null, int? bitdepth = null, double? interframeMaxerror = null, bool? reoptimise = null, double? interpaletteMaxerror = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.Nullable<System.Double>	dither	Amount of dithering.
System.Nullable<System.Int32>	effort	Quantisation effort.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Double>	interframeMaxerror	Maximum inter-frame error for transparency.
System.Nullable<System.Boolean>	reoptimise	Reoptimise colour palettes.
System.Nullable<System.Double>	interpaletteMaxerror	Maximum inter-palette error for palette reusage.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.GifsaveStream(stream, dither: double, effort: int, bitdepth: int, interframeMaxerror: double, reoptimise: bool, interpaletteMaxerror: double, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

GifsaveTarget(Target, Nullable<Double>, Nullable<Int32>, Nullable<Int32>, Nullable<Double>, Nullable<Boolean>, Nullable<Double>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save as gif.

Declaration

public void GifsaveTarget(Target target, double? dither = null, int? effort = null, int? bitdepth = null, double? interframeMaxerror = null, bool? reoptimise = null, double? interpaletteMaxerror = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.Nullable<System.Double>	dither	Amount of dithering.
System.Nullable<System.Int32>	effort	Quantisation effort.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Double>	interframeMaxerror	Maximum inter-frame error for transparency.
System.Nullable<System.Boolean>	reoptimise	Reoptimise colour palettes.
System.Nullable<System.Double>	interpaletteMaxerror	Maximum inter-palette error for palette reusage.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.GifsaveTarget(target, dither: double, effort: int, bitdepth: int, interframeMaxerror: double, reoptimise: bool, interpaletteMaxerror: double, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Globalbalance(Nullable<Double>, Nullable<Boolean>)

Global balance an image mosaic.

Declaration

public Image Globalbalance(double? gamma = null, bool? intOutput = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	gamma	Image gamma.
System.Nullable<System.Boolean>	intOutput	Integer output.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Globalbalance(gamma: double, intOutput: bool);

| Improve this Doc View Source

Gravity(Enums.CompassDirection, Int32, Int32, Nullable<Enums.Extend>, Double[])

Place an image within a larger image with a certain gravity.

Declaration

public Image Gravity(Enums.CompassDirection direction, int width, int height, Enums.Extend? extend = null, double[] background = null)

Parameters

Type	Name	Description
Enums.CompassDirection	direction	Direction to place image within width/height.
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Nullable<Enums.Extend>	extend	How to generate the extra pixels.
System.Double[]	background	Color for background pixels.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Gravity(direction, width, height, extend: Enums.Extend, background: double[]);

| Improve this Doc View Source

Grey(Int32, Int32, Nullable<Boolean>)

Make a grey ramp image.

Declaration

public static Image Grey(int width, int height, bool? uchar = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Grey(width, height, uchar: bool);

| Improve this Doc View Source

Grid(Int32, Int32, Int32)

Grid an image.

Declaration

public Image Grid(int tileHeight, int across, int down)

Parameters

Type	Name	Description
System.Int32	tileHeight	Chop into tiles this high.
System.Int32	across	Number of tiles across.
System.Int32	down	Number of tiles down.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Grid(tileHeight, across, down);

| Improve this Doc View Source

HasAlpha()

Does this image have an alpha channel?

Declaration

public bool HasAlpha()

Returns

Type	Description
System.Boolean	true if this image has an alpha channel; otherwise, false.

Remarks

Uses colour space interpretation with number of channels to guess this.

| Improve this Doc View Source

Heifload(String, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image Heifload(string filename, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Heifload(filename, out var flags, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Heifload(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image Heifload(string filename, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Heifload(filename, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

HeifloadBuffer(Byte[], out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image HeifloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.HeifloadBuffer(buffer, out var flags, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

HeifloadBuffer(Byte[], Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image HeifloadBuffer(byte[] buffer, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.HeifloadBuffer(buffer, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

HeifloadSource(Source, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image HeifloadSource(Source source, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.HeifloadSource(source, out var flags, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

HeifloadSource(Source, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image HeifloadSource(Source source, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.HeifloadSource(source, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

HeifloadStream(Stream, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image HeifloadStream(Stream stream, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.HeifloadStream(stream, out var flags, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

HeifloadStream(Stream, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load a HEIF image.

Declaration

public static Image HeifloadStream(Stream stream, int? page = null, int? n = null, bool? thumbnail = null, bool? unlimited = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	thumbnail	Fetch thumbnail image.
System.Nullable<System.Boolean>	unlimited	Remove all denial of service limits.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.HeifloadStream(stream, page: int, n: int, thumbnail: bool, unlimited: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Heifsave(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignHeifCompression>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in HEIF format.

Declaration

public void Heifsave(string filename, int? q = null, int? bitdepth = null, bool? lossless = null, Enums.ForeignHeifCompression? compression = null, int? effort = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<Enums.ForeignHeifCompression>	compression	Compression format.
System.Nullable<System.Int32>	effort	CPU effort.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Heifsave(filename, q: int, bitdepth: int, lossless: bool, compression: Enums.ForeignHeifCompression, effort: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

HeifsaveBuffer(Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignHeifCompression>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in HEIF format.

Declaration

public byte[] HeifsaveBuffer(int? q = null, int? bitdepth = null, bool? lossless = null, Enums.ForeignHeifCompression? compression = null, int? effort = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<Enums.ForeignHeifCompression>	compression	Compression format.
System.Nullable<System.Int32>	effort	CPU effort.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.HeifsaveBuffer(q: int, bitdepth: int, lossless: bool, compression: Enums.ForeignHeifCompression, effort: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

HeifsaveStream(Stream, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignHeifCompression>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in HEIF format.

Declaration

public void HeifsaveStream(Stream stream, int? q = null, int? bitdepth = null, bool? lossless = null, Enums.ForeignHeifCompression? compression = null, int? effort = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<Enums.ForeignHeifCompression>	compression	Compression format.
System.Nullable<System.Int32>	effort	CPU effort.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.HeifsaveStream(stream, q: int, bitdepth: int, lossless: bool, compression: Enums.ForeignHeifCompression, effort: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

HeifsaveTarget(Target, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.ForeignHeifCompression>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in HEIF format.

Declaration

public void HeifsaveTarget(Target target, int? q = null, int? bitdepth = null, bool? lossless = null, Enums.ForeignHeifCompression? compression = null, int? effort = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<Enums.ForeignHeifCompression>	compression	Compression format.
System.Nullable<System.Int32>	effort	CPU effort.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.HeifsaveTarget(target, q: int, bitdepth: int, lossless: bool, compression: Enums.ForeignHeifCompression, effort: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

HistCum()

Form cumulative histogram.

Declaration

public Image HistCum()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistCum();

| Improve this Doc View Source

HistEntropy()

Estimate image entropy.

Declaration

public double HistEntropy()

Returns

Type	Description
System.Double	A double.

Examples

double @out = in.HistEntropy();

| Improve this Doc View Source

HistEqual(Nullable<Int32>)

Histogram equalisation.

Declaration

public Image HistEqual(int? band = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	band	Equalise with this band.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistEqual(band: int);

| Improve this Doc View Source

HistFind(Nullable<Int32>)

Find image histogram.

Declaration

public Image HistFind(int? band = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	band	Find histogram of band.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistFind(band: int);

| Improve this Doc View Source

HistFindIndexed(Image, Nullable<Enums.Combine>)

Find indexed image histogram.

Declaration

public Image HistFindIndexed(Image index, Enums.Combine? combine = null)

Parameters

Type	Name	Description
Image	index	Index image.
System.Nullable<Enums.Combine>	combine	Combine bins like this.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistFindIndexed(index, combine: Enums.Combine);

| Improve this Doc View Source

HistFindNdim(Nullable<Int32>)

Find n-dimensional image histogram.

Declaration

public Image HistFindNdim(int? bins = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	bins	Number of bins in each dimension.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistFindNdim(bins: int);

| Improve this Doc View Source

HistIsmonotonic()

Test for monotonicity.

Declaration

public bool HistIsmonotonic()

Returns

Type	Description
System.Boolean	A bool.

Examples

bool monotonic = in.HistIsmonotonic();

| Improve this Doc View Source

HistLocal(Int32, Int32, Nullable<Int32>)

Local histogram equalisation.

Declaration

public Image HistLocal(int width, int height, int? maxSlope = null)

Parameters

Type	Name	Description
System.Int32	width	Window width in pixels.
System.Int32	height	Window height in pixels.
System.Nullable<System.Int32>	maxSlope	Maximum slope (CLAHE).

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistLocal(width, height, maxSlope: int);

| Improve this Doc View Source

HistMatch(Image)

Match two histograms.

Declaration

public Image HistMatch(Image ref)

Parameters

Type	Name	Description
Image	ref	Reference histogram.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistMatch(@ref);

| Improve this Doc View Source

HistNorm()

Normalise histogram.

Declaration

public Image HistNorm()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistNorm();

| Improve this Doc View Source

HistPlot()

Plot histogram.

Declaration

public Image HistPlot()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HistPlot();

| Improve this Doc View Source

HoughCircle(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>)

Find hough circle transform.

Declaration

public Image HoughCircle(int? scale = null, int? minRadius = null, int? maxRadius = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	scale	Scale down dimensions by this factor.
System.Nullable<System.Int32>	minRadius	Smallest radius to search for.
System.Nullable<System.Int32>	maxRadius	Largest radius to search for.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HoughCircle(scale: int, minRadius: int, maxRadius: int);

| Improve this Doc View Source

HoughLine(Nullable<Int32>, Nullable<Int32>)

Find hough line transform.

Declaration

public Image HoughLine(int? width = null, int? height = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	width	Horizontal size of parameter space.
System.Nullable<System.Int32>	height	Vertical size of parameter space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HoughLine(width: int, height: int);

| Improve this Doc View Source

HSV2sRGB()

Transform HSV to sRGB.

Declaration

public Image HSV2sRGB()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.HSV2sRGB();

| Improve this Doc View Source

IccExport(Nullable<Enums.PCS>, Nullable<Enums.Intent>, Nullable<Boolean>, String, Nullable<Int32>)

Output to device with ICC profile.

Declaration

public Image IccExport(Enums.PCS? pcs = null, Enums.Intent? intent = null, bool? blackPointCompensation = null, string outputProfile = null, int? depth = null)

Parameters

Type	Name	Description
System.Nullable<Enums.PCS>	pcs	Set Profile Connection Space.
System.Nullable<Enums.Intent>	intent	Rendering intent.
System.Nullable<System.Boolean>	blackPointCompensation	Enable black point compensation.
System.String	outputProfile	Filename to load output profile from.
System.Nullable<System.Int32>	depth	Output device space depth in bits.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.IccExport(pcs: Enums.PCS, intent: Enums.Intent, blackPointCompensation: bool, outputProfile: string, depth: int);

| Improve this Doc View Source

IccImport(Nullable<Enums.PCS>, Nullable<Enums.Intent>, Nullable<Boolean>, Nullable<Boolean>, String)

Import from device with ICC profile.

Declaration

public Image IccImport(Enums.PCS? pcs = null, Enums.Intent? intent = null, bool? blackPointCompensation = null, bool? embedded = null, string inputProfile = null)

Parameters

Type	Name	Description
System.Nullable<Enums.PCS>	pcs	Set Profile Connection Space.
System.Nullable<Enums.Intent>	intent	Rendering intent.
System.Nullable<System.Boolean>	blackPointCompensation	Enable black point compensation.
System.Nullable<System.Boolean>	embedded	Use embedded input profile, if available.
System.String	inputProfile	Filename to load input profile from.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.IccImport(pcs: Enums.PCS, intent: Enums.Intent, blackPointCompensation: bool, embedded: bool, inputProfile: string);

| Improve this Doc View Source

IccTransform(String, Nullable<Enums.PCS>, Nullable<Enums.Intent>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Int32>)

Transform between devices with ICC profiles.

Declaration

public Image IccTransform(string outputProfile, Enums.PCS? pcs = null, Enums.Intent? intent = null, bool? blackPointCompensation = null, bool? embedded = null, string inputProfile = null, int? depth = null)

Parameters

Type	Name	Description
System.String	outputProfile	Filename to load output profile from.
System.Nullable<Enums.PCS>	pcs	Set Profile Connection Space.
System.Nullable<Enums.Intent>	intent	Rendering intent.
System.Nullable<System.Boolean>	blackPointCompensation	Enable black point compensation.
System.Nullable<System.Boolean>	embedded	Use embedded input profile, if available.
System.String	inputProfile	Filename to load input profile from.
System.Nullable<System.Int32>	depth	Output device space depth in bits.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.IccTransform(outputProfile, pcs: Enums.PCS, intent: Enums.Intent, blackPointCompensation: bool, embedded: bool, inputProfile: string, depth: int);

| Improve this Doc View Source

Identity(Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>)

Make a 1D image where pixel values are indexes.

Declaration

public static Image Identity(int? bands = null, bool? ushort = null, int? size = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	bands	Number of bands in LUT.
System.Nullable<System.Boolean>	ushort	Create a 16-bit LUT.
System.Nullable<System.Int32>	size	Size of 16-bit LUT.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Identity(bands: int, @ushort: bool, size: int);

| Improve this Doc View Source

Ifthenelse(Object, Object, Nullable<Boolean>)

Ifthenelse an image.

Declaration

public Image Ifthenelse(object in1, object in2, bool? blend = null)

Parameters

Type	Name	Description
System.Object	in1	Source for TRUE pixels.
System.Object	in2	Source for FALSE pixels.
System.Nullable<System.Boolean>	blend	Blend smoothly between then and else parts.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = cond.Ifthenelse(in1, in2, blend: bool);

| Improve this Doc View Source

Imag()

Return the imaginary part of a complex image.

Declaration

public Image Imag()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Imageize(Image, Object)

Turn a constant (eg. 1, "12", new[] {1, 2, 3}, new[] {new[] {1}}) into an image using matchImage as a guide.

Declaration

public static Image Imageize(Image matchImage, object value)

Parameters

Type	Name	Description
Image	matchImage	Image guide.
System.Object	value	A constant.

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Insert(Image, Int32, Int32, Nullable<Boolean>, Double[])

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

Declaration

public Image Insert(Image sub, int x, int y, bool? expand = null, double[] background = null)

Parameters

Type	Name	Description
Image	sub	Sub-image to insert into main image.
System.Int32	x	Left edge of sub in main.
System.Int32	y	Top edge of sub in main.
System.Nullable<System.Boolean>	expand	Expand output to hold all of both inputs.
System.Double[]	background	Color for new pixels.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = main.Insert(sub, x, y, expand: bool, background: double[]);

| Improve this Doc View Source

Invert()

Invert an image.

Declaration

public Image Invert()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Invert();

| Improve this Doc View Source

Invertlut(Nullable<Int32>)

Build an inverted look-up table.

Declaration

public Image Invertlut(int? size = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	size	LUT size to generate.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Invertlut(size: int);

| Improve this Doc View Source

Invfft(Nullable<Boolean>)

Inverse FFT.

Declaration

public Image Invfft(bool? real = null)

Parameters

Type	Name	Description
System.Nullable<System.Boolean>	real	Output only the real part of the transform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Invfft(real: bool);

| Improve this Doc View Source

IsKilled()

If image has been killed (see SetKill(Boolean)), set an error message, clear the kill flag and return true. Otherwise return false.

Declaration

public bool IsKilled()

Returns

Type	Description
System.Boolean	true if image has been killed; otherwise, false.

Remarks

Handy for loops which need to run sets of threads which can fail. At least libvips 8.8 is needed. If this version requirement is not met, it will always return false.

| Improve this Doc View Source

Join(Image, Enums.Direction, Nullable<Boolean>, Nullable<Int32>, Double[], Nullable<Enums.Align>)

Join a pair of images.

Declaration

public Image Join(Image in2, Enums.Direction direction, bool? expand = null, int? shim = null, double[] background = null, Enums.Align? align = null)

Parameters

Type	Name	Description
Image	in2	Second input image.
Enums.Direction	direction	Join left-right or up-down.
System.Nullable<System.Boolean>	expand	Expand output to hold all of both inputs.
System.Nullable<System.Int32>	shim	Pixels between images.
System.Double[]	background	Colour for new pixels.
System.Nullable<Enums.Align>	align	Align on the low, centre or high coordinate edge.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in1.Join(in2, direction, expand: bool, shim: int, background: double[], align: Enums.Align);

| Improve this Doc View Source

Jp2kload(String, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kload(string filename, out Enums.ForeignFlags flags, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kload(filename, out var flags, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kload(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kload(string filename, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kload(filename, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kloadBuffer(Byte[], out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kloadBuffer(buffer, out var flags, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kloadBuffer(Byte[], Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kloadBuffer(byte[] buffer, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kloadBuffer(buffer, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kloadSource(Source, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kloadSource(Source source, out Enums.ForeignFlags flags, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kloadSource(source, out var flags, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kloadSource(Source, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kloadSource(Source source, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kloadSource(source, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kloadStream(Stream, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kloadStream(Stream stream, out Enums.ForeignFlags flags, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kloadStream(stream, out var flags, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2kloadStream(Stream, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG2000 image.

Declaration

public static Image Jp2kloadStream(Stream stream, int? page = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Int32>	page	Load this page from the image.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jp2kloadStream(stream, page: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jp2ksave(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG2000 format.

Declaration

public void Jp2ksave(string filename, int? tileWidth = null, int? tileHeight = null, bool? lossless = null, int? q = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	tileWidth	Tile width in pixels.
System.Nullable<System.Int32>	tileHeight	Tile height in pixels.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Jp2ksave(filename, tileWidth: int, tileHeight: int, lossless: bool, q: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Jp2ksaveBuffer(Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG2000 format.

Declaration

public byte[] Jp2ksaveBuffer(int? tileWidth = null, int? tileHeight = null, bool? lossless = null, int? q = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	tileWidth	Tile width in pixels.
System.Nullable<System.Int32>	tileHeight	Tile height in pixels.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.Jp2ksaveBuffer(tileWidth: int, tileHeight: int, lossless: bool, q: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Jp2ksaveStream(Stream, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG2000 format.

Declaration

public void Jp2ksaveStream(Stream stream, int? tileWidth = null, int? tileHeight = null, bool? lossless = null, int? q = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.Nullable<System.Int32>	tileWidth	Tile width in pixels.
System.Nullable<System.Int32>	tileHeight	Tile height in pixels.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Jp2ksaveStream(stream, tileWidth: int, tileHeight: int, lossless: bool, q: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Jp2ksaveTarget(Target, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG2000 format.

Declaration

public void Jp2ksaveTarget(Target target, int? tileWidth = null, int? tileHeight = null, bool? lossless = null, int? q = null, Enums.ForeignSubsample? subsampleMode = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.Nullable<System.Int32>	tileWidth	Tile width in pixels.
System.Nullable<System.Int32>	tileHeight	Tile height in pixels.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Q factor.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Jp2ksaveTarget(target, tileWidth: int, tileHeight: int, lossless: bool, q: int, subsampleMode: Enums.ForeignSubsample, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Jpegload(String, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load jpeg from file.

Declaration

public static Image Jpegload(string filename, out Enums.ForeignFlags flags, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jpegload(filename, out var flags, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jpegload(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load jpeg from file.

Declaration

public static Image Jpegload(string filename, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jpegload(filename, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JpegloadBuffer(Byte[], out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load jpeg from buffer.

Declaration

public static Image JpegloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JpegloadBuffer(buffer, out var flags, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JpegloadBuffer(Byte[], Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load jpeg from buffer.

Declaration

public static Image JpegloadBuffer(byte[] buffer, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JpegloadBuffer(buffer, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JpegloadSource(Source, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load image from jpeg source.

Declaration

public static Image JpegloadSource(Source source, out Enums.ForeignFlags flags, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JpegloadSource(source, out var flags, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JpegloadSource(Source, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load image from jpeg source.

Declaration

public static Image JpegloadSource(Source source, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JpegloadSource(source, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JpegloadStream(Stream, out Enums.ForeignFlags, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load image from jpeg stream.

Declaration

public static Image JpegloadStream(Stream stream, out Enums.ForeignFlags flags, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JpegloadStream(stream, out var flags, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JpegloadStream(Stream, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load image from jpeg stream.

Declaration

public static Image JpegloadStream(Stream stream, int? shrink = null, bool? autorotate = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Int32>	shrink	Shrink factor on load.
System.Nullable<System.Boolean>	autorotate	Rotate image using exif orientation.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JpegloadStream(stream, shrink: int, autorotate: bool, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jpegsave(String, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to jpeg file.

Declaration

public void Jpegsave(string filename, int? q = null, string profile = null, bool? optimizeCoding = null, bool? interlace = null, bool? trellisQuant = null, bool? overshootDeringing = null, bool? optimizeScans = null, int? quantTable = null, Enums.ForeignSubsample? subsampleMode = null, int? restartInterval = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.Nullable<System.Int32>	q	Q factor.
System.String	profile	ICC profile to embed.
System.Nullable<System.Boolean>	optimizeCoding	Compute optimal Huffman coding tables.
System.Nullable<System.Boolean>	interlace	Generate an interlaced (progressive) jpeg.
System.Nullable<System.Boolean>	trellisQuant	Apply trellis quantisation to each 8x8 block.
System.Nullable<System.Boolean>	overshootDeringing	Apply overshooting to samples with extreme values.
System.Nullable<System.Boolean>	optimizeScans	Split spectrum of DCT coefficients into separate scans.
System.Nullable<System.Int32>	quantTable	Use predefined quantization table with given index.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Int32>	restartInterval	Add restart markers every specified number of mcu.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Jpegsave(filename, q: int, profile: string, optimizeCoding: bool, interlace: bool, trellisQuant: bool, overshootDeringing: bool, optimizeScans: bool, quantTable: int, subsampleMode: Enums.ForeignSubsample, restartInterval: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JpegsaveBuffer(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to jpeg buffer.

Declaration

public byte[] JpegsaveBuffer(int? q = null, string profile = null, bool? optimizeCoding = null, bool? interlace = null, bool? trellisQuant = null, bool? overshootDeringing = null, bool? optimizeScans = null, int? quantTable = null, Enums.ForeignSubsample? subsampleMode = null, int? restartInterval = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	q	Q factor.
System.String	profile	ICC profile to embed.
System.Nullable<System.Boolean>	optimizeCoding	Compute optimal Huffman coding tables.
System.Nullable<System.Boolean>	interlace	Generate an interlaced (progressive) jpeg.
System.Nullable<System.Boolean>	trellisQuant	Apply trellis quantisation to each 8x8 block.
System.Nullable<System.Boolean>	overshootDeringing	Apply overshooting to samples with extreme values.
System.Nullable<System.Boolean>	optimizeScans	Split spectrum of DCT coefficients into separate scans.
System.Nullable<System.Int32>	quantTable	Use predefined quantization table with given index.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Int32>	restartInterval	Add restart markers every specified number of mcu.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.JpegsaveBuffer(q: int, profile: string, optimizeCoding: bool, interlace: bool, trellisQuant: bool, overshootDeringing: bool, optimizeScans: bool, quantTable: int, subsampleMode: Enums.ForeignSubsample, restartInterval: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JpegsaveMime(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to jpeg mime.

Declaration

public void JpegsaveMime(int? q = null, string profile = null, bool? optimizeCoding = null, bool? interlace = null, bool? trellisQuant = null, bool? overshootDeringing = null, bool? optimizeScans = null, int? quantTable = null, Enums.ForeignSubsample? subsampleMode = null, int? restartInterval = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	q	Q factor.
System.String	profile	ICC profile to embed.
System.Nullable<System.Boolean>	optimizeCoding	Compute optimal Huffman coding tables.
System.Nullable<System.Boolean>	interlace	Generate an interlaced (progressive) jpeg.
System.Nullable<System.Boolean>	trellisQuant	Apply trellis quantisation to each 8x8 block.
System.Nullable<System.Boolean>	overshootDeringing	Apply overshooting to samples with extreme values.
System.Nullable<System.Boolean>	optimizeScans	Split spectrum of DCT coefficients into separate scans.
System.Nullable<System.Int32>	quantTable	Use predefined quantization table with given index.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Int32>	restartInterval	Add restart markers every specified number of mcu.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.JpegsaveMime(q: int, profile: string, optimizeCoding: bool, interlace: bool, trellisQuant: bool, overshootDeringing: bool, optimizeScans: bool, quantTable: int, subsampleMode: Enums.ForeignSubsample, restartInterval: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JpegsaveStream(Stream, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to jpeg stream.

Declaration

public void JpegsaveStream(Stream stream, int? q = null, string profile = null, bool? optimizeCoding = null, bool? interlace = null, bool? trellisQuant = null, bool? overshootDeringing = null, bool? optimizeScans = null, int? quantTable = null, Enums.ForeignSubsample? subsampleMode = null, int? restartInterval = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.Nullable<System.Int32>	q	Q factor.
System.String	profile	ICC profile to embed.
System.Nullable<System.Boolean>	optimizeCoding	Compute optimal Huffman coding tables.
System.Nullable<System.Boolean>	interlace	Generate an interlaced (progressive) jpeg.
System.Nullable<System.Boolean>	trellisQuant	Apply trellis quantisation to each 8x8 block.
System.Nullable<System.Boolean>	overshootDeringing	Apply overshooting to samples with extreme values.
System.Nullable<System.Boolean>	optimizeScans	Split spectrum of DCT coefficients into separate scans.
System.Nullable<System.Int32>	quantTable	Use predefined quantization table with given index.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Int32>	restartInterval	Add restart markers every specified number of mcu.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.JpegsaveStream(stream, q: int, profile: string, optimizeCoding: bool, interlace: bool, trellisQuant: bool, overshootDeringing: bool, optimizeScans: bool, quantTable: int, subsampleMode: Enums.ForeignSubsample, restartInterval: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JpegsaveTarget(Target, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Enums.ForeignSubsample>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to jpeg target.

Declaration

public void JpegsaveTarget(Target target, int? q = null, string profile = null, bool? optimizeCoding = null, bool? interlace = null, bool? trellisQuant = null, bool? overshootDeringing = null, bool? optimizeScans = null, int? quantTable = null, Enums.ForeignSubsample? subsampleMode = null, int? restartInterval = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.Nullable<System.Int32>	q	Q factor.
System.String	profile	ICC profile to embed.
System.Nullable<System.Boolean>	optimizeCoding	Compute optimal Huffman coding tables.
System.Nullable<System.Boolean>	interlace	Generate an interlaced (progressive) jpeg.
System.Nullable<System.Boolean>	trellisQuant	Apply trellis quantisation to each 8x8 block.
System.Nullable<System.Boolean>	overshootDeringing	Apply overshooting to samples with extreme values.
System.Nullable<System.Boolean>	optimizeScans	Split spectrum of DCT coefficients into separate scans.
System.Nullable<System.Int32>	quantTable	Use predefined quantization table with given index.
System.Nullable<Enums.ForeignSubsample>	subsampleMode	Select chroma subsample operation mode.
System.Nullable<System.Int32>	restartInterval	Add restart markers every specified number of mcu.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.JpegsaveTarget(target, q: int, profile: string, optimizeCoding: bool, interlace: bool, trellisQuant: bool, overshootDeringing: bool, optimizeScans: bool, quantTable: int, subsampleMode: Enums.ForeignSubsample, restartInterval: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Jxlload(String, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image Jxlload(string filename, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jxlload(filename, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jxlload(String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image Jxlload(string filename, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Jxlload(filename, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JxlloadBuffer(Byte[], out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image JxlloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JxlloadBuffer(buffer, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JxlloadBuffer(Byte[], Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image JxlloadBuffer(byte[] buffer, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JxlloadBuffer(buffer, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JxlloadSource(Source, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image JxlloadSource(Source source, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JxlloadSource(source, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JxlloadSource(Source, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image JxlloadSource(Source source, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JxlloadSource(source, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JxlloadStream(Stream, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image JxlloadStream(Stream stream, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JxlloadStream(stream, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

JxlloadStream(Stream, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load JPEG-XL image.

Declaration

public static Image JxlloadStream(Stream stream, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.JxlloadStream(stream, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Jxlsave(String, Nullable<Int32>, Nullable<Double>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG-XL format.

Declaration

public void Jxlsave(string filename, int? tier = null, double? distance = null, int? effort = null, bool? lossless = null, int? q = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Int32>	tier	Decode speed tier.
System.Nullable<System.Double>	distance	Target butteraugli distance.
System.Nullable<System.Int32>	effort	Encoding effort.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Quality factor.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Jxlsave(filename, tier: int, distance: double, effort: int, lossless: bool, q: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JxlsaveBuffer(Nullable<Int32>, Nullable<Double>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG-XL format.

Declaration

public byte[] JxlsaveBuffer(int? tier = null, double? distance = null, int? effort = null, bool? lossless = null, int? q = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	tier	Decode speed tier.
System.Nullable<System.Double>	distance	Target butteraugli distance.
System.Nullable<System.Int32>	effort	Encoding effort.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Quality factor.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.JxlsaveBuffer(tier: int, distance: double, effort: int, lossless: bool, q: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JxlsaveStream(Stream, Nullable<Int32>, Nullable<Double>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG-XL format.

Declaration

public void JxlsaveStream(Stream stream, int? tier = null, double? distance = null, int? effort = null, bool? lossless = null, int? q = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.Nullable<System.Int32>	tier	Decode speed tier.
System.Nullable<System.Double>	distance	Target butteraugli distance.
System.Nullable<System.Int32>	effort	Encoding effort.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Quality factor.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.JxlsaveStream(stream, tier: int, distance: double, effort: int, lossless: bool, q: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

JxlsaveTarget(Target, Nullable<Int32>, Nullable<Double>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image in JPEG-XL format.

Declaration

public void JxlsaveTarget(Target target, int? tier = null, double? distance = null, int? effort = null, bool? lossless = null, int? q = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.Nullable<System.Int32>	tier	Decode speed tier.
System.Nullable<System.Double>	distance	Target butteraugli distance.
System.Nullable<System.Int32>	effort	Encoding effort.
System.Nullable<System.Boolean>	lossless	Enable lossless compression.
System.Nullable<System.Int32>	q	Quality factor.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.JxlsaveTarget(target, tier: int, distance: double, effort: int, lossless: bool, q: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Lab2LabQ()

Transform float Lab to LabQ coding.

Declaration

public Image Lab2LabQ()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Lab2LabQ();

| Improve this Doc View Source

Lab2LabS()

Transform float Lab to signed short.

Declaration

public Image Lab2LabS()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Lab2LabS();

| Improve this Doc View Source

Lab2LCh()

Transform Lab to LCh.

Declaration

public Image Lab2LCh()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Lab2LCh();

| Improve this Doc View Source

Lab2XYZ(Double[])

Transform CIELAB to XYZ.

Declaration

public Image Lab2XYZ(double[] temp = null)

Parameters

Type	Name	Description
System.Double[]	temp	Color temperature.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Lab2XYZ(temp: double[]);

| Improve this Doc View Source

Labelregions()

Label regions in an image.

Declaration

public Image Labelregions()

Returns

Type	Description
Image	A new Image.

Examples

using Image mask = in.Labelregions();

| Improve this Doc View Source

Labelregions(out Int32)

Label regions in an image.

Declaration

public Image Labelregions(out int segments)

Parameters

Type	Name	Description
System.Int32	segments	Number of discrete contiguous regions.

Returns

Type	Description
Image	A new Image.

Examples

using Image mask = in.Labelregions(out var segments);

| Improve this Doc View Source

LabQ2Lab()

Unpack a LabQ image to float Lab.

Declaration

public Image LabQ2Lab()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LabQ2Lab();

| Improve this Doc View Source

LabQ2LabS()

Unpack a LabQ image to short Lab.

Declaration

public Image LabQ2LabS()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LabQ2LabS();

| Improve this Doc View Source

LabQ2sRGB()

Convert a LabQ image to sRGB.

Declaration

public Image LabQ2sRGB()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LabQ2sRGB();

| Improve this Doc View Source

LabS2Lab()

Transform signed short Lab to float.

Declaration

public Image LabS2Lab()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LabS2Lab();

| Improve this Doc View Source

LabS2LabQ()

Transform short Lab to LabQ coding.

Declaration

public Image LabS2LabQ()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LabS2LabQ();

| Improve this Doc View Source

LCh2CMC()

Transform LCh to CMC.

Declaration

public Image LCh2CMC()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LCh2CMC();

| Improve this Doc View Source

LCh2Lab()

Transform LCh to Lab.

Declaration

public Image LCh2Lab()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.LCh2Lab();

| Improve this Doc View Source

Linear(Double[], Double[], Nullable<Boolean>)

Calculate (a * in + b).

Declaration

public Image Linear(double[] a, double[] b, bool? uchar = null)

Parameters

Type	Name	Description
System.Double[]	a	Multiply by this.
System.Double[]	b	Add this.
System.Nullable<System.Boolean>	uchar	Output should be uchar.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Linear(a, b, uchar: bool);

| Improve this Doc View Source

Linecache(Nullable<Int32>, Nullable<Enums.Access>, Nullable<Boolean>, Nullable<Boolean>)

Cache an image as a set of lines.

Declaration

public Image Linecache(int? tileHeight = null, Enums.Access? access = null, bool? threaded = null, bool? persistent = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	tileHeight	Tile height in pixels.
System.Nullable<Enums.Access>	access	Expected access pattern.
System.Nullable<System.Boolean>	threaded	Allow threaded access.
System.Nullable<System.Boolean>	persistent	Keep cache between evaluations.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Linecache(tileHeight: int, access: Enums.Access, threaded: bool, persistent: bool);

| Improve this Doc View Source

Log()

Return the natural log of an image.

Declaration

public Image Log()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Log10()

Return the log base 10 of an image.

Declaration

public Image Log10()

Returns

Type	Description
Image	A new Image.

| Improve this Doc View Source

Logmat(Double, Double, Nullable<Boolean>, Nullable<Enums.Precision>)

Make a Laplacian of Gaussian image.

Declaration

public static Image Logmat(double sigma, double minAmpl, bool? separable = null, Enums.Precision? precision = null)

Parameters

Type	Name	Description
System.Double	sigma	Radius of Gaussian.
System.Double	minAmpl	Minimum amplitude of Gaussian.
System.Nullable<System.Boolean>	separable	Generate separable Gaussian.
System.Nullable<Enums.Precision>	precision	Generate with this precision.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Logmat(sigma, minAmpl, separable: bool, precision: Enums.Precision);

| Improve this Doc View Source

Magickload(String, out Enums.ForeignFlags, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load file with ImageMagick.

Declaration

public static Image Magickload(string filename, out Enums.ForeignFlags flags, string density = null, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.String	density	Canvas resolution for rendering vector formats like SVG.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Magickload(filename, out var flags, density: string, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Magickload(String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load file with ImageMagick.

Declaration

public static Image Magickload(string filename, string density = null, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.String	density	Canvas resolution for rendering vector formats like SVG.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Magickload(filename, density: string, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

MagickloadBuffer(Byte[], out Enums.ForeignFlags, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load buffer with ImageMagick.

Declaration

public static Image MagickloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, string density = null, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.String	density	Canvas resolution for rendering vector formats like SVG.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MagickloadBuffer(buffer, out var flags, density: string, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

MagickloadBuffer(Byte[], String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load buffer with ImageMagick.

Declaration

public static Image MagickloadBuffer(byte[] buffer, string density = null, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.Byte[]	buffer	Buffer to load from.
System.String	density	Canvas resolution for rendering vector formats like SVG.
System.Nullable<System.Int32>	page	Load this page from the file.
System.Nullable<System.Int32>	n	Load this many pages.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MagickloadBuffer(buffer, density: string, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Magicksave(String, String, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save file with ImageMagick.

Declaration

public void Magicksave(string filename, string format = null, int? quality = null, bool? optimizeGifFrames = null, bool? optimizeGifTransparency = null, int? bitdepth = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.String	format	Format to save in.
System.Nullable<System.Int32>	quality	Quality to use.
System.Nullable<System.Boolean>	optimizeGifFrames	Apply GIF frames optimization.
System.Nullable<System.Boolean>	optimizeGifTransparency	Apply GIF transparency optimization.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Magicksave(filename, format: string, quality: int, optimizeGifFrames: bool, optimizeGifTransparency: bool, bitdepth: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

MagicksaveBuffer(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to magick buffer.

Declaration

public byte[] MagicksaveBuffer(string format = null, int? quality = null, bool? optimizeGifFrames = null, bool? optimizeGifTransparency = null, int? bitdepth = null, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	format	Format to save in.
System.Nullable<System.Int32>	quality	Quality to use.
System.Nullable<System.Boolean>	optimizeGifFrames	Apply GIF frames optimization.
System.Nullable<System.Boolean>	optimizeGifTransparency	Apply GIF transparency optimization.
System.Nullable<System.Int32>	bitdepth	Number of bits per pixel.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Returns

Type	Description
System.Byte[]	An array of bytes.

Examples

byte[] buffer = in.MagicksaveBuffer(format: string, quality: int, optimizeGifFrames: bool, optimizeGifTransparency: bool, bitdepth: int, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Mapim(Image, GObject, Double[], Nullable<Boolean>, Nullable<Enums.Extend>)

Resample with a map image.

Declaration

public Image Mapim(Image index, GObject interpolate = null, double[] background = null, bool? premultiplied = null, Enums.Extend? extend = null)

Parameters

Type	Name	Description
Image	index	Index pixels with this.
GObject	interpolate	Interpolate pixels with this.
System.Double[]	background	Background value.
System.Nullable<System.Boolean>	premultiplied	Images have premultiplied alpha.
System.Nullable<Enums.Extend>	extend	How to generate the extra pixels.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Mapim(index, interpolate: GObject, background: double[], premultiplied: bool, extend: Enums.Extend);

| Improve this Doc View Source

Maplut(Image, Nullable<Int32>)

Map an image though a lut.

Declaration

public Image Maplut(Image lut, int? band = null)

Parameters

Type	Name	Description
Image	lut	Look-up table image.
System.Nullable<System.Int32>	band	Apply one-band lut to this band of in.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Maplut(lut, band: int);

| Improve this Doc View Source

MaskButterworth(Int32, Int32, Double, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make a butterworth filter.

Declaration

public static Image MaskButterworth(int width, int height, double order, double frequencyCutoff, double amplitudeCutoff, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	order	Filter order.
System.Double	frequencyCutoff	Frequency cutoff.
System.Double	amplitudeCutoff	Amplitude cutoff.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskButterworth(width, height, order, frequencyCutoff, amplitudeCutoff, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskButterworthBand(Int32, Int32, Double, Double, Double, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make a butterworth_band filter.

Declaration

public static Image MaskButterworthBand(int width, int height, double order, double frequencyCutoffX, double frequencyCutoffY, double radius, double amplitudeCutoff, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	order	Filter order.
System.Double	frequencyCutoffX	Frequency cutoff x.
System.Double	frequencyCutoffY	Frequency cutoff y.
System.Double	radius	Radius of circle.
System.Double	amplitudeCutoff	Amplitude cutoff.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskButterworthBand(width, height, order, frequencyCutoffX, frequencyCutoffY, radius, amplitudeCutoff, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskButterworthRing(Int32, Int32, Double, Double, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make a butterworth ring filter.

Declaration

public static Image MaskButterworthRing(int width, int height, double order, double frequencyCutoff, double amplitudeCutoff, double ringwidth, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	order	Filter order.
System.Double	frequencyCutoff	Frequency cutoff.
System.Double	amplitudeCutoff	Amplitude cutoff.
System.Double	ringwidth	Ringwidth.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskButterworthRing(width, height, order, frequencyCutoff, amplitudeCutoff, ringwidth, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskFractal(Int32, Int32, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make fractal filter.

Declaration

public static Image MaskFractal(int width, int height, double fractalDimension, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	fractalDimension	Fractal dimension.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskFractal(width, height, fractalDimension, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskGaussian(Int32, Int32, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make a gaussian filter.

Declaration

public static Image MaskGaussian(int width, int height, double frequencyCutoff, double amplitudeCutoff, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	frequencyCutoff	Frequency cutoff.
System.Double	amplitudeCutoff	Amplitude cutoff.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskGaussian(width, height, frequencyCutoff, amplitudeCutoff, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskGaussianBand(Int32, Int32, Double, Double, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make a gaussian filter.

Declaration

public static Image MaskGaussianBand(int width, int height, double frequencyCutoffX, double frequencyCutoffY, double radius, double amplitudeCutoff, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	frequencyCutoffX	Frequency cutoff x.
System.Double	frequencyCutoffY	Frequency cutoff y.
System.Double	radius	Radius of circle.
System.Double	amplitudeCutoff	Amplitude cutoff.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskGaussianBand(width, height, frequencyCutoffX, frequencyCutoffY, radius, amplitudeCutoff, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskGaussianRing(Int32, Int32, Double, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make a gaussian ring filter.

Declaration

public static Image MaskGaussianRing(int width, int height, double frequencyCutoff, double amplitudeCutoff, double ringwidth, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	frequencyCutoff	Frequency cutoff.
System.Double	amplitudeCutoff	Amplitude cutoff.
System.Double	ringwidth	Ringwidth.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskGaussianRing(width, height, frequencyCutoff, amplitudeCutoff, ringwidth, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskIdeal(Int32, Int32, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make an ideal filter.

Declaration

public static Image MaskIdeal(int width, int height, double frequencyCutoff, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	frequencyCutoff	Frequency cutoff.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskIdeal(width, height, frequencyCutoff, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskIdealBand(Int32, Int32, Double, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make an ideal band filter.

Declaration

public static Image MaskIdealBand(int width, int height, double frequencyCutoffX, double frequencyCutoffY, double radius, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	frequencyCutoffX	Frequency cutoff x.
System.Double	frequencyCutoffY	Frequency cutoff y.
System.Double	radius	Radius of circle.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskIdealBand(width, height, frequencyCutoffX, frequencyCutoffY, radius, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

MaskIdealRing(Int32, Int32, Double, Double, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Make an ideal ring filter.

Declaration

public static Image MaskIdealRing(int width, int height, double frequencyCutoff, double ringwidth, bool? uchar = null, bool? nodc = null, bool? reject = null, bool? optical = null)

Parameters

Type	Name	Description
System.Int32	width	Image width in pixels.
System.Int32	height	Image height in pixels.
System.Double	frequencyCutoff	Frequency cutoff.
System.Double	ringwidth	Ringwidth.
System.Nullable<System.Boolean>	uchar	Output an unsigned char image.
System.Nullable<System.Boolean>	nodc	Remove DC component.
System.Nullable<System.Boolean>	reject	Invert the sense of the filter.
System.Nullable<System.Boolean>	optical	Rotate quadrants to optical space.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MaskIdealRing(width, height, frequencyCutoff, ringwidth, uchar: bool, nodc: bool, reject: bool, optical: bool);

| Improve this Doc View Source

Match(Image, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, GObject)

First-order match of two images.

Declaration

public Image Match(Image sec, int xr1, int yr1, int xs1, int ys1, int xr2, int yr2, int xs2, int ys2, int? hwindow = null, int? harea = null, bool? search = null, GObject interpolate = null)

Parameters

Type	Name	Description
Image	sec	Secondary image.
System.Int32	xr1	Position of first reference tie-point.
System.Int32	yr1	Position of first reference tie-point.
System.Int32	xs1	Position of first secondary tie-point.
System.Int32	ys1	Position of first secondary tie-point.
System.Int32	xr2	Position of second reference tie-point.
System.Int32	yr2	Position of second reference tie-point.
System.Int32	xs2	Position of second secondary tie-point.
System.Int32	ys2	Position of second secondary tie-point.
System.Nullable<System.Int32>	hwindow	Half window size.
System.Nullable<System.Int32>	harea	Half area size.
System.Nullable<System.Boolean>	search	Search to improve tie-points.
GObject	interpolate	Interpolate pixels with this.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = ref.Match(sec, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, hwindow: int, harea: int, search: bool, interpolate: GObject);

| Improve this Doc View Source

Math(Enums.OperationMath)

Apply a math operation to an image.

Declaration

public Image Math(Enums.OperationMath math)

Parameters

Type	Name	Description
Enums.OperationMath	math	Math to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Math(math);

| Improve this Doc View Source

Math2(Image, Enums.OperationMath2)

Binary math operations.

Declaration

public Image Math2(Image right, Enums.OperationMath2 math2)

Parameters

Type	Name	Description
Image	right	Right-hand image argument.
Enums.OperationMath2	math2	Math to perform.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = left.Math2(right, math2);

| Improve this Doc View Source

Math2Const(Enums.OperationMath2, Double[])

Binary math operations with a constant.

Declaration

public Image Math2Const(Enums.OperationMath2 math2, double[] c)

Parameters

Type	Name	Description
Enums.OperationMath2	math2	Math to perform.
System.Double[]	c	Array of constants.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Math2Const(math2, c);

| Improve this Doc View Source

Matload(String, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load mat from file.

Declaration

public static Image Matload(string filename, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Matload(filename, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Matload(String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load mat from file.

Declaration

public static Image Matload(string filename, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Matload(filename, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Matrixinvert()

Invert an matrix.

Declaration

public Image Matrixinvert()

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = in.Matrixinvert();

| Improve this Doc View Source

Matrixload(String, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load matrix.

Declaration

public static Image Matrixload(string filename, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Matrixload(filename, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Matrixload(String, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load matrix.

Declaration

public static Image Matrixload(string filename, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.String	filename	Filename to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.Matrixload(filename, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

MatrixloadSource(Source, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load matrix.

Declaration

public static Image MatrixloadSource(Source source, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MatrixloadSource(source, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

MatrixloadSource(Source, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load matrix.

Declaration

public static Image MatrixloadSource(Source source, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
Source	source	Source to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MatrixloadSource(source, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

MatrixloadStream(Stream, out Enums.ForeignFlags, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load matrix.

Declaration

public static Image MatrixloadStream(Stream stream, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
Enums.ForeignFlags	flags	Flags for this file.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MatrixloadStream(stream, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

MatrixloadStream(Stream, Nullable<Boolean>, Nullable<Enums.Access>, Nullable<Enums.FailOn>)

Load matrix.

Declaration

public static Image MatrixloadStream(Stream stream, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to load from.
System.Nullable<System.Boolean>	memory	Force open via memory.
System.Nullable<Enums.Access>	access	Required access pattern for this file.
System.Nullable<Enums.FailOn>	failOn	Error level to fail on.

Returns

Type	Description
Image	A new Image.

Examples

using Image @out = NetVips.Image.MatrixloadStream(stream, memory: bool, access: Enums.Access, failOn: Enums.FailOn);

| Improve this Doc View Source

Matrixprint(Nullable<Boolean>, Double[], Nullable<Int32>)

Print matrix.

Declaration

public void Matrixprint(bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Matrixprint(strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Matrixsave(String, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to matrix.

Declaration

public void Matrixsave(string filename, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.String	filename	Filename to save to.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.Matrixsave(filename, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

MatrixsaveStream(Stream, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to matrix.

Declaration

public void MatrixsaveStream(Stream stream, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save to.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.MatrixsaveStream(stream, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

MatrixsaveTarget(Target, Nullable<Boolean>, Double[], Nullable<Int32>)

Save image to matrix.

Declaration

public void MatrixsaveTarget(Target target, bool? strip = null, double[] background = null, int? pageHeight = null)

Parameters

Type	Name	Description
Target	target	Target to save to.
System.Nullable<System.Boolean>	strip	Strip all metadata from image.
System.Double[]	background	Background value.
System.Nullable<System.Int32>	pageHeight	Set page height for multipage save.

Examples

in.MatrixsaveTarget(target, strip: bool, background: double[], pageHeight: int);

| Improve this Doc View Source

Max(out Int32, out Int32, out Double[], out Int32[], out Int32[], Nullable<Int32>)

Find image maximum.

Declaration

public double Max(out int x, out int y, out double[] outArray, out int[] xArray, out int[] yArray, int? size = null)

Parameters

Type	Name	Description
System.Int32	x	Horizontal position of maximum.
System.Int32	y	Vertical position of maximum.
System.Double[]	outArray	Array of output values.
System.Int32[]	xArray	Array of horizontal positions.
System.Int32[]	yArray	Array of vertical positions.
System.Nullable<System.Int32>	size	Number of maximum values to find.

Returns

Type	Description
System.Double	A double.

Examples

double @out = in.Max(out var x, out var y, out var outArray, out var xArray, out var yArray, size: int);

| Improve this Doc View Source