View Source Image.BandFormat (image v0.48.1)

Functions to define and validate the band formats of an image.

Summary

Functions

Returns the Image format type for an Nx format type.

Returns a list of the known band formats.

Returns the Nx format type for an Image or image format type.

Returns the Nx format type for an Image or image format type or raises an exception.

Validates a band format returning the band format value required in the underlying Vix code.

Types

@type t() ::
  {:u, 8}
  | {:s, 8}
  | {:u, 16}
  | {:s, 16}
  | {:u, 32}
  | {:s, 32}
  | {:u, 64}
  | {:s, 64}
  | {:f, 32}
  | {:f, 64}

Functions

Link to this function

image_format_from_nx(tensor)

View Source

Returns the Image format type for an Nx format type.

Image uses the same type formats as Nx so this function is more a validation than a conversion.

Arguments

  • Any Nx type like {:u, 8}.

Returns

  • {:ok, band_format} or

  • {:error, reason}

Returns a list of the known band formats.

Returns the Nx format type for an Image or image format type.

Image uses the same type formats as Nx so this function is more a validation than a conversion.

Arguments

Returns

  • {:ok, band_format} or

  • {:error, reason}

Link to this function

nx_format!(image_or_format)

View Source

Returns the Nx format type for an Image or image format type or raises an exception.

Image uses the same type formats as Nx so this function is more a validation than a conversion.

Arguments

Returns

  • band_format or

  • raises an exception.

Validates a band format returning the band format value required in the underlying Vix code.

Arguments

Returns

  • {:ok, validated_foramt} or

  • {:error, reason}

Examples

  iex> Image.BandFormat.validate({:u, 8})
  {:ok, :VIPS_FORMAT_UCHAR}

  iex> Image.BandFormat.validate(:u8)
  {:ok, :VIPS_FORMAT_UCHAR}

  iex> Image.BandFormat.validate(:VIPS_FORMAT_UCHAR)
  {:ok, :VIPS_FORMAT_UCHAR}