package torch

  1. Overview
  2. Docs
package torch
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Torch_vision.Stb_imageSource

Sourcetype 'a result = ('a, [ `Msg of string ]) Base.Result.t

Image representation

Sourcetype 'kind buffer = ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t constraint 'kind = ('a, 'b) Bigarray.kind

buffer simply is an alias to a bigarray with c_layout. The buffer type serves two purposes:

  • representing input files,
  • representing the raw pixels of an image.

Two kind of pixel buffers are manipulated:

  • int8 for images with 8-bit channels
  • float32 for images with floating point channels
Sourcetype 'kind t = private {
  1. width : int;
  2. height : int;
  3. channels : int;
  4. offset : int;
  5. stride : int;
  6. data : 'kind buffer;
}

A record describing an image. The buffer contains channels * width * height items, in this order:

  • channels are interleaved
  • each pixel is made of channels items
  • each line is made of width pixels
  • image is made of height lines

Creating image

Sourceval image : width:int -> height:int -> channels:int -> ?offset:int -> ?stride:int -> 'kind buffer -> 'kind t result

Image accessors

Sourceval width : _ t -> int
Sourceval height : _ t -> int
Sourceval channels : _ t -> int
Sourceval data : 'kind t -> 'kind buffer

Image decoding

Sourceval load : ?channels:int -> string -> int8 t result

Load an 8-bit per channel image from a filename. If channels is specified, it has to be between 1 and 4 and the decoded image will be processed to have the requested number of channels.

Sourceval loadf : ?channels:int -> string -> float32 t result

Load a floating point channel image from a filename. See load for channels parameter.

Sourceval decode : ?channels:int -> _ buffer -> int8 t result

Decode an 8-bit per channel image from a buffer. See load for channels parameter.

Sourceval decodef : ?channels:int -> _ buffer -> float32 t result

Decode a floating point channel image from a buffer. See load for channels parameter.

Low-level interface

Functions are similar to the above one, except memory is not managed by OCaml GC. It has to be released explicitly with free_unmanaged function.

You get slightly faster load times, more deterministic memory use and more responsibility. Use at your own risk!

Sourceval load_unmanaged : ?channels:int -> string -> int8 t result
Sourceval loadf_unmanaged : ?channels:int -> string -> float32 t result
Sourceval decode_unmanaged : ?channels:int -> _ buffer -> int8 t result
Sourceval decodef_unmanaged : ?channels:int -> _ buffer -> float32 t result
Sourceval free_unmanaged : _ t -> unit

Image filtering

Sourceval mipmap : int8 t -> int8 t -> unit

Generate one level of mipmap: downsample image half in each dimension. In mipmap imgin imgout:

  • imgout.channels must be imgin.channels
  • imgout.width must be imgin.width / 2
  • imgout.height must be imgin.height / 2
  • imgout.data will be filled with downsampled imgin.data
Sourceval mipmapf : float32 t -> float32 t -> unit

Downsample floating point images. See mipmap.

Sourceval vflip : int8 t -> unit

Flip the image vertically

Sourceval vflipf : float32 t -> unit

Flip the image vertically

Sourceval expblur : int8 t -> radius:float -> unit

Blur the image

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct