image
image
v0.33.0

View Source Image.Math (image v0.33.0)

Implements math operators for images, delegating to the Kernel functions in the cases where the parameters do not include Vix.Vips.Image.t/0.

To override the standard operations in a function or module, add use Image.Math.

To maximise readability and clarity it is recommended that use Image.Math be added to only those functions that require it.

example

 Example 

defmodule MyModule do
  # Not recommended
  use Image.Math

  def my_function(%Vix.Vips.Image{} = image) do
    # Recommended
    use Image.Math

    # Increase the all bands by 20%
    brigher = image * 1.2

    # Or adjust only green by 20%
    bright_green = image * [1, 1.2, 1]
  end
end

Link to this section Summary

Functions

a &&& b

Matrix bitwise 'and' of two images.

a ** b

Matrix exponent of two images or one image and a constant or vector.

a * b

Matrix multiplation of two images or one image and a constant or vector.

a + b

Matrix addition of two images or one image and a constant or vector.

a - b

Matrix subtraction of two images or one image and a constant or vector.

a / b

Matrix division of two images or one image and a constant or vector.

a != b

Matrix inequality of two images or one image and a constant or vector.

a < b

Matrix less than of two images or one image and a constant or vector.

a <<< b

Matrix bitwise 'left shift' of two images.

a <= b

Matrix less than or equal of two images or one image and a constant or vector.

a == b

Matrix equality of two images or one image and a constant or vector.

a > b

Matrix greater than of two images or one image and a constant or vector.

a >= b

Matrix greater than or equal of two images or one image and a constant or vector.

a >>> b

Matrix bitwise 'right shift' of two images.

add(image, image2)
add!(image, value)
boolean_and(image_1, image_2)
boolean_and!(image_1, image_2)
boolean_lshift(image_1, image_2)
boolean_lshift!(image_1, image_2)
boolean_or(image_1, image_2)
boolean_or!(image_1, image_2)
boolean_rshift(image_1, image_2)
boolean_rshift!(image_1, image_2)
boolean_xor(image_1, image_2)
boolean_xor!(image_1, image_2)
cos(image)
cos!(image)
divide(image, image2)
divide!(image, value)
equal(image, other)
equal!(image, value)
greater_than(image, other)
greater_than!(image, value)
greater_than_or_equal(image, other)
greater_than_or_equal!(image, value)
is_pixel(value)

Guards if a given value might be reasonably interpreted as a pixel.

less_than(image, other)
less_than!(image, value)
less_than_or_equal(image, other)
less_than_or_equal!(image, value)
maxpos(image, options \\ [])

Return the image maximum.

minpos(image, options \\ [])

Return the image minimum.

multiply(image, image2)
multiply!(image, value)
not_equal(image, other)
not_equal!(image, value)
pow(image, image2)
pow!(image, value)
sin(image)
sin!(image)
subtract(image, image2)
subtract!(image, value)
a ||| b

Matrix bitwise 'or' of two images.

Link to this section Functions

Link to this function

a &&& b

View Source

Matrix bitwise 'and' of two images.

Link to this function

a ** b

View Source

Matrix exponent of two images or one image and a constant or vector.

Delegates to Kernel.**/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a * b

View Source

Matrix multiplation of two images or one image and a constant or vector.

Delegates to Kernel.*/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a + b

View Source

Matrix addition of two images or one image and a constant or vector.

Delegates to Kernel.+/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a - b

View Source

Matrix subtraction of two images or one image and a constant or vector.

Delegates to Kernel.-/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a / b

View Source

Matrix division of two images or one image and a constant or vector.

Delegates to Kernel.//2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a != b

View Source

Matrix inequality of two images or one image and a constant or vector.

Delegates to Kernel.!=/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a < b

View Source

Matrix less than of two images or one image and a constant or vector.

Delegates to Kernel.</2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a <<< b

View Source

Matrix bitwise 'left shift' of two images.

Link to this function

a <= b

View Source

Matrix less than or equal of two images or one image and a constant or vector.

Delegates to Kernel.<=/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a == b

View Source

Matrix equality of two images or one image and a constant or vector.

