defines.h File Reference

(2018-05-22 12:00:01 -0400, (build fd64c39))

#include <stdbool.h>
#include <stdlib.h>
#include <af/version.h>

Go to the source code of this file.

Namespaces

 af
 

Macros

#define AFAPI   __attribute__((visibility("default")))
 
#define SIZE_T_FRMT_SPECIFIER   "%zu"
 
#define DEPRECATED(msg)   __attribute__((deprecated))
 
#define AF_MAX_DIMS   4
 

Typedefs

typedef long long dim_t
 
typedef long long intl
 
typedef unsigned long long uintl
 
typedef void * af_array
 
typedef af_dtype dtype
 
typedef af_source source
 
typedef af_interp_type interpType
 
typedef af_border_type borderType
 
typedef af_connectivity connectivity
 
typedef af_match_type matchType
 
typedef af_cspace_t CSpace
 
typedef af_someenum_t SomeEnum
 
typedef af_mat_prop trans
 
typedef af_conv_mode convMode
 
typedef af_conv_domain convDomain
 
typedef af_mat_prop matProp
 
typedef af_colormap ColorMap
 
typedef af_norm_type normType
 
typedef af_ycc_std YCCStd
 
typedef af_image_format imageFormat
 
typedef af_backend Backend
 
typedef af_marker_type markerType
 
typedef af_moment_type momentType
 
typedef af_storage storage
 
typedef af_binary_op binaryOp
 
typedef af_random_engine_type randomEngineType
 
typedef af_canny_threshold cannyThreshold
 
typedef af_flux_function fluxFunction
 
typedef af_diffusion_eq diffusionEq
 
typedef af_topk_function topkFunction
 

Enumerations

enum  af_err {
  AF_SUCCESS = 0, AF_ERR_NO_MEM = 101, AF_ERR_DRIVER = 102, AF_ERR_RUNTIME = 103,
  AF_ERR_INVALID_ARRAY = 201, AF_ERR_ARG = 202, AF_ERR_SIZE = 203, AF_ERR_TYPE = 204,
  AF_ERR_DIFF_TYPE = 205, AF_ERR_BATCH = 207, AF_ERR_DEVICE = 208, AF_ERR_NOT_SUPPORTED = 301,
  AF_ERR_NOT_CONFIGURED = 302, AF_ERR_NONFREE = 303, AF_ERR_NO_DBL = 401, AF_ERR_NO_GFX = 402,
  AF_ERR_LOAD_LIB = 501, AF_ERR_LOAD_SYM = 502, AF_ERR_ARR_BKND_MISMATCH = 503, AF_ERR_INTERNAL = 998,
  AF_ERR_UNKNOWN = 999
}
 
enum  af_dtype {
  f32, c32, f64, c64,
  b8, s32, u32, u8,
  s64, u64, s16, u16
}
 
enum  af_source { afDevice, afHost }
 
enum  af_interp_type {
  AF_INTERP_NEAREST, AF_INTERP_LINEAR, AF_INTERP_BILINEAR, AF_INTERP_CUBIC,
  AF_INTERP_LOWER, AF_INTERP_LINEAR_COSINE, AF_INTERP_BILINEAR_COSINE, AF_INTERP_BICUBIC,
  AF_INTERP_CUBIC_SPLINE, AF_INTERP_BICUBIC_SPLINE
}
 
enum  af_border_type { AF_PAD_ZERO = 0, AF_PAD_SYM }
 
enum  af_connectivity { AF_CONNECTIVITY_4 = 4, AF_CONNECTIVITY_8 = 8 }
 
enum  af_conv_mode { AF_CONV_DEFAULT, AF_CONV_EXPAND }
 
enum  af_conv_domain { AF_CONV_AUTO, AF_CONV_SPATIAL, AF_CONV_FREQ }
 
enum  af_match_type {
  AF_SAD = 0, AF_ZSAD, AF_LSAD, AF_SSD,
  AF_ZSSD, AF_LSSD, AF_NCC, AF_ZNCC,
  AF_SHD
}
 
enum  af_ycc_std { AF_YCC_601 = 601, AF_YCC_709 = 709, AF_YCC_2020 = 2020 }
 
enum  af_cspace_t { AF_GRAY = 0, AF_RGB, AF_HSV, AF_YCbCr }
 
enum  af_mat_prop {
  AF_MAT_NONE = 0, AF_MAT_TRANS = 1, AF_MAT_CTRANS = 2, AF_MAT_CONJ = 4,
  AF_MAT_UPPER = 32, AF_MAT_LOWER = 64, AF_MAT_DIAG_UNIT = 128, AF_MAT_SYM = 512,
  AF_MAT_POSDEF = 1024, AF_MAT_ORTHOG = 2048, AF_MAT_TRI_DIAG = 4096, AF_MAT_BLOCK_DIAG = 8192
}
 
enum  af_norm_type {
  AF_NORM_VECTOR_1, AF_NORM_VECTOR_INF, AF_NORM_VECTOR_2, AF_NORM_VECTOR_P,
  AF_NORM_MATRIX_1, AF_NORM_MATRIX_INF, AF_NORM_MATRIX_2, AF_NORM_MATRIX_L_PQ,
  AF_NORM_EUCLID = AF_NORM_VECTOR_2
}
 
