@spec abs(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Absolute value of an image

Arguments

• input - Input image

@spec abs!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Absolute value of an image

Arguments

• input - Input image

@spec add(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Add two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument

@spec add!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Add two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument

@spec affine(Vix.Vips.Image.t(), [float()],
  extend: vips_extend(),
  premultiplied: boolean(),
  background: [float()],
  idy: float(),
  idx: float(),
  ody: float(),
  odx: float(),
  oarea: [integer()],
  interpolate: Vix.Vips.Interpolate.t()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Affine transform of an image

Arguments

• input - Input image argument
• matrix - Transformation matrix

Optional

• extend - How to generate the extra pixels. Default: :VIPS_EXTEND_BACKGROUND
• premultiplied - Images have premultiplied alpha. Default: false
• background - Background value. Default: nil
• idy - Vertical input displacement. Default: 0.0
• idx - Horizontal input displacement. Default: 0.0
• ody - Vertical output displacement. Default: 0.0
• odx - Horizontal output displacement. Default: 0.0
• oarea - Area of output to generate. Default: nil
• interpolate - Interpolate pixels with this.

@spec affine!(Vix.Vips.Image.t(), [float()],
  extend: vips_extend(),
  premultiplied: boolean(),
  background: [float()],
  idy: float(),
  idx: float(),
  ody: float(),
  odx: float(),
  oarea: [integer()],
  interpolate: Vix.Vips.Interpolate.t()
) :: Vix.Vips.Image.t() | no_return()

Affine transform of an image

Arguments

• input - Input image argument
• matrix - Transformation matrix

Optional

• extend - How to generate the extra pixels. Default: :VIPS_EXTEND_BACKGROUND
• premultiplied - Images have premultiplied alpha. Default: false
• background - Background value. Default: nil
• idy - Vertical input displacement. Default: 0.0
• idx - Horizontal input displacement. Default: 0.0
• ody - Vertical output displacement. Default: 0.0
• odx - Horizontal output displacement. Default: 0.0
• oarea - Area of output to generate. Default: nil
• interpolate - Interpolate pixels with this.

@spec arrayjoin([Vix.Vips.Image.t()],
  vspacing: integer(),
  hspacing: integer(),
  valign: vips_align(),
  halign: vips_align(),
  background: [float()],
  shim: integer(),
  across: integer()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Join an array of images

Arguments

• input - Array of input images

Optional

• vspacing - Vertical spacing between images. Default: 1
• hspacing - Horizontal spacing between images. Default: 1
• valign - Align on the top, centre or bottom. Default: :VIPS_ALIGN_LOW
• halign - Align on the left, centre or right. Default: :VIPS_ALIGN_LOW
• background - Colour for new pixels. Default: nil
• shim - Pixels between images. Default: 0
• across - Number of images across grid. Default: 1

@spec arrayjoin!([Vix.Vips.Image.t()],
  vspacing: integer(),
  hspacing: integer(),
  valign: vips_align(),
  halign: vips_align(),
  background: [float()],
  shim: integer(),
  across: integer()
) :: Vix.Vips.Image.t() | no_return()

Join an array of images

Arguments

• input - Array of input images

Optional

• vspacing - Vertical spacing between images. Default: 1
• hspacing - Horizontal spacing between images. Default: 1
• valign - Align on the top, centre or bottom. Default: :VIPS_ALIGN_LOW
• halign - Align on the left, centre or right. Default: :VIPS_ALIGN_LOW
• background - Colour for new pixels. Default: nil
• shim - Pixels between images. Default: 0
• across - Number of images across grid. Default: 1

@spec autorot(Vix.Vips.Image.t()) ::
  {:ok, {Vix.Vips.Image.t(), %{flip: boolean(), angle: vips_angle()}}}
  | {:error, term()}

Autorotate image by exif tag

Arguments

• input - Input image

Returns

Operation returns a tuple

• out - Output image. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• flip - Whether the image was flipped or not. (boolean())
• angle - Angle image was rotated by. (vips_angle)

@spec autorot!(Vix.Vips.Image.t()) ::
  {Vix.Vips.Image.t(), %{flip: boolean(), angle: vips_angle()}} | no_return()

Autorotate image by exif tag

Arguments

• input - Input image

Returns

Operation returns a tuple

• out - Output image. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• flip - Whether the image was flipped or not. (boolean())
• angle - Angle image was rotated by. (vips_angle)

@spec avg(Vix.Vips.Image.t()) :: {:ok, float()} | {:error, term()}

Find image average

Arguments

• input - Input image

@spec avg!(Vix.Vips.Image.t()) :: float() | no_return()

Find image average

Arguments

• input - Input image

@spec bandbool(Vix.Vips.Image.t(), vips_operation_boolean()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Boolean operation across image bands

Arguments

• input - Input image argument
• boolean - Boolean to perform

@spec bandbool!(Vix.Vips.Image.t(), vips_operation_boolean()) ::
  Vix.Vips.Image.t() | no_return()

Boolean operation across image bands

Arguments

• input - Input image argument
• boolean - Boolean to perform

@spec bandfold(Vix.Vips.Image.t(), [{:factor, integer()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Fold up x axis into bands

Arguments

• input - Input image

Optional

• factor - Fold by this factor. Default: 0

@spec bandfold!(Vix.Vips.Image.t(), [{:factor, integer()}]) ::
  Vix.Vips.Image.t() | no_return()

Fold up x axis into bands

Arguments

• input - Input image

Optional

• factor - Fold by this factor. Default: 0

@spec bandjoin([Vix.Vips.Image.t()]) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Bandwise join a set of images

Arguments

• input - Array of input images

@spec bandjoin!([Vix.Vips.Image.t()]) :: Vix.Vips.Image.t() | no_return()

Bandwise join a set of images

Arguments

• input - Array of input images

@spec bandjoin_const(Vix.Vips.Image.t(), [float()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Append a constant band to an image

Arguments

• input - Input image
• c - Array of constants to add

@spec bandjoin_const!(Vix.Vips.Image.t(), [float()]) ::
  Vix.Vips.Image.t() | no_return()

Append a constant band to an image

Arguments

• input - Input image
• c - Array of constants to add

@spec bandmean(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Band-wise average

Arguments

• input - Input image argument

@spec bandmean!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Band-wise average

Arguments

• input - Input image argument

@spec bandrank([Vix.Vips.Image.t()], [{:index, integer()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Band-wise rank of a set of images

Arguments

• input - Array of input images

Optional

• index - Select this band element from sorted list. Default: -1

@spec bandrank!([Vix.Vips.Image.t()], [{:index, integer()}]) ::
  Vix.Vips.Image.t() | no_return()

Band-wise rank of a set of images

Arguments

• input - Array of input images

Optional

• index - Select this band element from sorted list. Default: -1

@spec bandunfold(Vix.Vips.Image.t(), [{:factor, integer()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Unfold image bands into x axis

Arguments

• input - Input image

Optional

• factor - Unfold by this factor. Default: 0

@spec bandunfold!(Vix.Vips.Image.t(), [{:factor, integer()}]) ::
  Vix.Vips.Image.t() | no_return()

Unfold image bands into x axis

Arguments

• input - Input image

Optional

• factor - Unfold by this factor. Default: 0

@spec black(integer(), integer(), [{:bands, integer()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Make a black image

Arguments

• width - Image width in pixels
• height - Image height in pixels

Optional

• bands - Number of bands in image. Default: 1

@spec black!(integer(), integer(), [{:bands, integer()}]) ::
  Vix.Vips.Image.t() | no_return()

Make a black image

Arguments

• width - Image width in pixels
• height - Image height in pixels

Optional

• bands - Number of bands in image. Default: 1

@spec boolean(Vix.Vips.Image.t(), Vix.Vips.Image.t(), vips_operation_boolean()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Boolean operation on two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument
• boolean - Boolean to perform

@spec boolean!(Vix.Vips.Image.t(), Vix.Vips.Image.t(), vips_operation_boolean()) ::
  Vix.Vips.Image.t() | no_return()

Boolean operation on two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument
• boolean - Boolean to perform

@spec boolean_const(Vix.Vips.Image.t(), vips_operation_boolean(), [float()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Boolean operations against a constant

Arguments

• input - Input image
• boolean - Boolean to perform
• c - Array of constants

@spec boolean_const!(Vix.Vips.Image.t(), vips_operation_boolean(), [float()]) ::
  Vix.Vips.Image.t() | no_return()

Boolean operations against a constant

Arguments

• input - Input image
• boolean - Boolean to perform
• c - Array of constants

@spec buildlut(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Build a look-up table

Arguments

• input - Matrix of XY coordinates

@spec buildlut!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Build a look-up table

Arguments

• input - Matrix of XY coordinates

@spec byteswap(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Byteswap an image

Arguments

• input - Input image

@spec byteswap!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Byteswap an image

Arguments

• input - Input image

@spec cache(Vix.Vips.Image.t(),
  "tile-width": integer(),
  "tile-height": integer(),
  "max-tiles": integer()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Cache an image

Arguments

• input - Input image

Optional

• tile-width - Tile width in pixels. Default: 128
• tile-height - Tile height in pixels. Default: 128
• max-tiles - Maximum number of tiles to cache. Default: 1000

@spec cache!(Vix.Vips.Image.t(),
  "tile-width": integer(),
  "tile-height": integer(),
  "max-tiles": integer()
) :: Vix.Vips.Image.t() | no_return()

Cache an image

Arguments

• input - Input image

Optional

• tile-width - Tile width in pixels. Default: 128
• tile-height - Tile height in pixels. Default: 128
• max-tiles - Maximum number of tiles to cache. Default: 1000

@spec canny(Vix.Vips.Image.t(), precision: vips_precision(), sigma: float()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Canny edge detector

Arguments

• input - Input image

Optional

• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT
• sigma - Sigma of Gaussian. Default: 1.4

@spec canny!(Vix.Vips.Image.t(), precision: vips_precision(), sigma: float()) ::
  Vix.Vips.Image.t() | no_return()

Canny edge detector

Arguments

• input - Input image

Optional

• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT
• sigma - Sigma of Gaussian. Default: 1.4

@spec case(Vix.Vips.Image.t(), [Vix.Vips.Image.t()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Use pixel values to pick cases from an array of images

Arguments

• index - Index image
• cases - Array of case images

@spec case!(Vix.Vips.Image.t(), [Vix.Vips.Image.t()]) ::
  Vix.Vips.Image.t() | no_return()

Use pixel values to pick cases from an array of images

Arguments

• index - Index image
• cases - Array of case images

@spec cast(Vix.Vips.Image.t(), vips_band_format(), [{:shift, boolean()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Cast an image

Arguments

• input - Input image
• format - Format to cast to

Optional

• shift - Shift integer values up and down. Default: false

@spec cast!(Vix.Vips.Image.t(), vips_band_format(), [{:shift, boolean()}]) ::
  Vix.Vips.Image.t() | no_return()

Cast an image

Arguments

• input - Input image
• format - Format to cast to

Optional

• shift - Shift integer values up and down. Default: false

@spec cmc2lch(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Transform lch to cmc

Arguments

• input - Input image

@spec cmc2lch!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Transform lch to cmc

Arguments

• input - Input image

@spec cmyk2xyz(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Transform cmyk to xyz

Arguments

• input - Input image

@spec cmyk2xyz!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Transform cmyk to xyz

Arguments

• input - Input image

@spec colourspace(Vix.Vips.Image.t(), vips_interpretation(), [
  {:"source-space", vips_interpretation()}
]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Convert to a new colorspace

Arguments

• input - Input image
• space - Destination color space

Optional

• source-space - Source color space. Default: :VIPS_INTERPRETATION_sRGB

@spec colourspace!(Vix.Vips.Image.t(), vips_interpretation(), [
  {:"source-space", vips_interpretation()}
]) ::
  Vix.Vips.Image.t() | no_return()

Convert to a new colorspace

Arguments

• input - Input image
• space - Destination color space

Optional

• source-space - Source color space. Default: :VIPS_INTERPRETATION_sRGB

@spec compass(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer(),
  precision: vips_precision(),
  combine: vips_combine(),
  angle: vips_angle45(),
  times: integer()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Convolve with rotating mask

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5
• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT
• combine - Combine convolution results like this. Default: :VIPS_COMBINE_MAX
• angle - Rotate mask by this much between convolutions. Default: :VIPS_ANGLE45_D90
• times - Rotate and convolve this many times. Default: 2

@spec compass!(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer(),
  precision: vips_precision(),
  combine: vips_combine(),
  angle: vips_angle45(),
  times: integer()
) :: Vix.Vips.Image.t() | no_return()

Convolve with rotating mask

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5
• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT
• combine - Combine convolution results like this. Default: :VIPS_COMBINE_MAX
• angle - Rotate mask by this much between convolutions. Default: :VIPS_ANGLE45_D90
• times - Rotate and convolve this many times. Default: 2

@spec complex2(Vix.Vips.Image.t(), Vix.Vips.Image.t(), vips_operation_complex2()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Complex binary operations on two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument
• cmplx - Binary complex operation to perform

@spec complex2!(Vix.Vips.Image.t(), Vix.Vips.Image.t(), vips_operation_complex2()) ::
  Vix.Vips.Image.t() | no_return()

Complex binary operations on two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument
• cmplx - Binary complex operation to perform

@spec complex(Vix.Vips.Image.t(), vips_operation_complex()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Perform a complex operation on an image

Arguments

• input - Input image
• cmplx - Complex to perform

@spec complex!(Vix.Vips.Image.t(), vips_operation_complex()) ::
  Vix.Vips.Image.t() | no_return()

Perform a complex operation on an image

Arguments

• input - Input image
• cmplx - Complex to perform

@spec complexform(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Form a complex image from two real images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument

@spec complexform!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Form a complex image from two real images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument

@spec complexget(Vix.Vips.Image.t(), vips_operation_complexget()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Get a component from a complex image

Arguments

• input - Input image
• get - Complex to perform

@spec complexget!(Vix.Vips.Image.t(), vips_operation_complexget()) ::
  Vix.Vips.Image.t() | no_return()

Get a component from a complex image

Arguments

• input - Input image
• get - Complex to perform

@spec composite2(Vix.Vips.Image.t(), Vix.Vips.Image.t(), vips_blend_mode(),
  premultiplied: boolean(),
  "compositing-space": vips_interpretation(),
  y: integer(),
  x: integer()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Blend a pair of images with a blend mode

Arguments

• base - Base image
• overlay - Overlay image
• mode - VipsBlendMode to join with

Optional

• premultiplied - Images have premultiplied alpha. Default: false
• compositing-space - Composite images in this colour space. Default: :VIPS_INTERPRETATION_sRGB
• y - y position of overlay. Default: 0
• x - x position of overlay. Default: 0

@spec composite2!(Vix.Vips.Image.t(), Vix.Vips.Image.t(), vips_blend_mode(),
  premultiplied: boolean(),
  "compositing-space": vips_interpretation(),
  y: integer(),
  x: integer()
) :: Vix.Vips.Image.t() | no_return()

Blend a pair of images with a blend mode

Arguments

• base - Base image
• overlay - Overlay image
• mode - VipsBlendMode to join with

Optional

• premultiplied - Images have premultiplied alpha. Default: false
• compositing-space - Composite images in this colour space. Default: :VIPS_INTERPRETATION_sRGB
• y - y position of overlay. Default: 0
• x - x position of overlay. Default: 0

@spec composite([Vix.Vips.Image.t()], [vips_blend_mode()],
  premultiplied: boolean(),
  "compositing-space": vips_interpretation(),
  y: [integer()],
  x: [integer()]
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Blend an array of images with an array of blend modes

Arguments

• input - Array of input images
• mode - Array of VipsBlendMode to join with

Optional

• premultiplied - Images have premultiplied alpha. Default: false
• compositing-space - Composite images in this colour space. Default: :VIPS_INTERPRETATION_sRGB
• y - Array of y coordinates to join at. Default: nil
• x - Array of x coordinates to join at. Default: nil

@spec composite!([Vix.Vips.Image.t()], [vips_blend_mode()],
  premultiplied: boolean(),
  "compositing-space": vips_interpretation(),
  y: [integer()],
  x: [integer()]
) :: Vix.Vips.Image.t() | no_return()

Blend an array of images with an array of blend modes

Arguments

• input - Array of input images
• mode - Array of VipsBlendMode to join with

Optional

• premultiplied - Images have premultiplied alpha. Default: false
• compositing-space - Composite images in this colour space. Default: :VIPS_INTERPRETATION_sRGB
• y - Array of y coordinates to join at. Default: nil
• x - Array of x coordinates to join at. Default: nil

@spec conv(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer(),
  precision: vips_precision()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5
• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT

@spec conv!(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer(),
  precision: vips_precision()
) :: Vix.Vips.Image.t() | no_return()

Convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5
• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT

@spec conva(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer()
) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Approximate integer convolution

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5

@spec conva!(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer()
) ::
  Vix.Vips.Image.t() | no_return()

Approximate integer convolution

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5

@spec convasep(Vix.Vips.Image.t(), Vix.Vips.Image.t(), [{:layers, integer()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Approximate separable integer convolution

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• layers - Use this many layers in approximation. Default: 5

@spec convasep!(Vix.Vips.Image.t(), Vix.Vips.Image.t(), [{:layers, integer()}]) ::
  Vix.Vips.Image.t() | no_return()

Approximate separable integer convolution

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• layers - Use this many layers in approximation. Default: 5

@spec convf(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Float convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

@spec convf!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Float convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

@spec convi(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Int convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

@spec convi!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Int convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

@spec convsep(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer(),
  precision: vips_precision()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Separable convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5
• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT

@spec convsep!(Vix.Vips.Image.t(), Vix.Vips.Image.t(),
  cluster: integer(),
  layers: integer(),
  precision: vips_precision()
) :: Vix.Vips.Image.t() | no_return()

Separable convolution operation

Arguments

• input - Input image argument
• mask - Input matrix image

Optional

• cluster - Cluster lines closer than this in approximation. Default: 1
• layers - Use this many layers in approximation. Default: 5
• precision - Convolve with this precision. Default: :VIPS_PRECISION_FLOAT

@spec copy(Vix.Vips.Image.t(),
  yoffset: integer(),
  xoffset: integer(),
  yres: float(),
  xres: float(),
  interpretation: vips_interpretation(),
  coding: vips_coding(),
  format: vips_band_format(),
  bands: integer(),
  height: integer(),
  width: integer(),
  swap: boolean()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Copy an image

Arguments

• input - Input image

Optional

• yoffset - Vertical offset of origin. Default: 0
• xoffset - Horizontal offset of origin. Default: 0
• yres - Vertical resolution in pixels/mm. Default: 0.0
• xres - Horizontal resolution in pixels/mm. Default: 0.0
• interpretation - Pixel interpretation. Default: :VIPS_INTERPRETATION_MULTIBAND
• coding - Pixel coding. Default: :VIPS_CODING_NONE
• format - Pixel format in image. Default: :VIPS_FORMAT_UCHAR
• bands - Number of bands in image. Default: 0
• height - Image height in pixels. Default: 0
• width - Image width in pixels. Default: 0
• swap - Swap bytes in image between little and big-endian. Default: false

@spec copy!(Vix.Vips.Image.t(),
  yoffset: integer(),
  xoffset: integer(),
  yres: float(),
  xres: float(),
  interpretation: vips_interpretation(),
  coding: vips_coding(),
  format: vips_band_format(),
  bands: integer(),
  height: integer(),
  width: integer(),
  swap: boolean()
) :: Vix.Vips.Image.t() | no_return()

Copy an image

Arguments

• input - Input image

Optional

• yoffset - Vertical offset of origin. Default: 0
• xoffset - Horizontal offset of origin. Default: 0
• yres - Vertical resolution in pixels/mm. Default: 0.0
• xres - Horizontal resolution in pixels/mm. Default: 0.0
• interpretation - Pixel interpretation. Default: :VIPS_INTERPRETATION_MULTIBAND
• coding - Pixel coding. Default: :VIPS_CODING_NONE
• format - Pixel format in image. Default: :VIPS_FORMAT_UCHAR
• bands - Number of bands in image. Default: 0
• height - Image height in pixels. Default: 0
• width - Image width in pixels. Default: 0
• swap - Swap bytes in image between little and big-endian. Default: false

@spec countlines(Vix.Vips.Image.t(), vips_direction()) ::
  {:ok, float()} | {:error, term()}

Count lines in an image

Arguments

• input - Input image argument
• direction - Countlines left-right or up-down

@spec countlines!(Vix.Vips.Image.t(), vips_direction()) :: float() | no_return()

Count lines in an image

Arguments

• input - Input image argument
• direction - Countlines left-right or up-down

@spec csvload(String.t(),
  disc: boolean(),
  fail: boolean(),
  sequential: boolean(),
  revalidate: boolean(),
  "fail-on": vips_fail_on(),
  access: vips_access(),
  memory: boolean(),
  separator: String.t(),
  whitespace: String.t(),
  lines: integer(),
  skip: integer()
) ::
  {:ok, {Vix.Vips.Image.t(), %{flags: vips_foreign_flags()}}} | {:error, term()}

Load csv

Arguments

• filename - Filename to load from

Optional

• disc - Open to disc. Default: true
• fail - Fail on first warning. Default: false
• sequential - Sequential read only. Default: false
• revalidate - Don't use a cached result for this operation. Default: false
• fail-on - Error level to fail on. Default: :VIPS_FAIL_ON_NONE
• access - Required access pattern for this file. Default: :VIPS_ACCESS_RANDOM
• memory - Force open via memory. Default: false
• separator - Set of separator characters. Default: ";,\t"
• whitespace - Set of whitespace characters. Default: " "
• lines - Read this many lines from the file. Default: 0
• skip - Skip this many lines at the start of the file. Default: 0

Returns

Operation returns a tuple

• out - Output image. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• flags - Flags for this file. (vips_foreign_flags)

@spec csvload!(String.t(),
  disc: boolean(),
  fail: boolean(),
  sequential: boolean(),
  revalidate: boolean(),
  "fail-on": vips_fail_on(),
  access: vips_access(),
  memory: boolean(),
  separator: String.t(),
  whitespace: String.t(),
  lines: integer(),
  skip: integer()
) :: {Vix.Vips.Image.t(), %{flags: vips_foreign_flags()}} | no_return()

Load csv

Arguments

• filename - Filename to load from

Optional

• disc - Open to disc. Default: true
• fail - Fail on first warning. Default: false
• sequential - Sequential read only. Default: false
• revalidate - Don't use a cached result for this operation. Default: false
• fail-on - Error level to fail on. Default: :VIPS_FAIL_ON_NONE
• access - Required access pattern for this file. Default: :VIPS_ACCESS_RANDOM
• memory - Force open via memory. Default: false
• separator - Set of separator characters. Default: ";,\t"
• whitespace - Set of whitespace characters. Default: " "
• lines - Read this many lines from the file. Default: 0
• skip - Skip this many lines at the start of the file. Default: 0

Returns

Operation returns a tuple

• out - Output image. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• flags - Flags for this file. (vips_foreign_flags)

@spec csvsave(Vix.Vips.Image.t(), String.t(),
  strip: boolean(),
  profile: String.t(),
  "page-height": integer(),
  background: [float()],
  keep: vips_foreign_keep(),
  separator: String.t()
) :: :ok | {:error, term()}

Save image to csv

Arguments

• input - Image to save
• filename - Filename to save to

Optional

• strip - Strip all metadata from image. Default: false
• profile - Filename of ICC profile to embed. Default: nil
• page-height - Set page height for multipage save. Default: 0
• background - Background value. Default: nil
• keep - Which metadata to retain. Default: [:VIPS_FOREIGN_KEEP_OTHER, :VIPS_FOREIGN_KEEP_ICC, :VIPS_FOREIGN_KEEP_IPTC, :VIPS_FOREIGN_KEEP_XMP, :VIPS_FOREIGN_KEEP_EXIF]
• separator - Separator characters. Default: "\t"

@spec csvsave!(Vix.Vips.Image.t(), String.t(),
  strip: boolean(),
  profile: String.t(),
  "page-height": integer(),
  background: [float()],
  keep: vips_foreign_keep(),
  separator: String.t()
) :: :ok | no_return()

Save image to csv

Arguments

• input - Image to save
• filename - Filename to save to

Optional

• strip - Strip all metadata from image. Default: false
• profile - Filename of ICC profile to embed. Default: nil
• page-height - Set page height for multipage save. Default: 0
• background - Background value. Default: nil
• keep - Which metadata to retain. Default: [:VIPS_FOREIGN_KEEP_OTHER, :VIPS_FOREIGN_KEEP_ICC, :VIPS_FOREIGN_KEEP_IPTC, :VIPS_FOREIGN_KEEP_XMP, :VIPS_FOREIGN_KEEP_EXIF]
• separator - Separator characters. Default: "\t"

@spec de00(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Calculate de00

Arguments

• left - Left-hand input image
• right - Right-hand input image

@spec de00!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Calculate de00

Arguments

• left - Left-hand input image
• right - Right-hand input image

@spec de76(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Calculate de76

Arguments

• left - Left-hand input image
• right - Right-hand input image

@spec de76!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Calculate de76

Arguments

• left - Left-hand input image
• right - Right-hand input image

@spec decmc(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Calculate decmc

Arguments

• left - Left-hand input image
• right - Right-hand input image

@spec decmc!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Calculate decmc

Arguments

• left - Left-hand input image
• right - Right-hand input image

@spec deviate(Vix.Vips.Image.t()) :: {:ok, float()} | {:error, term()}

Find image standard deviation

Arguments

• input - Input image

@spec deviate!(Vix.Vips.Image.t()) :: float() | no_return()

Find image standard deviation

Arguments

• input - Input image

@spec divide(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Divide two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument

@spec divide!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Divide two images

Arguments

• left - Left-hand image argument
• right - Right-hand image argument

@spec dzsave(Vix.Vips.Image.t(), String.t(),
  strip: boolean(),
  profile: String.t(),
  "page-height": integer(),
  background: [float()],
  keep: vips_foreign_keep(),
  basename: String.t(),
  "no-strip": boolean(),
  Q: integer(),
  id: String.t(),
  "skip-blanks": integer(),
  "region-shrink": vips_region_shrink(),
  compression: integer(),
  properties: boolean(),
  container: vips_foreign_dz_container(),
  angle: vips_angle(),
  depth: vips_foreign_dz_depth(),
  centre: boolean(),
  "tile-width": integer(),
  "tile-height": integer(),
  "tile-size": integer(),
  overlap: integer(),
  suffix: String.t(),
  layout: vips_foreign_dz_layout(),
  imagename: String.t(),
  dirname: String.t()
) :: :ok | {:error, term()}

Save image to deepzoom file

Arguments

• input - Image to save
• filename - Filename to save to

Optional

• strip - Strip all metadata from image. Default: false
• profile - Filename of ICC profile to embed. Default: nil
• page-height - Set page height for multipage save. Default: 0
• background - Background value. Default: nil
• keep - Which metadata to retain. Default: [:VIPS_FOREIGN_KEEP_OTHER, :VIPS_FOREIGN_KEEP_ICC, :VIPS_FOREIGN_KEEP_IPTC, :VIPS_FOREIGN_KEEP_XMP, :VIPS_FOREIGN_KEEP_EXIF]
• basename - Base name to save to. Default: nil
• no-strip - Don't strip tile metadata. Default: false
• Q - Q factor. Default: 75
• id - Resource ID. Default: "https://example.com/iiif"
• skip-blanks - Skip tiles which are nearly equal to the background. Default: -1
• region-shrink - Method to shrink regions. Default: :VIPS_REGION_SHRINK_MEAN
• compression - ZIP deflate compression level. Default: 0
• properties - Write a properties file to the output directory. Default: false
• container - Pyramid container type. Default: :VIPS_FOREIGN_DZ_CONTAINER_FS
• angle - Rotate image during save. Default: :VIPS_ANGLE_D0
• depth - Pyramid depth. Default: :VIPS_FOREIGN_DZ_DEPTH_ONEPIXEL
• centre - Center image in tile. Default: false
• tile-width - Tile width in pixels. Default: 254
• tile-height - Tile height in pixels. Default: 254
• tile-size - Tile size in pixels. Default: 254
• overlap - Tile overlap in pixels. Default: 1
• suffix - Filename suffix for tiles. Default: ".jpeg"
• layout - Directory layout. Default: :VIPS_FOREIGN_DZ_LAYOUT_DZ
• imagename - Image name. Default: nil
• dirname - Directory name to save to. Default: nil

@spec dzsave!(Vix.Vips.Image.t(), String.t(),
  strip: boolean(),
  profile: String.t(),
  "page-height": integer(),
  background: [float()],
  keep: vips_foreign_keep(),
  basename: String.t(),
  "no-strip": boolean(),
  Q: integer(),
  id: String.t(),
  "skip-blanks": integer(),
  "region-shrink": vips_region_shrink(),
  compression: integer(),
  properties: boolean(),
  container: vips_foreign_dz_container(),
  angle: vips_angle(),
  depth: vips_foreign_dz_depth(),
  centre: boolean(),
  "tile-width": integer(),
  "tile-height": integer(),
  "tile-size": integer(),
  overlap: integer(),
  suffix: String.t(),
  layout: vips_foreign_dz_layout(),
  imagename: String.t(),
  dirname: String.t()
) :: :ok | no_return()

Save image to deepzoom file

Arguments

• input - Image to save
• filename - Filename to save to

Optional

• strip - Strip all metadata from image. Default: false
• profile - Filename of ICC profile to embed. Default: nil
• page-height - Set page height for multipage save. Default: 0
• background - Background value. Default: nil
• keep - Which metadata to retain. Default: [:VIPS_FOREIGN_KEEP_OTHER, :VIPS_FOREIGN_KEEP_ICC, :VIPS_FOREIGN_KEEP_IPTC, :VIPS_FOREIGN_KEEP_XMP, :VIPS_FOREIGN_KEEP_EXIF]
• basename - Base name to save to. Default: nil
• no-strip - Don't strip tile metadata. Default: false
• Q - Q factor. Default: 75
• id - Resource ID. Default: "https://example.com/iiif"
• skip-blanks - Skip tiles which are nearly equal to the background. Default: -1
• region-shrink - Method to shrink regions. Default: :VIPS_REGION_SHRINK_MEAN
• compression - ZIP deflate compression level. Default: 0
• properties - Write a properties file to the output directory. Default: false
• container - Pyramid container type. Default: :VIPS_FOREIGN_DZ_CONTAINER_FS
• angle - Rotate image during save. Default: :VIPS_ANGLE_D0
• depth - Pyramid depth. Default: :VIPS_FOREIGN_DZ_DEPTH_ONEPIXEL
• centre - Center image in tile. Default: false
• tile-width - Tile width in pixels. Default: 254
• tile-height - Tile height in pixels. Default: 254
• tile-size - Tile size in pixels. Default: 254
• overlap - Tile overlap in pixels. Default: 1
• suffix - Filename suffix for tiles. Default: ".jpeg"
• layout - Directory layout. Default: :VIPS_FOREIGN_DZ_LAYOUT_DZ
• imagename - Image name. Default: nil
• dirname - Directory name to save to. Default: nil

@spec dzsave_buffer(Vix.Vips.Image.t(),
  strip: boolean(),
  profile: String.t(),
  "page-height": integer(),
  background: [float()],
  keep: vips_foreign_keep(),
  basename: String.t(),
  "no-strip": boolean(),
  Q: integer(),
  id: String.t(),
  "skip-blanks": integer(),
  "region-shrink": vips_region_shrink(),
  compression: integer(),
  properties: boolean(),
  container: vips_foreign_dz_container(),
  angle: vips_angle(),
  depth: vips_foreign_dz_depth(),
  centre: boolean(),
  "tile-width": integer(),
  "tile-height": integer(),
  "tile-size": integer(),
  overlap: integer(),
  suffix: String.t(),
  layout: vips_foreign_dz_layout(),
  imagename: String.t(),
  dirname: String.t()
) :: {:ok, binary()} | {:error, term()}

Save image to dz buffer

Arguments

• input - Image to save

Optional

• strip - Strip all metadata from image. Default: false
• profile - Filename of ICC profile to embed. Default: nil
• page-height - Set page height for multipage save. Default: 0
• background - Background value. Default: nil
• keep - Which metadata to retain. Default: [:VIPS_FOREIGN_KEEP_OTHER, :VIPS_FOREIGN_KEEP_ICC, :VIPS_FOREIGN_KEEP_IPTC, :VIPS_FOREIGN_KEEP_XMP, :VIPS_FOREIGN_KEEP_EXIF]
• basename - Base name to save to. Default: nil
• no-strip - Don't strip tile metadata. Default: false
• Q - Q factor. Default: 75
• id - Resource ID. Default: "https://example.com/iiif"
• skip-blanks - Skip tiles which are nearly equal to the background. Default: -1
• region-shrink - Method to shrink regions. Default: :VIPS_REGION_SHRINK_MEAN
• compression - ZIP deflate compression level. Default: 0
• properties - Write a properties file to the output directory. Default: false
• container - Pyramid container type. Default: :VIPS_FOREIGN_DZ_CONTAINER_FS
• angle - Rotate image during save. Default: :VIPS_ANGLE_D0
• depth - Pyramid depth. Default: :VIPS_FOREIGN_DZ_DEPTH_ONEPIXEL
• centre - Center image in tile. Default: false
• tile-width - Tile width in pixels. Default: 254
• tile-height - Tile height in pixels. Default: 254
• tile-size - Tile size in pixels. Default: 254
• overlap - Tile overlap in pixels. Default: 1
• suffix - Filename suffix for tiles. Default: ".jpeg"
• layout - Directory layout. Default: :VIPS_FOREIGN_DZ_LAYOUT_DZ
• imagename - Image name. Default: nil
• dirname - Directory name to save to. Default: nil

@spec dzsave_buffer!(Vix.Vips.Image.t(),
  strip: boolean(),
  profile: String.t(),
  "page-height": integer(),
  background: [float()],
  keep: vips_foreign_keep(),
  basename: String.t(),
  "no-strip": boolean(),
  Q: integer(),
  id: String.t(),
  "skip-blanks": integer(),
  "region-shrink": vips_region_shrink(),
  compression: integer(),
  properties: boolean(),
  container: vips_foreign_dz_container(),
  angle: vips_angle(),
  depth: vips_foreign_dz_depth(),
  centre: boolean(),
  "tile-width": integer(),
  "tile-height": integer(),
  "tile-size": integer(),
  overlap: integer(),
  suffix: String.t(),
  layout: vips_foreign_dz_layout(),
  imagename: String.t(),
  dirname: String.t()
) :: binary() | no_return()

Save image to dz buffer

Arguments

• input - Image to save

Optional

• strip - Strip all metadata from image. Default: false
• profile - Filename of ICC profile to embed. Default: nil
• page-height - Set page height for multipage save. Default: 0
• background - Background value. Default: nil
• keep - Which metadata to retain. Default: [:VIPS_FOREIGN_KEEP_OTHER, :VIPS_FOREIGN_KEEP_ICC, :VIPS_FOREIGN_KEEP_IPTC, :VIPS_FOREIGN_KEEP_XMP, :VIPS_FOREIGN_KEEP_EXIF]
• basename - Base name to save to. Default: nil
• no-strip - Don't strip tile metadata. Default: false
• Q - Q factor. Default: 75
• id - Resource ID. Default: "https://example.com/iiif"
• skip-blanks - Skip tiles which are nearly equal to the background. Default: -1
• region-shrink - Method to shrink regions. Default: :VIPS_REGION_SHRINK_MEAN
• compression - ZIP deflate compression level. Default: 0
• properties - Write a properties file to the output directory. Default: false
• container - Pyramid container type. Default: :VIPS_FOREIGN_DZ_CONTAINER_FS
• angle - Rotate image during save. Default: :VIPS_ANGLE_D0
• depth - Pyramid depth. Default: :VIPS_FOREIGN_DZ_DEPTH_ONEPIXEL
• centre - Center image in tile. Default: false
• tile-width - Tile width in pixels. Default: 254
• tile-height - Tile height in pixels. Default: 254
• tile-size - Tile size in pixels. Default: 254
• overlap - Tile overlap in pixels. Default: 1
• suffix - Filename suffix for tiles. Default: ".jpeg"
• layout - Directory layout. Default: :VIPS_FOREIGN_DZ_LAYOUT_DZ
• imagename - Image name. Default: nil
• dirname - Directory name to save to. Default: nil

@spec embed(Vix.Vips.Image.t(), integer(), integer(), integer(), integer(),
  background: [float()],
  extend: vips_extend()
) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Embed an image in a larger image

Arguments

• input - Input image
• x - Left edge of input in output
• y - Top edge of input in output
• width - Image width in pixels
• height - Image height in pixels

Optional

• background - Color for background pixels. Default: nil
• extend - How to generate the extra pixels. Default: :VIPS_EXTEND_BLACK

@spec embed!(Vix.Vips.Image.t(), integer(), integer(), integer(), integer(),
  background: [float()],
  extend: vips_extend()
) :: Vix.Vips.Image.t() | no_return()

Embed an image in a larger image

Arguments

• input - Input image
• x - Left edge of input in output
• y - Top edge of input in output
• width - Image width in pixels
• height - Image height in pixels

Optional

• background - Color for background pixels. Default: nil
• extend - How to generate the extra pixels. Default: :VIPS_EXTEND_BLACK

@spec extract_area(Vix.Vips.Image.t(), integer(), integer(), integer(), integer()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Extract an area from an image

Arguments

• input - Input image
• left - Left edge of extract area
• top - Top edge of extract area
• width - Width of extract area
• height - Height of extract area

@spec extract_area!(Vix.Vips.Image.t(), integer(), integer(), integer(), integer()) ::
  Vix.Vips.Image.t() | no_return()

Extract an area from an image

Arguments

• input - Input image
• left - Left edge of extract area
• top - Top edge of extract area
• width - Width of extract area
• height - Height of extract area

@spec extract_band(Vix.Vips.Image.t(), integer(), [{:n, integer()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Extract band from an image

Arguments

• input - Input image
• band - Band to extract

Optional

• n - Number of bands to extract. Default: 1

@spec extract_band!(Vix.Vips.Image.t(), integer(), [{:n, integer()}]) ::
  Vix.Vips.Image.t() | no_return()

Extract band from an image

Arguments

• input - Input image
• band - Band to extract

Optional

• n - Number of bands to extract. Default: 1

@spec eye(integer(), integer(), factor: float(), uchar: boolean()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Make an image showing the eye's spatial response

Arguments

• width - Image width in pixels
• height - Image height in pixels

Optional

• factor - Maximum spatial frequency. Default: 0.5
• uchar - Output an unsigned char image. Default: false

@spec eye!(integer(), integer(), factor: float(), uchar: boolean()) ::
  Vix.Vips.Image.t() | no_return()

Make an image showing the eye's spatial response

Arguments

• width - Image width in pixels
• height - Image height in pixels

Optional

• factor - Maximum spatial frequency. Default: 0.5
• uchar - Output an unsigned char image. Default: false

@spec falsecolour(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

False-color an image

Arguments

• input - Input image

@spec falsecolour!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

False-color an image

Arguments

• input - Input image

@spec fastcor(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Fast correlation

Arguments

• input - Input image argument
• ref - Input reference image

@spec fastcor!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Fast correlation

Arguments

• input - Input image argument
• ref - Input reference image

@spec fill_nearest(Vix.Vips.Image.t()) ::
  {:ok, {Vix.Vips.Image.t(), %{distance: Vix.Vips.Image.t()}}}
  | {:error, term()}

Fill image zeros with nearest non-zero pixel

Arguments

• input - Input image argument

Returns

Operation returns a tuple

• out - Value of nearest non-zero pixel. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• distance - Distance to nearest non-zero pixel. (Vix.Vips.Image.t())

@spec fill_nearest!(Vix.Vips.Image.t()) ::
  {Vix.Vips.Image.t(), %{distance: Vix.Vips.Image.t()}} | no_return()

Fill image zeros with nearest non-zero pixel

Arguments

• input - Input image argument

Returns

Operation returns a tuple

• out - Value of nearest non-zero pixel. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• distance - Distance to nearest non-zero pixel. (Vix.Vips.Image.t())

@spec find_trim(Vix.Vips.Image.t(),
  "line-art": boolean(),
  background: [float()],
  threshold: float()
) ::
  {:ok, {integer(), integer(), integer(), integer()}} | {:error, term()}

Search an image for non-edge areas

Arguments

• input - Image to find_trim

Optional

• line-art - Enable line art mode. Default: false
• background - Color for background pixels. Default: nil
• threshold - Object threshold. Default: 10.0

Returns

Operation returns a tuple

• left - Left edge of image. (integer())
• top - Top edge of extract area. (integer())
• width - Width of extract area. (integer())
• height - Height of extract area. (integer())

@spec find_trim!(Vix.Vips.Image.t(),
  "line-art": boolean(),
  background: [float()],
  threshold: float()
) ::
  {integer(), integer(), integer(), integer()} | no_return()

Search an image for non-edge areas

Arguments

• input - Image to find_trim

Optional

• line-art - Enable line art mode. Default: false
• background - Color for background pixels. Default: nil
• threshold - Object threshold. Default: 10.0

Returns

Operation returns a tuple

• left - Left edge of image. (integer())
• top - Top edge of extract area. (integer())
• width - Width of extract area. (integer())
• height - Height of extract area. (integer())

@spec flatten(Vix.Vips.Image.t(), "max-alpha": float(), background: [float()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Flatten alpha out of an image

Arguments

• input - Input image

Optional

• max-alpha - Maximum value of alpha channel. Default: 255.0
• background - Background value. Default: nil

@spec flatten!(Vix.Vips.Image.t(), "max-alpha": float(), background: [float()]) ::
  Vix.Vips.Image.t() | no_return()

Flatten alpha out of an image

Arguments

• input - Input image

Optional

• max-alpha - Maximum value of alpha channel. Default: 255.0
• background - Background value. Default: nil

@spec flip(Vix.Vips.Image.t(), vips_direction()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Flip an image

Arguments

• input - Input image
• direction - Direction to flip image

@spec flip!(Vix.Vips.Image.t(), vips_direction()) :: Vix.Vips.Image.t() | no_return()

Flip an image

Arguments

• input - Input image
• direction - Direction to flip image

@spec float2rad(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()} | {:error, term()}

Transform float rgb to radiance coding

Arguments

• input - Input image

@spec float2rad!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()

Transform float rgb to radiance coding

Arguments

• input - Input image

@spec fractsurf(integer(), integer(), float()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Make a fractal surface

Arguments

• width - Image width in pixels
• height - Image height in pixels
• fractal-dimension - Fractal dimension

@spec fractsurf!(integer(), integer(), float()) :: Vix.Vips.Image.t() | no_return()

Make a fractal surface

Arguments

• width - Image width in pixels
• height - Image height in pixels
• fractal-dimension - Fractal dimension

@spec freqmult(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Frequency-domain filtering

Arguments

• input - Input image
• mask - Input mask image

@spec freqmult!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()

Frequency-domain filtering

Arguments

• input - Input image
• mask - Input mask image

@spec gamma(Vix.Vips.Image.t(), [{:exponent, float()}]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Gamma an image

Arguments

• input - Input image

Optional

• exponent - Gamma factor. Default: 2.4

@spec gamma!(Vix.Vips.Image.t(), [{:exponent, float()}]) ::
  Vix.Vips.Image.t() | no_return()

Gamma an image

Arguments

• input - Input image

Optional

• exponent - Gamma factor. Default: 2.4

@spec gaussblur(Vix.Vips.Image.t(), float(),
  precision: vips_precision(),
  "min-ampl": float()
) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Gaussian blur

Arguments

• input - Input image
• sigma - Sigma of Gaussian

Optional

• precision - Convolve with this precision. Default: :VIPS_PRECISION_INTEGER
• min-ampl - Minimum amplitude of Gaussian. Default: 0.2

@spec gaussblur!(Vix.Vips.Image.t(), float(),
  precision: vips_precision(),
  "min-ampl": float()
) ::
  Vix.Vips.Image.t() | no_return()

Gaussian blur

Arguments

• input - Input image
• sigma - Sigma of Gaussian

Optional

• precision - Convolve with this precision. Default: :VIPS_PRECISION_INTEGER
• min-ampl - Minimum amplitude of Gaussian. Default: 0.2

@spec gaussmat(float(), float(),
  precision: vips_precision(),
  integer: boolean(),
  separable: boolean()
) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Make a gaussian image

Arguments

• sigma - Sigma of Gaussian
• min-ampl - Minimum amplitude of Gaussian

Optional

• precision - Generate with this precision. Default: :VIPS_PRECISION_INTEGER
• integer - Generate integer Gaussian. Default: false
• separable - Generate separable Gaussian. Default: false

@spec gaussmat!(float(), float(),
  precision: vips_precision(),
  integer: boolean(),
  separable: boolean()
) ::
  Vix.Vips.Image.t() | no_return()

Make a gaussian image

Arguments

• sigma - Sigma of Gaussian
• min-ampl - Minimum amplitude of Gaussian

Optional

• precision - Generate with this precision. Default: :VIPS_PRECISION_INTEGER
• integer - Generate integer Gaussian. Default: false
• separable - Generate separable Gaussian. Default: false

@spec gaussnoise(integer(), integer(), seed: integer(), mean: float(), sigma: float()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, term()}

Make a gaussnoise image

Arguments

• width - Image width in pixels
• height - Image height in pixels

Optional

• seed - Random number seed. Default: 0
• mean - Mean of pixels in generated image. Default: 128.0
• sigma - Standard deviation of pixels in generated image. Default: 30.0

@spec gaussnoise!(integer(), integer(),
  seed: integer(),
  mean: float(),
  sigma: float()
) ::
  Vix.Vips.Image.t() | no_return()

Make a gaussnoise image

Arguments

• width - Image width in pixels
• height - Image height in pixels

Optional

• seed - Random number seed. Default: 0
• mean - Mean of pixels in generated image. Default: 128.0
• sigma - Standard deviation of pixels in generated image. Default: 30.0

@spec getpoint(Vix.Vips.Image.t(), integer(), integer()) ::
  {:ok, [float()]} | {:error, term()}

Read a point from an image

Arguments

• input - Input image
• x - Point to read
• y - Point to read

@spec getpoint!(Vix.Vips.Image.t(), integer(), integer()) :: [float()] | no_return()

Read a point from an image

Arguments

• input - Input image
• x - Point to read
• y - Point to read

@spec gifload(String.t(),
  disc: boolean(),
  fail: boolean(),
  sequential: boolean(),
  revalidate: boolean(),
  "fail-on": vips_fail_on(),
  access: vips_access(),
  memory: boolean(),
  page: integer(),
  n: integer()
) ::
  {:ok, {Vix.Vips.Image.t(), %{flags: vips_foreign_flags()}}} | {:error, term()}

Load gif with libnsgif

Arguments

• filename - Filename to load from

Optional

• disc - Open to disc. Default: true
• fail - Fail on first warning. Default: false
• sequential - Sequential read only. Default: false
• revalidate - Don't use a cached result for this operation. Default: false
• fail-on - Error level to fail on. Default: :VIPS_FAIL_ON_NONE
• access - Required access pattern for this file. Default: :VIPS_ACCESS_RANDOM
• memory - Force open via memory. Default: false
• page - First page to load. Default: 0
• n - Number of pages to load, -1 for all. Default: 1

Returns

Operation returns a tuple

• out - Output image. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• flags - Flags for this file. (vips_foreign_flags)

@spec gifload!(String.t(),
  disc: boolean(),
  fail: boolean(),
  sequential: boolean(),
  revalidate: boolean(),
  "fail-on": vips_fail_on(),
  access: vips_access(),
  memory: boolean(),
  page: integer(),
  n: integer()
) :: {Vix.Vips.Image.t(), %{flags: vips_foreign_flags()}} | no_return()

Load gif with libnsgif

Arguments

• filename - Filename to load from

Optional

• disc - Open to disc. Default: true
• fail - Fail on first warning. Default: false
• sequential - Sequential read only. Default: false
• revalidate - Don't use a cached result for this operation. Default: false
• fail-on - Error level to fail on. Default: :VIPS_FAIL_ON_NONE
• access - Required access pattern for this file. Default: :VIPS_ACCESS_RANDOM
• memory - Force open via memory. Default: false
• page - First page to load. Default: 0
• n - Number of pages to load, -1 for all. Default: 1

Returns

Operation returns a tuple

• out - Output image. (Vix.Vips.Image.t())

Last value of the tuple is a map of additional output values as key-value pair.

• flags - Flags for this file. (vips_foreign_flags)