Delegates to Kernel.==/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a > b

View Source

Matrix greater than of two images or one image and a constant or vector.

Delegates to Kernel.>/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a >= b

View Source

Matrix greater than or equal of two images or one image and a constant or vector.

Delegates to Kernel.>=/2 if none of the parameters is a Vix.Vips.Image.t/0.

Link to this function

a >>> b

View Source

Matrix bitwise 'right shift' of two images.

Link to this function

add(image, image2)

View Source 
@spec add(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec add(Vix.Vips.Image.t(), number()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec add(Vix.Vips.Image.t(), [number()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec add(number(), number()) :: {:ok, number()}
Link to this function

add!(image, value)

View Source 
@spec add!(Vix.Vips.Image.t(), Image.pixel() | number()) ::
  Vix.Vips.Image.t() | no_return()
@spec add!(Image.pixel() | number(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
@spec add!(number(), number()) :: number() | no_return()
Link to this function

boolean_and(image_1, image_2)

View Source 
@spec boolean_and(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

boolean_and!(image_1, image_2)

View Source 
@spec boolean_and!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
Link to this function

boolean_lshift(image_1, image_2)

View Source 
@spec boolean_lshift(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

boolean_lshift!(image_1, image_2)

View Source 
@spec boolean_lshift!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
Link to this function

boolean_or(image_1, image_2)

View Source 
@spec boolean_or(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

boolean_or!(image_1, image_2)

View Source 
@spec boolean_or!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
Link to this function

boolean_rshift(image_1, image_2)

View Source 
@spec boolean_rshift(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

boolean_rshift!(image_1, image_2)

View Source 
@spec boolean_rshift!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
Link to this function

boolean_xor(image_1, image_2)

View Source 
@spec boolean_xor(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

boolean_xor!(image_1, image_2)

View Source 
@spec boolean_xor!(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
Link to this function

cos(image)

View Source 
@spec cos(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()}
@spec cos(number()) :: {:ok, number()}
Link to this function

cos!(image)

View Source 
@spec cos!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()
Link to this function

divide(image, image2)

View Source 
@spec divide(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec divide(Vix.Vips.Image.t(), number()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec divide(Vix.Vips.Image.t(), [number()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec divide(number(), number()) :: {:ok, number()}
Link to this function

divide!(image, value)

View Source 
@spec divide!(Vix.Vips.Image.t(), Image.pixel()) :: Vix.Vips.Image.t() | no_return()
@spec divide!(number(), number()) :: number() | no_return()
Link to this function

equal(image, other)

View Source 
@spec equal(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec equal(Vix.Vips.Image.t(), Image.pixel()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

equal!(image, value)

View Source 
@spec equal!(Vix.Vips.Image.t(), Image.pixel()) :: Vix.Vips.Image.t() | no_return()
@spec equal!(number(), number()) :: number() | no_return()
Link to this function

greater_than(image, other)

View Source 
@spec greater_than(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec greater_than(Vix.Vips.Image.t(), Image.pixel()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

greater_than!(image, value)

View Source 
@spec greater_than!(Vix.Vips.Image.t(), Vix.Vips.Image.t() | Image.pixel()) ::
  Vix.Vips.Image.t() | no_return()
@spec greater_than!(number(), number()) :: number() | no_return()
Link to this function

greater_than_or_equal(image, other)

View Source 
@spec greater_than_or_equal(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec greater_than_or_equal(Vix.Vips.Image.t(), Image.pixel()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

greater_than_or_equal!(image, value)

View Source 
@spec greater_than_or_equal!(Vix.Vips.Image.t(), Image.pixel()) ::
  Vix.Vips.Image.t() | no_return()
@spec greater_than_or_equal!(number(), number()) :: number() | no_return()
Link to this macro

is_pixel(value)

View Source (macro)

Guards if a given value might be reasonably interpreted as a pixel.

Link to this function

less_than(image, other)

View Source 
@spec less_than(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec less_than(Vix.Vips.Image.t(), Image.pixel()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

less_than!(image, value)

View Source 
@spec less_than!(Vix.Vips.Image.t(), Vix.Vips.Image.t() | Image.pixel()) ::
  Vix.Vips.Image.t() | no_return()
@spec less_than!(number(), number()) :: number() | no_return()
Link to this function

less_than_or_equal(image, other)

View Source 
@spec less_than_or_equal(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec less_than_or_equal(Vix.Vips.Image.t(), Image.pixel()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

less_than_or_equal!(image, value)

View Source 
@spec less_than_or_equal!(Vix.Vips.Image.t(), Vix.Vips.Image.t() | Image.pixel()) ::
  Vix.Vips.Image.t() | no_return()
@spec less_than_or_equal!(number(), number()) :: number() | no_return()
Link to this function

maxpos(image, options \\ [])

View Source 
@spec maxpos(Vix.Vips.Image.t(), Keyword.t()) ::
  {maximum :: float(), x_positiom :: integer(), y_position :: integer()}

Return the image maximum.

arguments

 Arguments

options

 Options

  • :size is the number of maximums to find. The default is 10.

returns

 Returns

  • {:ok, maximum, x_position, y_position}
Link to this function

minpos(image, options \\ [])

View Source 
@spec minpos(Vix.Vips.Image.t(), Keyword.t()) ::
  {minimum :: float(), x_positiom :: integer(), y_position :: integer()}

Return the image minimum.

arguments

 Arguments

options

 Options

  • :size is the number of minimums to find. The default is 10.

returns

 Returns

  • {:ok, minimum, x_position, y_position}
Link to this function

multiply(image, image2)

View Source 
@spec multiply(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec multiply(Vix.Vips.Image.t(), number()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec multiply(Vix.Vips.Image.t(), list()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec multiply(number(), number()) :: {:ok, number()}
Link to this function

multiply!(image, value)

View Source 
@spec multiply!(Vix.Vips.Image.t(), Image.pixel() | number()) ::
  Vix.Vips.Image.t() | no_return()
@spec multiply!(Image.pixel() | number(), Vix.Vips.Image.t()) ::
  Vix.Vips.Image.t() | no_return()
@spec multiply!(number(), number()) :: number() | no_return()
Link to this function

not_equal(image, other)

View Source 
@spec not_equal(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec not_equal(Vix.Vips.Image.t(), Image.pixel()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
Link to this function

not_equal!(image, value)

View Source 
@spec not_equal!(Vix.Vips.Image.t(), Image.pixel()) ::
  Vix.Vips.Image.t() | no_return()
@spec not_equal!(number(), number()) :: number() | no_return()
Link to this function

pow(image, image2)

View Source 
@spec pow(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec pow(Vix.Vips.Image.t(), number()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec pow(number(), number()) :: {:ok, number()}
Link to this function

pow!(image, value)

View Source 
@spec pow!(Vix.Vips.Image.t(), number()) :: Vix.Vips.Image.t() | no_return()
@spec pow!(number(), number()) :: number() | no_return()
Link to this function

sin(image)

View Source 
@spec sin(Vix.Vips.Image.t()) :: {:ok, Vix.Vips.Image.t()}
@spec sin(number()) :: {:ok, number()}
Link to this function

sin!(image)

View Source 
@spec sin!(Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()
Link to this function

subtract(image, image2)

View Source 
@spec subtract(Vix.Vips.Image.t(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec subtract(Vix.Vips.Image.t(), number()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec subtract(Vix.Vips.Image.t(), [number()]) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec subtract(number(), Vix.Vips.Image.t()) ::
  {:ok, Vix.Vips.Image.t()} | {:error, Image.error_message()}
@spec subtract(number(), number()) :: {:ok, number()}
Link to this function

subtract!(image, value)

View Source 
@spec subtract!(Vix.Vips.Image.t(), Image.pixel()) :: Vix.Vips.Image.t() | no_return()
@spec subtract!(Image.pixel(), Vix.Vips.Image.t()) :: Vix.Vips.Image.t() | no_return()
@spec subtract!(number(), number()) :: number() | no_return()
Link to this function

a ||| b

View Source

Matrix bitwise 'or' of two images.