Vix.Vips.Image (vix v0.5.0) View Source
Vips Image
Link to this section Summary
Functions
Get bands of the the image
Get coding of the the image
Get filename of the the image
Get format of the the image
Get all image header field names.
Get image header value.
Get image header value as string.
Get height of the the image
Get interpretation of the the image
Get mode of the the image
Get n_pages of the the image
Opens path
for reading, returns an instance of Vix.Vips.Image.t/0
Creates a new image with width, height, format, interpretation, resolution and offset taken from the input image, but with each band set from value
.
Make a VipsImage from list.
Make a VipsImage which, when written to, will create a temporary file on disc.
Get offset of the the image
Get orientation of the the image
Get page_height of the the image
Get scale of the the image
Get width of the the image
Returns vips_image
as binary based on the format specified by suffix
. This function is similar to write_to_file
but instead of writing the output to the file, it returns it as a binary.
Write vips_image
to a file.
Get xoffset of the the image
Get xres of the the image
Get yoffset of the the image
Get yres of the the image
Link to this section Types
Specs
t() :: %Vix.Vips.Image{ref: reference()}
Represents an instance of libvips image
Link to this section Functions
Specs
Get bands of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-bands
Specs
Get coding of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-coding
Specs
Get filename of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-filename
Specs
Get format of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-format
Specs
Get all image header field names.
See https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-fields for more details
Specs
header_value(t(), String.t()) :: {:ok, integer() | float() | String.t() | [integer()]} | {:error, term()}
Get image header value.
This is a generic function to get header value.
Casts the value to appropriate type. Currently it only supports values of type integer, float, string and list of integer values. Use Vix.Vips.Image.header_value_as_string/2
to get string representation of any header value.
{:ok, width} = Image.header_value(vips_image, "width")
Specs
Get image header value as string.
This is generic method to get string representation of a header value. If value is VipsBlob, then it returns base64 encoded data.
See: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-as-string
Specs
Get height of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-height
Specs
Get interpretation of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-interpretation
Specs
Get mode of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-mode
Specs
Get n_pages of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-n-pages
Specs
Opens path
for reading, returns an instance of Vix.Vips.Image.t/0
It can load files in many image formats, including VIPS, TIFF, PNG, JPEG, FITS, Matlab, OpenEXR, CSV, WebP, Radiance, RAW, PPM and others.
Load options may be appended to filename as "[name=value,...]". For example:
Image.new_from_file("fred.jpg[shrink=2]")
Will open "fred.jpg", downsampling by a factor of two.
The full set of options available depend upon the load operation that will be executed. Try something like:
$ vips jpegload
at the command-line to see a summary of the available options for the JPEG loader.
Loading is fast: only enough of the image is loaded to be able to fill out the header. Pixels will only be decompressed when they are needed.
Specs
Creates a new image with width, height, format, interpretation, resolution and offset taken from the input image, but with each band set from value
.
Specs
Make a VipsImage from list.
This convenience function makes an image which is a matrix: a one-band VIPS_FORMAT_DOUBLE image held in memory. Useful for vips operations such as conv
.
mask = Image.new_matrix_from_array(3, 3, [[0, 1, 0], [1, 1, 1], [0, 1, 0]])
Optional
- scale - Default: 1
- offset - Default: 0
Specs
Make a VipsImage which, when written to, will create a temporary file on disc.
The file will be automatically deleted when the image is destroyed. format is something like "%s.v"
for a vips file.
The file is created in the temporary directory. This is set with the environment variable TMPDIR. If this is not set, then on Unix systems, vips will default to /tmp
. On Windows, vips uses GetTempPath()
to find the temporary directory.
vips_image = Image.new_temp_file("%s.v")
Specs
Get offset of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-offset
Specs
Get orientation of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-orientation
Specs
Get page_height of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-page-height
Specs
Get scale of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-scale
Specs
Get width of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-width
Specs
Returns vips_image
as binary based on the format specified by suffix
. This function is similar to write_to_file
but instead of writing the output to the file, it returns it as a binary.
Currently only TIFF, JPEG and PNG formats are supported.
Save options may be encoded in the filename or given as a hash. For example:
Image.write_to_buffer(vips_image, ".jpg[Q=90]")
The full set of save options depend on the selected saver. You can get list of available options for the saver
$ vips jpegsave
Specs
Write vips_image
to a file.
Save options may be encoded in the filename or given as a hash. For example:
Image.write_to_file(vips_image, "fred.jpg[Q=90]")
A saver is selected based on path
. The full set of save options depend on the selected saver. Try something like:
$ vips jpegsave
at the command-line to see all the available options for JPEG save.
Specs
Get xoffset of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-xoffset
Specs
Get xres of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-xres
Specs
Get yoffset of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-yoffset
Specs
Get yres of the the image
see: https://libvips.github.io/libvips/API/current/libvips-header.html#vips-image-get-yres