arrayfire.library module

Module containing enums and other constants.

class arrayfire.library.BACKEND[source]

Bases: enum.Enum

Backend libraries

CPU = <BACKEND.CPU: 1>
CUDA = <BACKEND.CUDA: 2>
DEFAULT = <BACKEND.DEFAULT: 0>
OPENCL = <BACKEND.OPENCL: 4>
class arrayfire.library.BINARYOP[source]

Bases: enum.Enum

Binary Operators

ADD = <BINARYOP.ADD: 0>
MAX = <BINARYOP.MAX: 3>
MIN = <BINARYOP.MIN: 2>
MUL = <BINARYOP.MUL: 1>
class arrayfire.library.COLORMAP[source]

Bases: enum.Enum

Colormaps

BLUE = <COLORMAP.BLUE: 6>
COLORS = <COLORMAP.COLORS: 2>
DEFAULT = <COLORMAP.DEFAULT: 0>
HEAT = <COLORMAP.HEAT: 5>
MOOD = <COLORMAP.MOOD: 4>
RED = <COLORMAP.RED: 3>
SPECTRUM = <COLORMAP.SPECTRUM: 1>
class arrayfire.library.CONNECTIVITY[source]

Bases: enum.Enum

Neighborhood connectivity

EIGHT = <CONNECTIVITY.EIGHT: 8>
FOUR = <CONNECTIVITY.FOUR: 4>
class arrayfire.library.CONV_DOMAIN[source]

Bases: enum.Enum

Convolution domain

AUTO = <CONV_DOMAIN.AUTO: 0>
FREQ = <CONV_DOMAIN.FREQ: 2>
SPATIAL = <CONV_DOMAIN.SPATIAL: 1>
class arrayfire.library.CONV_MODE[source]

Bases: enum.Enum

Convolution mode

DEFAULT = <CONV_MODE.DEFAULT: 0>
EXPAND = <CONV_MODE.EXPAND: 1>
class arrayfire.library.CSPACE[source]

Bases: enum.Enum

Colorspace formats

GRAY = <CSPACE.GRAY: 0>
HSV = <CSPACE.HSV: 2>
RGB = <CSPACE.RGB: 1>
YCbCr = <CSPACE.YCbCr: 3>
class arrayfire.library.Dtype[source]

Bases: enum.Enum

Error values. For internal use only.

b8 = <Dtype.b8: 4>
c32 = <Dtype.c32: 1>
c64 = <Dtype.c64: 3>
f32 = <Dtype.f32: 0>
f64 = <Dtype.f64: 2>
s16 = <Dtype.s16: 10>
s32 = <Dtype.s32: 5>
s64 = <Dtype.s64: 8>
u16 = <Dtype.u16: 11>
u32 = <Dtype.u32: 6>
u64 = <Dtype.u64: 9>
u8 = <Dtype.u8: 7>
class arrayfire.library.ERR[source]

Bases: enum.Enum

Error values. For internal use only.

ARG = <ERR.ARG: 202>
ARR_BKND_MISMATCH = <ERR.ARR_BKND_MISMATCH: 503>
BATCH = <ERR.BATCH: 207>
DEVICE = <ERR.DEVICE: 208>
DIFF_TYPE = <ERR.DIFF_TYPE: 205>
DRIVER = <ERR.DRIVER: 102>
INTERNAL = <ERR.INTERNAL: 998>
INVALID_ARRAY = <ERR.INVALID_ARRAY: 201>
LOAD_LIB = <ERR.LOAD_LIB: 501>
LOAD_SYM = <ERR.LOAD_SYM: 502>
NONE = <ERR.NONE: 0>
NONFREE = <ERR.NONFREE: 303>
NOT_CONFIGURED = <ERR.NOT_CONFIGURED: 302>
NOT_SUPPORTED = <ERR.NOT_SUPPORTED: 301>
NO_DBL = <ERR.NO_DBL: 401>
NO_GFX = <ERR.NO_GFX: 402>
NO_MEM = <ERR.NO_MEM: 101>
RUNTIME = <ERR.RUNTIME: 103>
SIZE = <ERR.SIZE: 203>
TYPE = <ERR.TYPE: 204>
UNKNOWN = <ERR.UNKNOWN: 999>
class arrayfire.library.HOMOGRAPHY[source]

