XIL Atomic Functions

B

Table B-1 lists the XIL atomic functions. The syntax for these entries is,


  <operation name>;<src1 data type>,<src2 data type>,<src3 data type>-><dst data type>

If the operation uses of all the same data type this long form is shortened to,

<operation name>;<data type>.

where data type is one of the following,

1 - 1-bit images
8 - 8-bit images
16 - 16-bit images
f32 - 32-bit floating point images

For example for the add operation for 16 bit data the atomic function is,


  add;16

The API call xil_blend() for 32-bit floating point data with a 16-bit blend image, illustrates the full syntax.


  blend;f32,f32,16->f32

The first column gives the name of the function that must be supplied in the config file header comment in order to associate an implemented function with an API call. The second column lists the data types for which the operation is valid. The third column gives the name of the API binding call associated with the atomic name. Further description of these API functions can be found in the XIL Reference Manual.

Table B-1 (1 of 5)

Atomic Function	Valid Data Combinations	API Call
`absolute`	`16 f32`	`xil_absolute`
`add`	`1 8 16 f32`	`xil_add`
`add_const`	`1 8 16 f32`	`xil_add_const`
`affine_bicubic`	`1 8 16 f32`	`xil_affine`, `bicubic interpolation`
`affine_bilinear`	`1 8 16 f32`	`xil_affine`, `bilinear interpolation`
`affine_general`	`1 8 16 f32`	`xil_affine`, `general interpolation`
`affine_nearest`	`1 8 16 f32`	`xil_affine`, `nearest neighbor interpolation`
`and`	`1 8 16`	`xil_and`
`and_const`	`1 8 16`	`xil_and_const`
`band_combine`	`1 8 16 f32`	`xil_band_combine`
`black_generation`	`1 8 16 f32`	`xil_black_generation`

Table B-1 (2 of 5)

Atomic Function	Valid Data Combinations	API Call
`blend`	`1,1,1->1` `1,1,8->1` `1,1,16->1` `1,1,f32->1` `8,8,1->8` `8,8,8->8` `8,8,16->8` `8,8,f32->8` `16,16,1->16` `16,16,8->16` `16,16,16->16` `16,16,f32->16` `f32,f32,1>f32` `f32,f32,8->f32` `f32,f32,16>f32` `f32,f32,f32->f32`	`xil_blend`
`choose_colormap`	`8`	`xil_choose_colormap`
`color_convert`	`1 8 16 f32`	`xil_color_convert`
`color_correct`	`8`	`xil_color_correct`
`cast`	`1->8 1->16 1->f32` `8->1 8->16 8->f32` `16->1 16->8 16->f32` `f32->1 f32->8 f32->16`	`xil_cast`
`convolve`	`1 8 16 f32`	`xil_convolve`
`copy`	`1 8 16 f32`	`xil_copy`
`copy_with_planemask`	`1 8 16`	`xil_copy_with_planemask`
`copy_pattern`	`1 8 16 f32`	`xil_copy_pattern`
`dilate`	`1 8 16 f32`	`xil_dilate`
`divide`	`1 8 16 f32`	`xil_divide`
`divide_into_const`	`1 8 16 f32`	`xil_divide_into_const`
`edge_detection`	`1 8 16 f32`	`xil_edge_detection`
`erode`	`1 8 16 f32`	`xil_erode`

Table B-1 (3 of 5)

Atomic Function	Valid Data Combinations	API Call
`error_diffusion`	`1->8 1->16` `8->1 8->16` `16->1 16->8` `f32->1 f32->8 f32->16`	`xil_error_diffusion`
`extrema`	`1 8 16 f32`	`xil_extrema`
`fill`	`1 8 16 f32`	`xil_fill`
`histogram`	`1 8 16 f32`	`xil_histogram`
`lookup`	`1->1 1->8 1->16 1->f32` `8->1 8->8 8->16 8->f32` `16->1 16->8 16->16 16->f32`	`xil_lookup`
`max`	`1 8 16 f32`	`xil_max`
`multiply`	`1 8 16 f32`	`xil_multiply`
`multiply_const`	`1 8 16 f32`	`xil_multiply_const`
`nearest_color`	`1->1 1->8 1->16 8->1 8->8 8->16 16->1 16->8 16->16 f32->1 f32->8 f32->16`	`xil_nearest_color`
`not`	`1 8 16`	`xil_not`
`or`	`1 8 16`	`xil_or`
`or_const`	`1 8 16`	`xil_or_const`
`ordered_dither`	`1->1 1->8 1->16 8->1 8->8 8->16 16->1 16->8 16->16 f32->1 f32->8 f32->16`	`xil_ordered_dither`
`paint`	`1 8 16 f32`	`xil_paint`
`rescale`	`1 8 16 f32`	`xil_rescale`
`rotate_bicubic`	`1 8 16 f32`	`xil_rotate`, `bicubic interpolation`
`rotate_bilinear`	`1 8 16 f32`	`xil_rotate`, bilinear interpolation
`rotate_general`	`1 8 16 f32`	`xil_rotate`, general interpolation

