image.h
Go to the documentation of this file.
1 /*******************************************************
2  * Copyright (c) 2014, ArrayFire
3  * All rights reserved.
4  *
5  * This file is distributed under 3-clause BSD license.
6  * The complete license agreement can be obtained at:
7  * http://arrayfire.com/licenses/BSD-3-Clause
8  ********************************************************/
9 
10 #pragma once
11 #include <af/defines.h>
12 #include <af/features.h>
13 
14 #ifdef __cplusplus
15 namespace af
16 {
17 class array;
18 
28 AFAPI void grad(array& dx, array& dy, const array& in);
29 
39 AFAPI array loadImage(const char* filename, const bool is_color=false);
40 
49 AFAPI void saveImage(const char* filename, const array& in);
50 
51 #if AF_API_VERSION >= 31
52 
65 AFAPI array loadImageMem(const void *ptr);
66 #endif
67 
68 #if AF_API_VERSION >= 31
69 
84 AFAPI void* saveImageMem(const array& in, const imageFormat format = AF_FIF_PNG);
85 #endif
86 
87 #if AF_API_VERSION >= 31
88 
96 AFAPI void deleteImageMem(void *ptr);
97 #endif
98 
110 AFAPI array resize(const array& in, const dim_t odim0, const dim_t odim1, const interpType method=AF_INTERP_NEAREST);
111 
123 AFAPI array resize(const float scale0, const float scale1, const array& in, const interpType method=AF_INTERP_NEAREST);
124 
135 AFAPI array resize(const float scale, const array& in, const interpType method=AF_INTERP_NEAREST);
136 
148 AFAPI array rotate(const array& in, const float theta, const bool crop=true, const interpType method=AF_INTERP_NEAREST);
149 
163 AFAPI array transform(const array& in, const array& transform, const dim_t odim0 = 0, const dim_t odim1 = 0, const interpType method=AF_INTERP_NEAREST, const bool inverse=true);
164 
178 AFAPI array translate(const array& in, const float trans0, const float trans1, const dim_t odim0 = 0, const dim_t odim1 = 0, const interpType method=AF_INTERP_NEAREST);
179 
193 AFAPI array scale(const array& in, const float scale0, const float scale1, const dim_t odim0 = 0, const dim_t odim1 = 0, const interpType method=AF_INTERP_NEAREST);
194 
209 AFAPI array skew(const array& in, const float skew0, const float skew1, const dim_t odim0 = 0, const dim_t odim1 = 0, const bool inverse=true, const interpType method=AF_INTERP_NEAREST);
210 
222 AFAPI array bilateral(const array &in, const float spatial_sigma, const float chromatic_sigma, const bool is_color=false);
223 
237 AFAPI array histogram(const array &in, const unsigned nbins, const double minval, const double maxval);
238 
250 AFAPI array histogram(const array &in, const unsigned nbins);
251 
264 AFAPI array meanShift(const array& in, const float spatial_sigma, const float chromatic_sigma, const unsigned iter, const bool is_color=false);
265 
280 AFAPI array medfilt(const array& in, const dim_t wind_length = 3, const dim_t wind_width = 3, const borderType edge_pad = AF_PAD_ZERO);
281 
294 AFAPI array minfilt(const array& in, const dim_t wind_length = 3, const dim_t wind_width = 3, const borderType edge_pad = AF_PAD_ZERO);
295 
308 AFAPI array maxfilt(const array& in, const dim_t wind_length = 3, const dim_t wind_width = 3, const borderType edge_pad = AF_PAD_ZERO);
309 
321 AFAPI array dilate(const array& in, const array& mask);
322 
332 AFAPI array dilate3(const array& in, const array& mask);
333 
345 AFAPI array erode(const array& in, const array& mask);
346 
356 AFAPI array erode3(const array& in, const array& mask);
357 
386 
399 AFAPI void sobel(array &dx, array &dy, const array &img, const unsigned ker_size=3);
400 
413 AFAPI array sobel(const array &img, const unsigned ker_size=3, const bool isFast=false);
414 
428 AFAPI array rgb2gray(const array& in, const float rPercent=0.2126f, const float gPercent=0.7152f, const float bPercent=0.0722f);
429 
443 AFAPI array gray2rgb(const array& in, const float rFactor=1.0, const float gFactor=1.0, const float bFactor=1.0);
444 
458 AFAPI array histEqual(const array& in, const array& hist);
459 
471 AFAPI array gaussianKernel(const int rows, const int cols, const double sig_r = 0, const double sig_c = 0);
472 
483 AFAPI array hsv2rgb(const array& in);
484 
495 AFAPI array rgb2hsv(const array& in);
496 
511 AFAPI array colorSpace(const array& image, const CSpace to, const CSpace from);
512 
513 #if AF_API_VERSION >= 31
514 
529 AFAPI array unwrap(const array& in, const dim_t wx, const dim_t wy,
530  const dim_t sx, const dim_t sy, const dim_t px=0, const dim_t py=0,
531  const bool is_column = true);
532 #endif
533 
534 #if AF_API_VERSION >= 31
535 
552 AFAPI array wrap(const array& in,
553  const dim_t ox, const dim_t oy,
554  const dim_t wx, const dim_t wy,
555  const dim_t sx, const dim_t sy,
556  const dim_t px = 0, const dim_t py = 0,
557  const bool is_column = true);
558 #endif
559 
560 #if AF_API_VERSION >= 31
561 
569 AFAPI array sat(const array& in);
570 #endif
571 
572 #if AF_API_VERSION >= 31
573 
585 AFAPI array ycbcr2rgb(const array& in, const YCCStd standard=AF_YCC_601);
586 #endif
587 
588 #if AF_API_VERSION >= 31
589 
601 AFAPI array rgb2ycbcr(const array& in, const YCCStd standard=AF_YCC_601);
602 #endif
603 
604 }
605 #endif
606 
607 #ifdef __cplusplus
608 extern "C" {
609 #endif
610 
622  AFAPI af_err af_gradient(af_array *dx, af_array *dy, const af_array in);
623 
635  AFAPI af_err af_load_image(af_array *out, const char* filename, const bool isColor);
636 
647  AFAPI af_err af_save_image(const char* filename, const af_array in);
648 
649 #if AF_API_VERSION >= 31
650 
660  AFAPI af_err af_load_image_memory(af_array *out, const void* ptr);
661 #endif
662 
663 #if AF_API_VERSION >= 31
664 
676  AFAPI af_err af_save_image_memory(void** ptr, const af_array in, const af_image_format format);
677 #endif
678 
679 #if AF_API_VERSION >= 31
680 
690 #endif
691 
706  AFAPI af_err af_resize(af_array *out, const af_array in, const dim_t odim0, const dim_t odim1, const af_interp_type method);
707 
724  const dim_t odim0, const dim_t odim1,
725  const af_interp_type method, const bool inverse);
726 
740  AFAPI af_err af_rotate(af_array *out, const af_array in, const float theta,
741  const bool crop, const af_interp_type method);
757  AFAPI af_err af_translate(af_array *out, const af_array in, const float trans0, const float trans1,
758  const dim_t odim0, const dim_t odim1, const af_interp_type method);
774  AFAPI af_err af_scale(af_array *out, const af_array in, const float scale0, const float scale1,
775  const dim_t odim0, const dim_t odim1, const af_interp_type method);
792  AFAPI af_err af_skew(af_array *out, const af_array in, const float skew0, const float skew1,
793  const dim_t odim0, const dim_t odim1, const af_interp_type method,
794  const bool inverse);
795 
809  AFAPI af_err af_histogram(af_array *out, const af_array in, const unsigned nbins, const double minval, const double maxval);
810 
824  AFAPI af_err af_dilate(af_array *out, const af_array in, const af_array mask);
825 
837  AFAPI af_err af_dilate3(af_array *out, const af_array in, const af_array mask);
838 
852  AFAPI af_err af_erode(af_array *out, const af_array in, const af_array mask);
853 
865  AFAPI af_err af_erode3(af_array *out, const af_array in, const af_array mask);
866 
880  AFAPI af_err af_bilateral(af_array *out, const af_array in, const float spatial_sigma, const float chromatic_sigma, const bool isColor);
881 
896  AFAPI af_err af_mean_shift(af_array *out, const af_array in, const float spatial_sigma, const float chromatic_sigma, const unsigned iter, const bool is_color);
897 
912  AFAPI af_err af_medfilt(af_array *out, const af_array in, const dim_t wind_length, const dim_t wind_width, const af_border_type edge_pad);
913 
928  AFAPI af_err af_minfilt(af_array *out, const af_array in, const dim_t wind_length, const dim_t wind_width, const af_border_type edge_pad);
929 
944  AFAPI af_err af_maxfilt(af_array *out, const af_array in, const dim_t wind_length, const dim_t wind_width, const af_border_type edge_pad);
945 
958  AFAPI af_err af_regions(af_array *out, const af_array in, const af_connectivity connectivity, const af_dtype ty);
959 
974  AFAPI af_err af_sobel_operator(af_array *dx, af_array *dy, const af_array img, const unsigned ker_size);
975 
991  AFAPI af_err af_rgb2gray(af_array* out, const af_array in, const float rPercent, const float gPercent, const float bPercent);
992 
1008  AFAPI af_err af_gray2rgb(af_array* out, const af_array in, const float rFactor, const float gFactor, const float bFactor);
1009 
1023  AFAPI af_err af_hist_equal(af_array *out, const af_array in, const af_array hist);
1024 
1039  const int rows, const int cols,
1040  const double sigma_r, const double sigma_c);
1041 
1054  AFAPI af_err af_hsv2rgb(af_array* out, const af_array in);
1055 
1068  AFAPI af_err af_rgb2hsv(af_array* out, const af_array in);
1069 
1087  AFAPI af_err af_color_space(af_array *out, const af_array image, const af_cspace_t to, const af_cspace_t from);
1088 
1089 #if AF_API_VERSION >= 31
1090 
1107  AFAPI af_err af_unwrap(af_array *out, const af_array in, const dim_t wx, const dim_t wy,
1108  const dim_t sx, const dim_t sy, const dim_t px, const dim_t py,
1109  const bool is_column);
1110 #endif
1111 
1112 #if AF_API_VERSION >= 31
1113 
1135  const af_array in,
1136  const dim_t ox, const dim_t oy,
1137  const dim_t wx, const dim_t wy,
1138  const dim_t sx, const dim_t sy,
1139  const dim_t px, const dim_t py,
1140  const bool is_column);
1141 #endif
1142 
1143 #if AF_API_VERSION >= 31
1144 
1154  AFAPI af_err af_sat(af_array *out, const af_array in);
1155 #endif
1156 
1157 #if AF_API_VERSION >= 31
1158 
1172  AFAPI af_err af_ycbcr2rgb(af_array* out, const af_array in, const af_ycc_std standard);
1173 #endif
1174 
1175 #if AF_API_VERSION >= 31
1176 
1190  AFAPI af_err af_rgb2ycbcr(af_array* out, const af_array in, const af_ycc_std standard);
1191 #endif
1192 #ifdef __cplusplus
1193 }
1194 #endif
AFAPI array scale(const array &in, const float scale0, const float scale1, const dim_t odim0=0, const dim_t odim1=0, const interpType method=AF_INTERP_NEAREST)
C++ Interface for scaling an image.
AFAPI void saveImage(const char *filename, const array &in)
C++ Interface for saving an image.
AFAPI af_err af_load_image(af_array *out, const char *filename, const bool isColor)
C Interface for loading an image.
AFAPI af_err af_dilate(af_array *out, const af_array in, const af_array mask)
C Interface for image dilation (max filter)
af_ycc_std
Definition: defines.h:252
AFAPI af_err af_maxfilt(af_array *out, const af_array in, const dim_t wind_length, const dim_t wind_width, const af_border_type edge_pad)
C Interface for maximum filter.
AFAPI af_err af_dilate3(af_array *out, const af_array in, const af_array mask)
C Interface for 3d image dilation.
AFAPI array minfilt(const array &in, const dim_t wind_length=3, const dim_t wind_width=3, const borderType edge_pad=AF_PAD_ZERO)
C++ Interface for minimum filter.
Definition: algorithm.h:14
AFAPI void deleteImageMem(void *ptr)
C++ Interface for deleting memory created by saveImageMem or af_save_image_memory.
AFAPI af_err af_transform(af_array *out, const af_array in, const af_array transform, const dim_t odim0, const dim_t odim1, const af_interp_type method, const bool inverse)
C Interface for transforming an image.
AFAPI af_err af_gaussian_kernel(af_array *out, const int rows, const int cols, const double sigma_r, const double sigma_c)
C Interface generating gaussian kernels.
AFAPI array ycbcr2rgb(const array &in, const YCCStd standard=AF_YCC_601)
C++ Interface for converting YCbCr to RGB.
AFAPI af_err af_unwrap(af_array *out, const af_array in, const dim_t wx, const dim_t wy, const dim_t sx, const dim_t sy, const dim_t px, const dim_t py, const bool is_column)
C Interface wrapper for unwrap.
AFAPI array rgb2gray(const array &in, const float rPercent=0.2126f, const float gPercent=0.7152f, const float bPercent=0.0722f)
C++ Interface for RGB to gray conversion.
af_border_type
Definition: defines.h:197
AFAPI array rotate(const array &in, const float theta, const bool crop=true, const interpType method=AF_INTERP_NEAREST)
C++ Interface for rotating an image.
AFAPI af_err af_scale(af_array *out, const af_array in, const float scale0, const float scale1, const dim_t odim0, const dim_t odim1, const af_interp_type method)
C Interface for scaling an image.
AFAPI af_err af_load_image_memory(af_array *out, const void *ptr)
C Interface for loading an image from memory.
AFAPI array hsv2rgb(const array &in)
C++ Interface for converting HSV to RGB.
AFAPI af_err af_histogram(af_array *out, const af_array in, const unsigned nbins, const double minval, const double maxval)
C Interface for histogram.
AFAPI array histogram(const array &in, const unsigned nbins, const double minval, const double maxval)
C++ Interface for histogram.
AFAPI af_err af_erode3(af_array *out, const af_array in, const af_array mask)
C Interface for 3D image erosion.
af_ycc_std YCCStd
Definition: defines.h:343
AFAPI af_err af_medfilt(af_array *out, const af_array in, const dim_t wind_length, const dim_t wind_width, const af_border_type edge_pad)
C Interface for median filter.
AFAPI array meanShift(const array &in, const float spatial_sigma, const float chromatic_sigma, const unsigned iter, const bool is_color=false)
C++ Interface for mean shift.
AFAPI array histEqual(const array &in, const array &hist)
C++ Interface for histogram equalization.
AFAPI af_err af_wrap(af_array *out, const af_array in, const dim_t ox, const dim_t oy, const dim_t wx, const dim_t wy, const dim_t sx, const dim_t sy, const dim_t px, const dim_t py, const bool is_column)
C Interface wrapper for wrap.
AFAPI array wrap(const array &in, const dim_t ox, const dim_t oy, const dim_t wx, const dim_t wy, const dim_t sx, const dim_t sy, const dim_t px=0, const dim_t py=0, const bool is_column=true)
C++ Interface wrapper for wrap.
AFAPI af_err af_gray2rgb(af_array *out, const af_array in, const float rFactor, const float gFactor, const float bFactor)
C Interface for converting gray to RGB.
AFAPI array regions(const array &in, const af::connectivity connectivity=AF_CONNECTIVITY_4, const dtype type=f32)
C++ Interface for getting regions in an image.
af_interp_type
Definition: defines.h:189
AFAPI af_err af_regions(af_array *out, const af_array in, const af_connectivity connectivity, const af_dtype ty)
C Interface for regions in an image.
AFAPI af_err af_minfilt(af_array *out, const af_array in, const dim_t wind_length, const dim_t wind_width, const af_border_type edge_pad)
C Interface for minimum filter.
AFAPI void sobel(array &dx, array &dy, const array &img, const unsigned ker_size=3)
C++ Interface for extracting sobel gradients.
AFAPI af_err af_delete_image_memory(void *ptr)
C Interface for deleting an image from memory.
af_image_format imageFormat
Definition: defines.h:344
AFAPI array inverse(const array &in, const matProp options=AF_MAT_NONE)
C++ Interface for inverting a matrix.
AFAPI array erode(const array &in, const array &mask)
C++ Interface for image erosion (min filter)
AFAPI af_err af_hsv2rgb(af_array *out, const af_array in)
C Interface for converting HSV to RGB.
AFAPI af_err af_save_image(const char *filename, const af_array in)
C Interface for saving an image.
af_connectivity
Definition: defines.h:209
AFAPI array dilate3(const array &in, const array &mask)
C++ Interface for 3D image dilation.
af_err
Definition: defines.h:67
Connectivity includes neighbors, North, East, South and West of current pixel.
Definition: defines.h:213
AFAPI af_err af_rgb2hsv(af_array *out, const af_array in)
C Interface for converting RGB to HSV.
AFAPI array transform(const array &in, const array &transform, const dim_t odim0=0, const dim_t odim1=0, const interpType method=AF_INTERP_NEAREST, const bool inverse=true)
C++ Interface for transforming an image.
AFAPI array gaussianKernel(const int rows, const int cols, const double sig_r=0, const double sig_c=0)
C++ Interface for generating gausian kernels.
ITU-R BT.601 (formerly CCIR 601) standard.
Definition: defines.h:253
AFAPI af_err af_bilateral(af_array *out, const af_array in, const float spatial_sigma, const float chromatic_sigma, const bool isColor)
C Interface for bilateral filter.
AFAPI af_err af_rotate(af_array *out, const af_array in, const float theta, const bool crop, const af_interp_type method)
C Interface for rotating an image.
AFAPI void grad(array &dx, array &dy, const array &in)
C++ Interface for calculating the gradients.
Out of bound values are 0.
Definition: defines.h:201
AFAPI af_err af_hist_equal(af_array *out, const af_array in, const af_array hist)
C Interface for histogram equalization.
AFAPI af_err af_sat(af_array *out, const af_array in)
C Interface wrapper for summed area tables.
AFAPI af_err af_rgb2gray(af_array *out, const af_array in, const float rPercent, const float gPercent, const float bPercent)
C Interface for converting RGB to gray.
AFAPI af_err af_gradient(af_array *dx, af_array *dy, const af_array in)
C Interface for calculating the gradients.
long long dim_t
Definition: defines.h:50
AFAPI array resize(const array &in, const dim_t odim0, const dim_t odim1, const interpType method=AF_INTERP_NEAREST)
C++ Interface for resizing an image to specified dimensions.
AFAPI array rgb2hsv(const array &in)
C++ Interface for converting RGB to HSV.
AFAPI array dilate(const array &in, const array &mask)
C++ Interface for image dilation (max filter)
AFAPI array skew(const array &in, const float skew0, const float skew1, const dim_t odim0=0, const dim_t odim1=0, const bool inverse=true, const interpType method=AF_INTERP_NEAREST)
C++ Interface for skewing an image.
AFAPI af_err af_resize(af_array *out, const af_array in, const dim_t odim0, const dim_t odim1, const af_interp_type method)
C Interface for resizing an image to specified dimensions.
AFAPI array rgb2ycbcr(const array &in, const YCCStd standard=AF_YCC_601)
C++ Interface for converting RGB to YCbCr.
#define AFAPI
Definition: defines.h:31
af_border_type borderType
Definition: defines.h:332
AFAPI af_err af_translate(af_array *out, const af_array in, const float trans0, const float trans1, const dim_t odim0, const dim_t odim1, const af_interp_type method)
C Interface for translate an image.
AFAPI array maxfilt(const array &in, const dim_t wind_length=3, const dim_t wind_width=3, const borderType edge_pad=AF_PAD_ZERO)
C++ Interface for maximum filter.
AFAPI array loadImage(const char *filename, const bool is_color=false)
C++ Interface for loading an image.
static af::array array(af::dim4 idims, cl_mem buf, af::dtype type, bool retain=false)
Create an af::array object from an OpenCL cl_mem buffer.
Definition: opencl.h:136
AFAPI array bilateral(const array &in, const float spatial_sigma, const float chromatic_sigma, const bool is_color=false)
C++ Interface for bilateral filter.
AFAPI array medfilt(const array &in, const dim_t wind_length=3, const dim_t wind_width=3, const borderType edge_pad=AF_PAD_ZERO)
C++ Interface for median filter.
Nearest Interpolation.
Definition: defines.h:190
AFAPI af_err af_erode(af_array *out, const af_array in, const af_array mask)
C Interface for image erosion (min filter)
AFAPI array sat(const array &in)
C++ Interface wrapper for summed area tables.
af_cspace_t
Definition: defines.h:258
FreeImage Enum for Portable Network Graphics File.
Definition: defines.h:308
void * af_array
Definition: defines.h:187
AFAPI array colorSpace(const array &image, const CSpace to, const CSpace from)
C++ Interface wrapper for colorspace conversion.
af_image_format
Definition: defines.h:303
af_cspace_t CSpace
Definition: defines.h:335
32-bit floating point values
Definition: defines.h:167
AFAPI af_err af_rgb2ycbcr(af_array *out, const af_array in, const af_ycc_std standard)
C Interface for converting RGB to YCbCr.
AFAPI af_err af_save_image_memory(void **ptr, const af_array in, const af_image_format format)
C Interface for saving an image to memory using FreeImage.
AFAPI void * saveImageMem(const array &in, const imageFormat format=AF_FIF_PNG)
C++ Interface for saving an image to memory.
AFAPI array erode3(const array &in, const array &mask)
C++ Interface for 3d for image erosion.
af_dtype
Definition: defines.h:166
af_interp_type interpType
Definition: defines.h:331
AFAPI af_err af_color_space(af_array *out, const af_array image, const af_cspace_t to, const af_cspace_t from)
C Interface wrapper for color space conversion.
af_dtype dtype
Definition: defines.h:329
AFAPI array translate(const array &in, const float trans0, const float trans1, const dim_t odim0=0, const dim_t odim1=0, const interpType method=AF_INTERP_NEAREST)
C++ Interface for translating an image.
AFAPI array gray2rgb(const array &in, const float rFactor=1.0, const float gFactor=1.0, const float bFactor=1.0)
C++ Interface for gray to RGB conversion.
AFAPI array loadImageMem(const void *ptr)
C++ Interface for loading an image from memory.
AFAPI af_err af_mean_shift(af_array *out, const af_array in, const float spatial_sigma, const float chromatic_sigma, const unsigned iter, const bool is_color)
C Interface for mean shift.
AFAPI af_err af_sobel_operator(af_array *dx, af_array *dy, const af_array img, const unsigned ker_size)
C Interface for getting sobel gradients.
AFAPI array unwrap(const array &in, const dim_t wx, const dim_t wy, const dim_t sx, const dim_t sy, const dim_t px=0, const dim_t py=0, const bool is_column=true)
C++ Interface wrapper for unwrap.
AFAPI af_err af_ycbcr2rgb(af_array *out, const af_array in, const af_ycc_std standard)
C Interface for converting YCbCr to RGB.
af_connectivity connectivity
Definition: defines.h:333
AFAPI af_err af_skew(af_array *out, const af_array in, const float skew0, const float skew1, const dim_t odim0, const dim_t odim1, const af_interp_type method, const bool inverse)
C Interface for skewing an image.