mogrify v0.6.1 Mogrify

Link to this section Summary

Functions

Makes a copy of original image

Creates or saves image

Extends the image to the specified dimensions

Converts the image to the image format you specify

Sets the gravity of the image

Returns the histogram of the image

Opens image source

Resizes the image with provided geometry

Resize the image to fit within the specified dimensions while retaining the aspect ratio of the original image. If necessary, crop the image in the larger dimension

Resize the image to fit within the specified dimensions while retaining the original aspect ratio. Will only resize the image if it is larger than the specified dimensions. The resulting image may be shorter or narrower than specified in the smaller dimension but will not be larger than the specified values

Saves modified image

Provides detailed information about the image

Link to this section Functions

Link to this function add_option(image, option)
Link to this function auto_orient(image)
Link to this function canvas(image, color)

Makes a copy of original image

Link to this function create(image, opts \\ [])

Creates or saves image

Uses the convert command, which accepts both existing images, or image operators. If you have an existing image, prefer save/2.

Options

  • :path - The output path of the image. Defaults to a temporary file.
  • :in_place - Overwrite the original image, ignoring :path option. Default false.
Link to this function custom(image, action, options \\ nil)
Link to this function extent(image, params)

Extends the image to the specified dimensions

Link to this function format(image, format)

Converts the image to the image format you specify

Link to this function gravity(image, params)

Sets the gravity of the image

Link to this function histogram(image)

Returns the histogram of the image

Runs ImageMagick’s histogram:info:- command Results are returned as a list of maps where each map includes keys red, blue, green, hex and count

Example:

iex> open(“test/fixtures/rbgw.png”) |> histogram [ %{“alpha” => 255, “blue” => 255, “count” => 400, “green” => 0, “hex” => “#0000ff”, “red” => 0}, %{“alpha” => 255, “blue” => 0, “count” => 225, “green” => 255, “hex” => “#00ff00”, “red” => 0}, %{“alpha” => 255, “blue” => 0, “count” => 525, “green” => 0, “hex” => “#ff0000”, “red” => 255}, %{“alpha” => 255, “blue” => 255, “count” => 1350, “green” => 255, “hex” => “#ffffff”, “red” => 255} ]

Link to this function image_operator(image, operator)

Opens image source

Link to this function resize(image, params)

Resizes the image with provided geometry

Link to this function resize_to_fill(image, params)

Resize the image to fit within the specified dimensions while retaining the aspect ratio of the original image. If necessary, crop the image in the larger dimension.

Link to this function resize_to_limit(image, params)

Resize the image to fit within the specified dimensions while retaining the original aspect ratio. Will only resize the image if it is larger than the specified dimensions. The resulting image may be shorter or narrower than specified in the smaller dimension but will not be larger than the specified values.

Link to this function save(image, opts \\ [])

Saves modified image

Options

  • :path - The output path of the image. Defaults to a temporary file.
  • :in_place - Overwrite the original image, ignoring :path option. Default false.
Link to this function temporary_path_for(image)

Provides detailed information about the image