Table B-1 (4 of 5)

Atomic Function	Valid Data Combinations	API Call
`rotate_nearest`	`1 8 16 f32`	`xil_rotate`, nearest neighbor interpolation
`scale_bicubic`	`1 8 16 f32`	`xil_scale`, bicubic interpolation
`scale_bilinear`	`1 8 16 f32`	`xil_scale`, bilinear interpolation
`scale_general`	`1 8 16 f32`	`xil_scale`, general interpolation
`scale_nearest`	`1 8 16 f32`	`xil_scale`, nearest neighbor interpolation
`set_value`	`1 8 16 f32`	`xil_set_value`
`separable_convolve`	`1 8 16 f32`	`xil_convolve` with a separable kernel
`soft_fill`	`1 8 16 f32`	`xil_soft_fill`
`squeeze_range`	`1 8 16`	`xil_squeeze_range`
`subsample_binary_to_gray`	`1->8`	`xil_subsample_binary_to_g ray`
`subsample_adaptive`	`1 8 16 f32`	`xil_subsample_adaptive`
`subtract`	`1 8 16 f32`	`xil_subtract`
`subtract_from_const`	`1 8 16 f32`	`xil_subtract_from_const`
`tablewarp_bicubic`	`1 8 16 f32`	`xil_tablewarp`, bicubic interpolation
`tablewarp_bilinear`	`1 8 16 f32`	`xil_tablewarp`, bilinear interpolation
`tablewarp_general`	`1 8 16 f32`	`xil_tablewarp`, general interpolation
`tablewarp_nearest`	`1 8 16 f32`	`xil_tablewarp`, nearest neighbor interpolation
`tablewarp_horizontal_bicubic`	`1 8 16 f32`	`xil_tablewarp_horizontal`, bicubic interpolation
`tablewarp_horizontal_bilinear`	`1 8 16 f32`	`xil_tablewarp_horizontal`, bilinear interpolation

Table B-1 (5 of 5)

Atomic Function	Valid Data Combinations	API Call
`tablewarp_horizontal_general`	`1 8 16 f32`	`xil_tablewarp_horizontal`, general interpolation
`tablewarp_horizontal_nearest`	`1 8 16 f32`	`xil_tablewarp_horizontal`, nearest neighbor interpolation
`tablewarp_vertical_bicubic`	`1 8 16 f32`	`xil_tablewarp_vertical`, bicubic interpolation
`tablewarp_vertical_bilinear`	`1 8 16 f32`	`xil_tablewarp_vertical`, bilinear interpolation
`tablewarp_vertical_general`	`1 8 16 f32`	`xil_tablewarp_vertical`, general interpolation
`tablewarp_vertical_nearest`	`1 8 16 f32`	`xil_tablewarp_vertical`, nearest neighbor interpolation
`threshold`	`1 8 16 f32`	`xil_threshold`
`translate_bicubic`	`1 8 16 f32`	`xil_translate`, bicubic interpolation
`translate_bilinear`	`1 8 16 f32`	`xil_translate`, bilinear interpolation
`translate_general`	`1 8 16 f32`	`xil_translate`, general interpolation
`translate_nearest`	`1 8 16 f32`	`xil_translate`, nearest neighbor interpolation
`transpose`	`1 8 16 f32`	`xil_transpose`
`xor`	`1 8 16`	`xil_xor`
`xor_const`	`1 8 16`	`xil_xor_const`