enum  af_image_format {
  AF_FIF_BMP = 0, AF_FIF_ICO = 1, AF_FIF_JPEG = 2, AF_FIF_JNG = 3,
  AF_FIF_PNG = 13, AF_FIF_PPM = 14, AF_FIF_PPMRAW = 15, AF_FIF_TIFF = 18,
  AF_FIF_PSD = 20, AF_FIF_HDR = 26, AF_FIF_EXR = 29, AF_FIF_JP2 = 31,
  AF_FIF_RAW = 34
}
 
enum  af_moment_type {
  AF_MOMENT_M00 = 1, AF_MOMENT_M01 = 2, AF_MOMENT_M10 = 4, AF_MOMENT_M11 = 8,
  AF_MOMENT_FIRST_ORDER = AF_MOMENT_M00 | AF_MOMENT_M01 | AF_MOMENT_M10 | AF_MOMENT_M11
}
 
enum  af_homography_type { AF_HOMOGRAPHY_RANSAC = 0, AF_HOMOGRAPHY_LMEDS = 1 }
 
enum  af_backend { AF_BACKEND_DEFAULT = 0, AF_BACKEND_CPU = 1, AF_BACKEND_CUDA = 2, AF_BACKEND_OPENCL = 4 }
 
enum  af_someenum_t { AF_ID = 0 }
 
enum  af_binary_op { AF_BINARY_ADD = 0, AF_BINARY_MUL = 1, AF_BINARY_MIN = 2, AF_BINARY_MAX = 3 }
 
enum  af_random_engine_type {
  AF_RANDOM_ENGINE_PHILOX_4X32_10 = 100, AF_RANDOM_ENGINE_THREEFRY_2X32_16 = 200, AF_RANDOM_ENGINE_MERSENNE_GP11213 = 300, AF_RANDOM_ENGINE_PHILOX = AF_RANDOM_ENGINE_PHILOX_4X32_10,
  AF_RANDOM_ENGINE_THREEFRY = AF_RANDOM_ENGINE_THREEFRY_2X32_16, AF_RANDOM_ENGINE_MERSENNE = AF_RANDOM_ENGINE_MERSENNE_GP11213, AF_RANDOM_ENGINE_DEFAULT = AF_RANDOM_ENGINE_PHILOX
}
 
enum  af_colormap {
  AF_COLORMAP_DEFAULT = 0, AF_COLORMAP_SPECTRUM = 1, AF_COLORMAP_COLORS = 2, AF_COLORMAP_RED = 3,
  AF_COLORMAP_MOOD = 4, AF_COLORMAP_HEAT = 5, AF_COLORMAP_BLUE = 6, AF_COLORMAP_INFERNO = 7,
  AF_COLORMAP_MAGMA = 8, AF_COLORMAP_PLASMA = 9, AF_COLORMAP_VIRIDIS = 10
}
 
enum  af_marker_type {
  AF_MARKER_NONE = 0, AF_MARKER_POINT = 1, AF_MARKER_CIRCLE = 2, AF_MARKER_SQUARE = 3,
  AF_MARKER_TRIANGLE = 4, AF_MARKER_CROSS = 5, AF_MARKER_PLUS = 6, AF_MARKER_STAR = 7
}
 
enum  af_canny_threshold { AF_CANNY_THRESHOLD_MANUAL = 0, AF_CANNY_THRESHOLD_AUTO_OTSU = 1 }
 
enum  af_storage { AF_STORAGE_DENSE = 0, AF_STORAGE_CSR = 1, AF_STORAGE_CSC = 2, AF_STORAGE_COO = 3 }
 
enum  af_flux_function { AF_FLUX_QUADRATIC = 1, AF_FLUX_EXPONENTIAL = 2, AF_FLUX_DEFAULT = 0 }
 
enum  af_diffusion_eq { AF_DIFFUSION_GRAD = 1, AF_DIFFUSION_MCDE = 2, AF_DIFFUSION_DEFAULT = 0 }
 
enum  af_topk_function { AF_TOPK_MIN = 1, AF_TOPK_MAX = 2, AF_TOPK_DEFAULT = 0 }
 

Macro Definition Documentation

◆ AF_MAX_DIMS

#define AF_MAX_DIMS   4

Definition at line 219 of file defines.h.

◆ AFAPI

#define AFAPI   __attribute__((visibility("default")))

Definition at line 31 of file defines.h.

◆ DEPRECATED

#define DEPRECATED (   msg)    __attribute__((deprecated))

Definition at line 37 of file defines.h.

◆ SIZE_T_FRMT_SPECIFIER

#define SIZE_T_FRMT_SPECIFIER   "%zu"

Definition at line 33 of file defines.h.

Typedef Documentation

◆ af_array

typedef void* af_array

Definition at line 222 of file defines.h.

◆ dim_t

typedef long long dim_t

Definition at line 50 of file defines.h.

◆ intl