Bases: enum.Enum

Homography Types

LMEDS = <HOMOGRAPHY.LMEDS: 1>
RANSAC = <HOMOGRAPHY.RANSAC: 0>
class arrayfire.library.IMAGE_FORMAT[source]

Bases: enum.Enum

Image Formats

BMP = <IMAGE_FORMAT.BMP: 0>
EXR = <IMAGE_FORMAT.EXR: 29>
HDR = <IMAGE_FORMAT.HDR: 26>
ICO = <IMAGE_FORMAT.ICO: 1>
JNG = <IMAGE_FORMAT.JNG: 3>
JP2 = <IMAGE_FORMAT.JP2: 31>
JPEG = <IMAGE_FORMAT.JPEG: 2>
PNG = <IMAGE_FORMAT.PNG: 13>
PPM = <IMAGE_FORMAT.PPM: 14>
PPMRAW = <IMAGE_FORMAT.PPMRAW: 15>
PSD = <IMAGE_FORMAT.PSD: 20>
RAW = <IMAGE_FORMAT.RAW: 34>
TIFF = <IMAGE_FORMAT.TIFF: 18>
class arrayfire.library.INTERP[source]

Bases: enum.Enum

Interpolation method

BICUBIC = <INTERP.BICUBIC: 7>
BICUBIC_SPLINE = <INTERP.BICUBIC_SPLINE: 9>
BILINEAR = <INTERP.BILINEAR: 2>
BILINEAR_COSINE = <INTERP.BILINEAR_COSINE: 6>
CUBIC = <INTERP.CUBIC: 3>
CUBIC_SPLINE = <INTERP.CUBIC_SPLINE: 8>
LINEAR = <INTERP.LINEAR: 1>
LINEAR_COSINE = <INTERP.LINEAR_COSINE: 5>
LOWER = <INTERP.LOWER: 4>
NEAREST = <INTERP.NEAREST: 0>
class arrayfire.library.MARKER[source]

Bases: enum.Enum

Markers used for different points in graphics plots

CIRCLE = <MARKER.CIRCLE: 2>
CROSS = <MARKER.CROSS: 5>
NONE = <MARKER.NONE: 0>
PLUS = <MARKER.PLUS: 6>
POINT = <MARKER.POINT: 1>
SQUARE = <MARKER.SQUARE: 3>
STAR = <MARKER.STAR: 7>
TRIANGE = <MARKER.TRIANGE: 4>
class arrayfire.library.MATCH[source]

Bases: enum.Enum

Match type

LSAD = <MATCH.LSAD: 2>

Sum of squared differences

LSSD = <MATCH.LSSD: 5>

Normalized cross correlation

NCC = <MATCH.NCC: 6>

Zero mean NCC

SAD = <MATCH.SAD: 0>

Zero mean SAD

SHD = <MATCH.SHD: 8>
SSD = <MATCH.SSD: 3>

Zero mean SSD

ZNCC = <MATCH.ZNCC: 7>

Sum of hamming distances

ZSAD = <MATCH.ZSAD: 1>

Locally scaled SAD

ZSSD = <MATCH.ZSSD: 4>

Locally scaled SSD

class arrayfire.library.MATPROP[source]

Bases: enum.Enum

Matrix properties

BLOCK_DIAG = <MATPROP.BLOCK_DIAG: 8192>
CTRANS = <MATPROP.CTRANS: 2>

Upper triangular matrix.

DIAG_UNIT = <MATPROP.DIAG_UNIT: 128>

Symmetric matrix.

LOWER = <MATPROP.LOWER: 64>

Treat diagonal as units.

NONE = <MATPROP.NONE: 0>

Transposed.

ORTHOG = <MATPROP.ORTHOG: 2048>

Tri diagonal matrix.