typedef long long intl

Definition at line 55 of file defines.h.

◆ uintl

typedef unsigned long long uintl

Definition at line 56 of file defines.h.

Enumeration Type Documentation

◆ af_backend

enum af_backend
Enumerator
AF_BACKEND_DEFAULT 

Default backend order: OpenCL -> CUDA -> CPU.

AF_BACKEND_CPU 

CPU a.k.a sequential algorithms.

AF_BACKEND_CUDA 

CUDA Compute Backend.

AF_BACKEND_OPENCL 

OpenCL Compute Backend.

Definition at line 385 of file defines.h.

385  {
386  AF_BACKEND_DEFAULT = 0,
387  AF_BACKEND_CPU = 1,
388  AF_BACKEND_CUDA = 2,
389  AF_BACKEND_OPENCL = 4,
390 } af_backend;
af_backend
Definition: defines.h:385
CPU a.k.a sequential algorithms.
Definition: defines.h:387
Default backend order: OpenCL -> CUDA -> CPU.
Definition: defines.h:386
CUDA Compute Backend.
Definition: defines.h:388
OpenCL Compute Backend.
Definition: defines.h:389

◆ af_binary_op

Enumerator
AF_BINARY_ADD 
AF_BINARY_MUL 
AF_BINARY_MIN 
AF_BINARY_MAX 

Definition at line 401 of file defines.h.

401  {
402  AF_BINARY_ADD = 0,
403  AF_BINARY_MUL = 1,
404  AF_BINARY_MIN = 2,
405  AF_BINARY_MAX = 3
406 } af_binary_op;
af_binary_op
Definition: defines.h:401

◆ af_border_type

Enumerator
AF_PAD_ZERO 

Out of bound values are 0.

AF_PAD_SYM 

Out of bound values are symmetric over the edge.

Definition at line 248 of file defines.h.

248  {
252  AF_PAD_ZERO = 0,
253 
257  AF_PAD_SYM
af_border_type
Definition: defines.h:248
Out of bound values are symmetric over the edge.
Definition: defines.h:257
Out of bound values are 0.
Definition: defines.h:252

◆ af_canny_threshold

Enumerator
AF_CANNY_THRESHOLD_MANUAL 

User has to define canny thresholds manually.

AF_CANNY_THRESHOLD_AUTO_OTSU 

Determine canny algorithm thresholds using Otsu algorithm.

Definition at line 454 of file defines.h.

454  {
af_canny_threshold
Definition: defines.h:454
Determine canny algorithm thresholds using Otsu algorithm.
Definition: defines.h:456
User has to define canny thresholds manually.
Definition: defines.h:455

◆ af_colormap

Enumerator
AF_COLORMAP_DEFAULT 

Default grayscale map.

AF_COLORMAP_SPECTRUM 

Spectrum map (390nm-830nm, in sRGB colorspace)

AF_COLORMAP_COLORS 

Colors, aka. Rainbow.

AF_COLORMAP_RED 

Red hue map.

AF_COLORMAP_MOOD 

Mood map.

AF_COLORMAP_HEAT 

Heat map.

AF_COLORMAP_BLUE 

Blue hue map.

AF_COLORMAP_INFERNO 

Perceptually uniform shades of black-red-yellow.

AF_COLORMAP_MAGMA 

Perceptually uniform shades of black-red-white.

AF_COLORMAP_PLASMA 

Perceptually uniform shades of blue-red-yellow.

AF_COLORMAP_VIRIDIS 

Perceptually uniform shades of blue-green-yellow.

Definition at line 425 of file defines.h.

425  {
426  AF_COLORMAP_DEFAULT = 0,
428  AF_COLORMAP_COLORS = 2,
429  AF_COLORMAP_RED = 3,
430  AF_COLORMAP_MOOD = 4,
431  AF_COLORMAP_HEAT = 5,
432  AF_COLORMAP_BLUE = 6,
433  AF_COLORMAP_INFERNO = 7,
434  AF_COLORMAP_MAGMA = 8,
435  AF_COLORMAP_PLASMA = 9,
436  AF_COLORMAP_VIRIDIS = 10
437 } af_colormap;
Perceptually uniform shades of black-red-yellow.
Definition: defines.h:433
Blue hue map.
Definition: defines.h:432
Mood map.
Definition: defines.h:430
Perceptually uniform shades of blue-red-yellow.
Definition: defines.h:435
af_colormap
Definition: defines.h:425
Spectrum map (390nm-830nm, in sRGB colorspace)
Definition: defines.h:427
Perceptually uniform shades of blue-green-yellow.
Definition: defines.h:436
Default grayscale map.
Definition: defines.h:426
Perceptually uniform shades of black-red-white.
Definition: defines.h:434
Heat map.
Definition: defines.h:431
Red hue map.
Definition: defines.h:429
Colors, aka. Rainbow.
Definition: defines.h:428

◆ af_connectivity

Enumerator
AF_CONNECTIVITY_4 

Connectivity includes neighbors, North, East, South and West of current pixel.

AF_CONNECTIVITY_8 

Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest, Southeast and Southwest.

Definition at line 260 of file defines.h.

260  {
264  AF_CONNECTIVITY_4 = 4,
265 
af_connectivity
Definition: defines.h:260
Connectivity includes neighbors, North, East, South and West of current pixel.
Definition: defines.h:264
Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest, Southeast and Southwest.
Definition: defines.h:269

◆ af_conv_domain

Enumerator
AF_CONV_AUTO 

ArrayFire automatically picks the right convolution algorithm.

AF_CONV_SPATIAL 

Perform convolution in spatial domain.

AF_CONV_FREQ 

Perform convolution in frequency domain.

Definition at line 285 of file defines.h.

285  {
286  AF_CONV_AUTO,
288  AF_CONV_FREQ,
af_conv_domain
Definition: defines.h:285
ArrayFire automatically picks the right convolution algorithm.
Definition: defines.h:286
Perform convolution in spatial domain.
Definition: defines.h:287
Perform convolution in frequency domain.
Definition: defines.h:288

◆ af_conv_mode

Enumerator
AF_CONV_DEFAULT 

Output of the convolution is the same size as input.

AF_CONV_EXPAND 

Output of the convolution is signal_len + filter_len - 1.

Definition at line 272 of file defines.h.

272  {
273 
278 
283 } af_conv_mode;
Output of the convolution is signal_len + filter_len - 1.
Definition: defines.h:282
Output of the convolution is the same size as input.
Definition: defines.h:277
af_conv_mode
Definition: defines.h:272

◆ af_cspace_t

Enumerator
AF_GRAY 

Grayscale.

AF_RGB 

3-channel RGB

AF_HSV 

3-channel HSV

AF_YCbCr 

3-channel YCbCr

Definition at line 311 of file defines.h.

311  {
312  AF_GRAY = 0,
313  AF_RGB,
314  AF_HSV,
315 #if AF_API_VERSION >= 31
316  AF_YCbCr
317 #endif
318 } af_cspace_t;
3-channel YCbCr
Definition: defines.h:316
Grayscale.
Definition: defines.h:312
3-channel HSV
Definition: defines.h:314
3-channel RGB
Definition: defines.h:313
af_cspace_t
Definition: defines.h:311

◆ af_diffusion_eq

Enumerator
AF_DIFFUSION_GRAD 

Gradient diffusion equation.

AF_DIFFUSION_MCDE 

Modified curvature diffusion equation.

AF_DIFFUSION_DEFAULT 

Default option is same as AF_DIFFUSION_GRAD.

Definition at line 476 of file defines.h.

476  {
477  AF_DIFFUSION_GRAD = 1,
478  AF_DIFFUSION_MCDE = 2,
Gradient diffusion equation.
Definition: defines.h:477
af_diffusion_eq
Definition: defines.h:476
Modified curvature diffusion equation.
Definition: defines.h:478
Default option is same as AF_DIFFUSION_GRAD.
Definition: defines.h:479

◆ af_dtype

enum af_dtype
Enumerator
f32 

32-bit floating point values

c32 

32-bit complex floating point values

f64 

64-bit complex floating point values

c64 

64-bit complex floating point values

b8 

8-bit boolean values

s32 

32-bit signed integral values

u32 

32-bit unsigned integral values

u8 

8-bit unsigned integral values

s64 

64-bit signed integral values

u64 

64-bit unsigned integral values

s16 

16-bit signed integral values

u16 

16-bit unsigned integral values

Definition at line 195 of file defines.h.

195  {
196  f32,
197  c32,
198  f64,
199  c64,
200  b8 ,
201  s32,
202  u32,
203  u8 ,
204  s64,
205  u64,
206 #if AF_API_VERSION >= 32
207  s16,
208 #endif
209 #if AF_API_VERSION >= 32
210  u16,
211 #endif
212 } af_dtype;
32-bit signed integral values
Definition: defines.h:201
64-bit signed integral values
Definition: defines.h:204
16-bit signed integral values
Definition: defines.h:207
16-bit unsigned integral values
Definition: defines.h:210
64-bit complex floating point values
Definition: defines.h:198
64-bit unsigned integral values
Definition: defines.h:205
64-bit complex floating point values
Definition: defines.h:199
32-bit complex floating point values
Definition: defines.h:197
8-bit unsigned integral values
Definition: defines.h:203
32-bit unsigned integral values
Definition: defines.h:202
32-bit floating point values
Definition: defines.h:196
8-bit boolean values
Definition: defines.h:200
af_dtype
Definition: defines.h:195

◆ af_err

enum af_err
Enumerator
AF_SUCCESS 

The function returned successfully.

AF_ERR_NO_MEM 

The system or device ran out of memory.

AF_ERR_DRIVER 

There was an error in the device driver.

AF_ERR_RUNTIME 

There was an error with the runtime environment.

AF_ERR_INVALID_ARRAY 

The input array is not a valid af_array object.

AF_ERR_ARG 

One of the function arguments is incorrect.

AF_ERR_SIZE 

The size is incorrect.

AF_ERR_TYPE 

The type is not suppported by this function.

AF_ERR_DIFF_TYPE 

The type of the input arrays are not compatible.

AF_ERR_BATCH 

Function does not support GFOR / batch mode.

AF_ERR_DEVICE 

Input does not belong to the current device.

AF_ERR_NOT_SUPPORTED 

The option is not supported.

AF_ERR_NOT_CONFIGURED 

This build of ArrayFire does not support this feature.

AF_ERR_NONFREE 

This build of ArrayFire is not compiled with "nonfree" algorithms.

AF_ERR_NO_DBL 

This device does not support double.

AF_ERR_NO_GFX 

This build of ArrayFire was not built with graphics or this device does not support graphics.

AF_ERR_LOAD_LIB 

There was an error when loading the libraries.

AF_ERR_LOAD_SYM 

There was an error when loading the symbols.

AF_ERR_ARR_BKND_MISMATCH 

There was a mismatch between the input array and the active backend.

AF_ERR_INTERNAL 

There was an internal error either in ArrayFire or in a project upstream.

AF_ERR_UNKNOWN 

Unknown Error.

Definition at line 63 of file defines.h.

63  {
67  AF_SUCCESS = 0,
68 
69  // 100-199 Errors in environment
70 
74  AF_ERR_NO_MEM = 101,
75 
79  AF_ERR_DRIVER = 102,
80 
84  AF_ERR_RUNTIME = 103,
85 
86  // 200-299 Errors in input parameters
87 
92 
96  AF_ERR_ARG = 202,
97 
101  AF_ERR_SIZE = 203,
102 
106  AF_ERR_TYPE = 204,
107 
111  AF_ERR_DIFF_TYPE = 205,
112 
116  AF_ERR_BATCH = 207,
117 
118 
119 #if AF_API_VERSION >= 33
120  AF_ERR_DEVICE = 208,
124 #endif
125 
126  // 300-399 Errors for missing software features
127 
131  AF_ERR_NOT_SUPPORTED = 301,
132 
136  AF_ERR_NOT_CONFIGURED = 302,
137 
138 #if AF_API_VERSION >= 32
139  AF_ERR_NONFREE = 303,
143 #endif
144 
145  // 400-499 Errors for missing hardware features
146 
150  AF_ERR_NO_DBL = 401,
151 
156  AF_ERR_NO_GFX = 402,
157 
158  // 500-599 Errors specific to heterogenous API
159 
160 #if AF_API_VERSION >= 32
161  AF_ERR_LOAD_LIB = 501,
165 #endif
166 
167 #if AF_API_VERSION >= 32
168  AF_ERR_LOAD_SYM = 502,
172 #endif
173 
174 #if AF_API_VERSION >= 32
179 #endif
180 
181  // 900-999 Errors from upstream libraries and runtimes
182 
187  AF_ERR_INTERNAL = 998,
188 
192  AF_ERR_UNKNOWN = 999
193 } af_err;
The system or device ran out of memory.
Definition: defines.h:74
The function returned successfully.
Definition: defines.h:67
The type of the input arrays are not compatible.
Definition: defines.h:111
Function does not support GFOR / batch mode.
Definition: defines.h:116
The option is not supported.
Definition: defines.h:131
There was an error when loading the symbols.
Definition: defines.h:171
There was an error with the runtime environment.
Definition: defines.h:84
af_err
Definition: defines.h:63
The type is not suppported by this function.
Definition: defines.h:106
This device does not support double.
Definition: defines.h:150
This build of ArrayFire was not built with graphics or this device does not support graphics...
Definition: defines.h:156
There was an error when loading the libraries.
Definition: defines.h:164
This build of ArrayFire does not support this feature.
Definition: defines.h:136
There was a mismatch between the input array and the active backend.
Definition: defines.h:178
There was an error in the device driver.
Definition: defines.h:79
This build of ArrayFire is not compiled with "nonfree" algorithms.
Definition: defines.h:142
One of the function arguments is incorrect.
Definition: defines.h:96
The input array is not a valid af_array object.
Definition: defines.h:91
Input does not belong to the current device.
Definition: defines.h:123
There was an internal error either in ArrayFire or in a project upstream.
Definition: defines.h:187
Unknown Error.
Definition: defines.h:192
The size is incorrect.
Definition: defines.h:101

◆ af_flux_function

Enumerator
AF_FLUX_QUADRATIC 

Quadratic flux function.

AF_FLUX_EXPONENTIAL 

Exponential flux function.

AF_FLUX_DEFAULT 

Default flux function is exponential.

Definition at line 470 of file defines.h.

470  {
471  AF_FLUX_QUADRATIC = 1,
472  AF_FLUX_EXPONENTIAL = 2,
473  AF_FLUX_DEFAULT = 0
af_flux_function
Definition: defines.h:470
Exponential flux function.
Definition: defines.h:472
Quadratic flux function.
Definition: defines.h:471
Default flux function is exponential.
Definition: defines.h:473

◆ af_homography_type

Enumerator
AF_HOMOGRAPHY_RANSAC 

Computes homography using RANSAC.

AF_HOMOGRAPHY_LMEDS 

Computes homography using Least Median of Squares.

Definition at line 377 of file defines.h.

377  {
af_homography_type
Definition: defines.h:377
Computes homography using Least Median of Squares.
Definition: defines.h:379
Computes homography using RANSAC.
Definition: defines.h:378

◆ af_image_format

Enumerator
AF_FIF_BMP 

FreeImage Enum for Bitmap File.

AF_FIF_ICO 

FreeImage Enum for Windows Icon File.

AF_FIF_JPEG 

FreeImage Enum for JPEG File.

AF_FIF_JNG 

FreeImage Enum for JPEG Network Graphics File.

AF_FIF_PNG 

FreeImage Enum for Portable Network Graphics File.

AF_FIF_PPM 

FreeImage Enum for Portable Pixelmap (ASCII) File.

AF_FIF_PPMRAW 

FreeImage Enum for Portable Pixelmap (Binary) File.

AF_FIF_TIFF 

FreeImage Enum for Tagged Image File Format File.

AF_FIF_PSD 

FreeImage Enum for Adobe Photoshop File.

AF_FIF_HDR 

FreeImage Enum for High Dynamic Range File.

AF_FIF_EXR 

FreeImage Enum for ILM OpenEXR File.

AF_FIF_JP2 

FreeImage Enum for JPEG-2000 File.

AF_FIF_RAW 

FreeImage Enum for RAW Camera Image File.

Definition at line 349 of file defines.h.

349  {
350  AF_FIF_BMP = 0,
351  AF_FIF_ICO = 1,
352  AF_FIF_JPEG = 2,
353  AF_FIF_JNG = 3,
354  AF_FIF_PNG = 13,
355  AF_FIF_PPM = 14,
356  AF_FIF_PPMRAW = 15,
357  AF_FIF_TIFF = 18,
358  AF_FIF_PSD = 20,
359  AF_FIF_HDR = 26,
360  AF_FIF_EXR = 29,
361  AF_FIF_JP2 = 31,
362  AF_FIF_RAW = 34
FreeImage Enum for RAW Camera Image File.
Definition: defines.h:362
FreeImage Enum for JPEG Network Graphics File.
Definition: defines.h:353
FreeImage Enum for Bitmap File.
Definition: defines.h:350
FreeImage Enum for Windows Icon File.
Definition: defines.h:351
FreeImage Enum for JPEG File.
Definition: defines.h:352
FreeImage Enum for Adobe Photoshop File.
Definition: defines.h:358
FreeImage Enum for Portable Pixelmap (ASCII) File.
Definition: defines.h:355
FreeImage Enum for JPEG-2000 File.
Definition: defines.h:361
FreeImage Enum for Tagged Image File Format File.
Definition: defines.h:357
FreeImage Enum for ILM OpenEXR File.
Definition: defines.h:360
FreeImage Enum for High Dynamic Range File.
Definition: defines.h:359
FreeImage Enum for Portable Network Graphics File.
Definition: defines.h:354
FreeImage Enum for Portable Pixelmap (Binary) File.
Definition: defines.h:356
af_image_format
Definition: defines.h:349

◆ af_interp_type

Enumerator
AF_INTERP_NEAREST 

Nearest Interpolation.

AF_INTERP_LINEAR 

Linear Interpolation.

AF_INTERP_BILINEAR 

Bilinear Interpolation.

AF_INTERP_CUBIC 

Cubic Interpolation.

AF_INTERP_LOWER 

Floor Indexed.

AF_INTERP_LINEAR_COSINE 

Linear Interpolation with cosine smoothing.

AF_INTERP_BILINEAR_COSINE 

Bilinear Interpolation with cosine smoothing.

AF_INTERP_BICUBIC 

Bicubic Interpolation.

AF_INTERP_CUBIC_SPLINE 

Cubic Interpolation with Catmull-Rom splines.

AF_INTERP_BICUBIC_SPLINE 

Bicubic Interpolation with Catmull-Rom splines.

Definition at line 224 of file defines.h.

224  {
230 #if AF_API_VERSION >= 34
232 #endif
233 #if AF_API_VERSION >= 34
235 #endif
236 #if AF_API_VERSION >= 34
238 #endif
239 #if AF_API_VERSION >= 34
241 #endif
242 #if AF_API_VERSION >= 34
244 #endif
245 
Cubic Interpolation.
Definition: defines.h:228
Linear Interpolation.
Definition: defines.h:226
Bilinear Interpolation with cosine smoothing.
Definition: defines.h:234
Bicubic Interpolation with Catmull-Rom splines.
Definition: defines.h:243
af_interp_type
Definition: defines.h:224
Bicubic Interpolation.
Definition: defines.h:237
Bilinear Interpolation.
Definition: defines.h:227
Cubic Interpolation with Catmull-Rom splines.
Definition: defines.h:240
Nearest Interpolation.
Definition: defines.h:225
Linear Interpolation with cosine smoothing.
Definition: defines.h:231
Floor Indexed.
Definition: defines.h:229

◆ af_marker_type

Enumerator
AF_MARKER_NONE 
AF_MARKER_POINT 
AF_MARKER_CIRCLE 
AF_MARKER_SQUARE 
AF_MARKER_TRIANGLE 
AF_MARKER_CROSS 
AF_MARKER_PLUS 
AF_MARKER_STAR 

Definition at line 440 of file defines.h.

◆ af_mat_prop

Enumerator
AF_MAT_NONE 

Default.

AF_MAT_TRANS 

Data needs to be transposed.

AF_MAT_CTRANS 

Data needs to be conjugate tansposed.

AF_MAT_CONJ 

Data needs to be conjugate.

AF_MAT_UPPER 

Matrix is upper triangular.

AF_MAT_LOWER 

Matrix is lower triangular.

AF_MAT_DIAG_UNIT 

Matrix diagonal contains unitary values.

AF_MAT_SYM 

Matrix is symmetric.

AF_MAT_POSDEF 

Matrix is positive definite.

AF_MAT_ORTHOG 

Matrix is orthogonal.

AF_MAT_TRI_DIAG 

Matrix is tri diagonal.

AF_MAT_BLOCK_DIAG 

Matrix is block diagonal.

Definition at line 320 of file defines.h.

320  {
321  AF_MAT_NONE = 0,
322  AF_MAT_TRANS = 1,
323  AF_MAT_CTRANS = 2,
324  AF_MAT_CONJ = 4,
325  AF_MAT_UPPER = 32,
326  AF_MAT_LOWER = 64,
327  AF_MAT_DIAG_UNIT = 128,
328  AF_MAT_SYM = 512,
329  AF_MAT_POSDEF = 1024,
330  AF_MAT_ORTHOG = 2048,
331  AF_MAT_TRI_DIAG = 4096,
332  AF_MAT_BLOCK_DIAG = 8192
333 } af_mat_prop;
Matrix is symmetric.
Definition: defines.h:328
Matrix is orthogonal.
Definition: defines.h:330
Matrix is upper triangular.
Definition: defines.h:325
Matrix diagonal contains unitary values.
Definition: defines.h:327
Matrix is positive definite.
Definition: defines.h:329
Default.
Definition: defines.h:321
Data needs to be conjugate tansposed.
Definition: defines.h:323
Data needs to be conjugate.
Definition: defines.h:324
Matrix is block diagonal.
Definition: defines.h:332
Data needs to be transposed.
Definition: defines.h:322
af_mat_prop
Definition: defines.h:320
Matrix is lower triangular.
Definition: defines.h:326
Matrix is tri diagonal.
Definition: defines.h:331

◆ af_match_type

Enumerator
AF_SAD 

Match based on Sum of Absolute Differences (SAD)

AF_ZSAD 

Match based on Zero mean SAD.

AF_LSAD 

Match based on Locally scaled SAD.

AF_SSD 

Match based on Sum of Squared Differences (SSD)

AF_ZSSD 

Match based on Zero mean SSD.

AF_LSSD 

Match based on Locally scaled SSD.

AF_NCC 

Match based on Normalized Cross Correlation (NCC)

AF_ZNCC 

Match based on Zero mean NCC.

AF_SHD 

Match based on Sum of Hamming Distances (SHD)

Definition at line 291 of file defines.h.

291  {
292  AF_SAD = 0,
293  AF_ZSAD,
294  AF_LSAD,
295  AF_SSD,
296  AF_ZSSD,
297  AF_LSSD,
298  AF_NCC,
299  AF_ZNCC,
300  AF_SHD
301 } af_match_type;
Match based on Sum of Squared Differences (SSD)
Definition: defines.h:295
Match based on Zero mean SAD.
Definition: defines.h:293
Match based on Zero mean SSD.
Definition: defines.h:296
Match based on Zero mean NCC.
Definition: defines.h:299
Match based on Locally scaled SSD.
Definition: defines.h:297
Match based on Normalized Cross Correlation (NCC)
Definition: defines.h:298
Match based on Locally scaled SAD.
Definition: defines.h:294
Match based on Sum of Hamming Distances (SHD)
Definition: defines.h:300
Match based on Sum of Absolute Differences (SAD)
Definition: defines.h:292
af_match_type
Definition: defines.h:291

◆ af_moment_type

Enumerator
AF_MOMENT_M00 
AF_MOMENT_M01 
AF_MOMENT_M10 
AF_MOMENT_M11 
AF_MOMENT_FIRST_ORDER 

Definition at line 367 of file defines.h.

◆ af_norm_type

Enumerator
AF_NORM_VECTOR_1 

treats the input as a vector and returns the sum of absolute values

AF_NORM_VECTOR_INF 

treats the input as a vector and returns the max of absolute values

AF_NORM_VECTOR_2 

treats the input as a vector and returns euclidean norm

AF_NORM_VECTOR_P 

treats the input as a vector and returns the p-norm

AF_NORM_MATRIX_1 

return the max of column sums

AF_NORM_MATRIX_INF 

return the max of row sums

AF_NORM_MATRIX_2 

returns the max singular value). Currently NOT SUPPORTED

AF_NORM_MATRIX_L_PQ 

returns Lpq-norm

AF_NORM_EUCLID 

The default. Same as AF_NORM_VECTOR_2.

Definition at line 335 of file defines.h.

335  {
344 
346 } af_norm_type;
returns the max singular value). Currently NOT SUPPORTED
Definition: defines.h:342
af_norm_type
Definition: defines.h:335
treats the input as a vector and returns the p-norm
Definition: defines.h:339
return the max of row sums
Definition: defines.h:341
returns Lpq-norm
Definition: defines.h:343
treats the input as a vector and returns the max of absolute values
Definition: defines.h:337
The default. Same as AF_NORM_VECTOR_2.
Definition: defines.h:345
return the max of column sums
Definition: defines.h:340
treats the input as a vector and returns euclidean norm
Definition: defines.h:338
treats the input as a vector and returns the sum of absolute values
Definition: defines.h:336

◆ af_random_engine_type

Enumerator
AF_RANDOM_ENGINE_PHILOX_4X32_10 
AF_RANDOM_ENGINE_THREEFRY_2X32_16 
AF_RANDOM_ENGINE_MERSENNE_GP11213 
AF_RANDOM_ENGINE_PHILOX 
AF_RANDOM_ENGINE_THREEFRY 
AF_RANDOM_ENGINE_MERSENNE 
AF_RANDOM_ENGINE_DEFAULT 

Definition at line 410 of file defines.h.

410  {
411  AF_RANDOM_ENGINE_PHILOX_4X32_10 = 100, //Philox variant with N = 4, W = 32 and Rounds = 10
412  AF_RANDOM_ENGINE_THREEFRY_2X32_16 = 200, //Threefry variant with N = 2, W = 32 and Rounds = 16
413  AF_RANDOM_ENGINE_MERSENNE_GP11213 = 300, //Mersenne variant with MEXP = 11213
414  AF_RANDOM_ENGINE_PHILOX = AF_RANDOM_ENGINE_PHILOX_4X32_10, //Resolves to Philox 4x32_10
415  AF_RANDOM_ENGINE_THREEFRY = AF_RANDOM_ENGINE_THREEFRY_2X32_16, //Resolves to Threefry 2X32_16
416  AF_RANDOM_ENGINE_MERSENNE = AF_RANDOM_ENGINE_MERSENNE_GP11213, //Resolves to Mersenne GP 11213
af_random_engine_type
Definition: defines.h:410

◆ af_someenum_t

Enumerator
AF_ID 

Definition at line 396 of file defines.h.

396  {
397  AF_ID = 0
398 } af_someenum_t;
Definition: defines.h:397
af_someenum_t
Definition: defines.h:396

◆ af_source

enum af_source
Enumerator
afDevice 

Device pointer.

afHost 

Host pointer.

Definition at line 214 of file defines.h.

214  {
215  afDevice,
216  afHost,
217 } af_source;
Device pointer.
Definition: defines.h:215
af_source
Definition: defines.h:214
Host pointer.
Definition: defines.h:216

◆ af_storage

enum af_storage
Enumerator
AF_STORAGE_DENSE 

Storage type is dense.

AF_STORAGE_CSR 

Storage type is CSR.

AF_STORAGE_CSC 

Storage type is CSC.

AF_STORAGE_COO 

Storage type is COO.

Definition at line 461 of file defines.h.

461  {
462  AF_STORAGE_DENSE = 0,
463  AF_STORAGE_CSR = 1,
464  AF_STORAGE_CSC = 2,
465  AF_STORAGE_COO = 3,
466 } af_storage;
af_storage
Definition: defines.h:461
Storage type is CSC.
Definition: defines.h:464
Storage type is CSR.
Definition: defines.h:463
Storage type is COO.
Definition: defines.h:465
Storage type is dense.
Definition: defines.h:462

◆ af_topk_function

Enumerator
AF_TOPK_MIN 

Top k min values.

AF_TOPK_MAX 

Top k max values.

AF_TOPK_DEFAULT 

Default option (max)

Definition at line 482 of file defines.h.

482  {
483  AF_TOPK_MIN = 1,
484  AF_TOPK_MAX = 2,
485  AF_TOPK_DEFAULT = 0
af_topk_function
Definition: defines.h:482
Top k max values.
Definition: defines.h:484
Top k min values.
Definition: defines.h:483
Default option (max)
Definition: defines.h:485

◆ af_ycc_std

enum af_ycc_std
Enumerator
AF_YCC_601 

ITU-R BT.601 (formerly CCIR 601) standard.

AF_YCC_709 

ITU-R BT.709 standard.

AF_YCC_2020 

ITU-R BT.2020 standard.

Definition at line 304 of file defines.h.

304  {
305  AF_YCC_601 = 601,
306  AF_YCC_709 = 709,
307  AF_YCC_2020 = 2020
308 } af_ycc_std;
af_ycc_std
Definition: defines.h:304
ITU-R BT.709 standard.
Definition: defines.h:306
ITU-R BT.601 (formerly CCIR 601) standard.
Definition: defines.h:305
ITU-R BT.2020 standard.
Definition: defines.h:307