POSDEF = <MATPROP.POSDEF: 1024>

Orthogonal matrix.

SYM = <MATPROP.SYM: 512>

Positive definite matrix.

TRANS = <MATPROP.TRANS: 1>

Conjugate transposed.

TRI_DIAG = <MATPROP.TRI_DIAG: 4096>

Block diagonal matrix.

UPPER = <MATPROP.UPPER: 32>

Lower triangular matrix.

class arrayfire.library.MOMENT[source]

Bases: enum.Enum

Image Moments types

FIRST_ORDER = <MOMENT.FIRST_ORDER: 15>
M00 = <MOMENT.M00: 1>
M01 = <MOMENT.M01: 2>
M10 = <MOMENT.M10: 4>
M11 = <MOMENT.M11: 8>
class arrayfire.library.NORM[source]

Bases: enum.Enum

Norm types

EUCLID = <NORM.VECTOR_2: 2>
MATRIX_1 = <NORM.MATRIX_1: 4>
MATRIX_2 = <NORM.MATRIX_2: 6>
MATRIX_INF = <NORM.MATRIX_INF: 5>
MATRIX_L_PQ = <NORM.MATRIX_L_PQ: 7>
VECTOR_1 = <NORM.VECTOR_1: 0>
VECTOR_2 = <NORM.VECTOR_2: 2>
VECTOR_INF = <NORM.VECTOR_INF: 1>
VECTOR_P = <NORM.VECTOR_P: 3>
class arrayfire.library.PAD[source]

Bases: enum.Enum

Edge padding types

SYM = <PAD.SYM: 1>
ZERO = <PAD.ZERO: 0>
class arrayfire.library.RANDOM_ENGINE[source]

Bases: enum.Enum

Random engine types

DEFAULT = <RANDOM_ENGINE.PHILOX_4X32_10: 100>
MERSENNE_GP11213 = <RANDOM_ENGINE.MERSENNE_GP11213: 300>
PHILOX = <RANDOM_ENGINE.PHILOX_4X32_10: 100>
PHILOX_4X32_10 = <RANDOM_ENGINE.PHILOX_4X32_10: 100>
THREEFRY = <RANDOM_ENGINE.THREEFRY_2X32_16: 200>
THREEFRY_2X32_16 = <RANDOM_ENGINE.THREEFRY_2X32_16: 200>
class arrayfire.library.STORAGE[source]

Bases: enum.Enum

Matrix Storage types

COO = <STORAGE.COO: 3>
CSC = <STORAGE.CSC: 2>
CSR = <STORAGE.CSR: 1>
DENSE = <STORAGE.DENSE: 0>
class arrayfire.library.Source[source]

Bases: enum.Enum

Source of the pointer

device = <Source.device: 0>
host = <Source.host: 1>
class arrayfire.library.YCC_STD[source]

Bases: enum.Enum

YCC Standard formats

BT_2020 = <YCC_STD.BT_2020: 2020>
BT_601 = <YCC_STD.BT_601: 601>
BT_709 = <YCC_STD.BT_709: 709>
arrayfire.library.get_active_backend()[source]

Get the current active backend

name
: str.
Backend name
arrayfire.library.get_available_backends()[source]

Get names of available backends

Returns:

names : tuple of strings

Names of available backends
arrayfire.library.get_backend()[source]

Return the name of the backend

arrayfire.library.get_backend_count()[source]

Get number of available backends

Returns:

count : int

Number of available backends
arrayfire.library.get_backend_id(A)[source]

Get backend name of an array

Parameters:

A : af.Array
Returns:

name : str.

Backend name
arrayfire.library.get_device_id(A)[source]

Get the device id of the array

Parameters:

A : af.Array
Returns:

dev : Integer

id of the device array was created on
arrayfire.library.get_size_of(dtype)[source]

Get the size of the type represented by arrayfire.Dtype

arrayfire.library.set_backend(name, unsafe=False)[source]

Set a specific backend by name

Parameters:

name : str.

unsafe : optional: bool. Default: False.

If False, does not switch backend if current backend is not unified backend.