/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/docs-6.3.1/include/rppi_filter_operations.h Source File

• docs-6.3.1
• include

rppi_filter_operations.h

Go to the documentation of this file.

1 /*

2 MIT License

3 

4 Copyright (c) 2019 - 2024 Advanced Micro Devices, Inc.

5 

6 Permission is hereby granted, free of charge, to any person obtaining a copy

7 of this software and associated documentation files (the "Software"), to deal

8 in the Software without restriction, including without limitation the rights

9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

10 copies of the Software, and to permit persons to whom the Software is

11 furnished to do so, subject to the following conditions:

12 

13 The above copyright notice and this permission notice shall be included in all

14 copies or substantial portions of the Software.

15 

16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

22 SOFTWARE.

23 */

24 

25 #ifndef RPPI_FILTER_OPERATIONS_H

26 #define RPPI_FILTER_OPERATIONS_H

27 

28 #include "rppdefs.h"

29 #include "rpp.h"

30 #ifdef __cplusplus

31 extern "C" {

32 #endif

33 

46 /******************** box_filter ********************/

47 

48 // Applies the box filter over every pixel using a [kernelSize X kernelSize] square mask for a batch of images

49 

50 // *param[in] srcPtr Input image batch

51 // *param[in] srcSize Array containing an RppiSize for each image in the batch

52 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

53 // *param[out] dstPtr Output image batch

54 // *param[in] kernelSize Array containing an Rpp32u kernel size for each image in the batch (kernelSize[n] = 3/5/7 for optimal use)

55 // *param[in] nbatchSize Batch size or the number of images in the batch

56 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

57 // *returns a RppStatus enumeration.

58 // *retval RPP_SUCCESS : No error, Succesful completion

59 // *retval RPP_ERROR : Error

60 

61 RppStatus rppi_box_filter_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

62 RppStatus rppi_box_filter_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

63 RppStatus rppi_box_filter_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

64 #ifdef GPU_SUPPORT

65 RppStatus rppi_box_filter_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

66 RppStatus rppi_box_filter_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

67 RppStatus rppi_box_filter_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

68 #endif // GPU_SUPPORT

69 

70 /******************** sobel_filter ********************/

71 

72 // Applies the sobel filter over every pixel using either of the sobel X/Y/both 3x3 square filters for a batch of images

73 

74 // *param[in] srcPtr Input image batch

75 // *param[in] srcSize Array containing an RppiSize for each image in the batch

76 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

77 // *param[out] dstPtr Output image batch

78 // *param[in] sobelType Array containing an Rpp32u sobel filter type for each image in the batch (sobelType[n] = 0/1/2)

79 // *param[in] nbatchSize Batch size or the number of images in the batch

80 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

81 // *returns a RppStatus enumeration.

82 // *retval RPP_SUCCESS : No error, Succesful completion

83 // *retval RPP_ERROR : Error

84 

85 RppStatus rppi_sobel_filter_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *sobelType, Rpp32u nbatchSize, rppHandle_t rppHandle);

86 RppStatus rppi_sobel_filter_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *sobelType, Rpp32u nbatchSize, rppHandle_t rppHandle);

87 RppStatus rppi_sobel_filter_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *sobelType, Rpp32u nbatchSize, rppHandle_t rppHandle);

88 #ifdef GPU_SUPPORT

89 RppStatus rppi_sobel_filter_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *sobelType, Rpp32u nbatchSize, rppHandle_t rppHandle);

90 RppStatus rppi_sobel_filter_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *sobelType, Rpp32u nbatchSize, rppHandle_t rppHandle);

91 RppStatus rppi_sobel_filter_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *sobelType, Rpp32u nbatchSize, rppHandle_t rppHandle);

92 #endif // GPU_SUPPORT

93 

94 /******************** median_filter ********************/

95 

96 // Applies the median filter over every pixel using a [kernelSize X kernelSize] square mask for a batch of images

97 

98 // *param[in] srcPtr Input image batch

99 // *param[in] srcSize Array containing an RppiSize for each image in the batch

100 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

101 // *param[out] dstPtr Output image batch

102 // *param[in] kernelSize Array containing an Rpp32u kernel size for each image in the batch (kernelSize[n] = 3/5/7 for optimal use)

103 // *param[in] nbatchSize Batch size or the number of images in the batch

104 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

105 // *returns a RppStatus enumeration.

106 // *retval RPP_SUCCESS : No error, Succesful completion

107 // *retval RPP_ERROR : Error

108 

109 RppStatus rppi_median_filter_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

110 RppStatus rppi_median_filter_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

111 RppStatus rppi_median_filter_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

112 #ifdef GPU_SUPPORT

113 RppStatus rppi_median_filter_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

114 RppStatus rppi_median_filter_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

115 RppStatus rppi_median_filter_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

116 #endif // GPU_SUPPORT

117 

118 /******************** custom_convolution ********************/

119 

120 // Applies the custom convolution filter over every pixel using a filter kernel provided by the user for a batch of images

121 

122 // *param[in] srcPtr Input image batch

123 // *param[in] srcSize Array containing an RppiSize for each image in the batch

124 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

125 // *param[out] dstPtr Output image batch

126 // *param[in] kernel Array containing an [mxn] convolution kernel for each image in the batch

127 // *param[in] kernelSize Array containing an RppiSize kernel width/height pair for each image in the batch (widths/heights = 3/5/7 for optimal use)

128 // *param[in] nbatchSize Batch size or the number of images in the batch

129 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

130 // *returns a RppStatus enumeration.

131 // *retval RPP_SUCCESS : No error, Succesful completion

132 // *retval RPP_ERROR : Error

133 

134 RppStatus rppi_custom_convolution_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, RppPtr_t kernel, RppiSize *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

135 RppStatus rppi_custom_convolution_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, RppPtr_t kernel, RppiSize *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

136 RppStatus rppi_custom_convolution_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, RppPtr_t kernel, RppiSize *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

137 #ifdef GPU_SUPPORT

138 RppStatus rppi_custom_convolution_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, RppPtr_t kernel, RppiSize *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

139 RppStatus rppi_custom_convolution_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, RppPtr_t kernel, RppiSize *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

140 RppStatus rppi_custom_convolution_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, RppPtr_t kernel, RppiSize *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

141 #endif // GPU_SUPPORT

142 

143 /******************** non_max_suppression ********************/

144 

145 // Applies the non-max suppression filter over every pixel using a [kernelSize X kernelSize] square mask for a batch of images

146 

147 // *param[in] srcPtr Input image batch

148 // *param[in] srcSize Array containing an RppiSize for each image in the batch

149 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

150 // *param[out] dstPtr Output image batch

151 // *param[in] kernelSize Array containing an Rpp32u kernel size for each image in the batch (kernelSize[n] = 3/5/7 for optimal use)

152 // *param[in] nbatchSize Batch size or the number of images in the batch

153 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

154 // *returns a RppStatus enumeration.

155 // *retval RPP_SUCCESS : No error, Succesful completion

156 // *retval RPP_ERROR : Error

157 

158 RppStatus rppi_non_max_suppression_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

159 RppStatus rppi_non_max_suppression_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

160 RppStatus rppi_non_max_suppression_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

161 #ifdef GPU_SUPPORT

162 RppStatus rppi_non_max_suppression_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

163 RppStatus rppi_non_max_suppression_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

164 RppStatus rppi_non_max_suppression_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

165 #endif // GPU_SUPPORT

166 

167 /******************** gaussian_filter ********************/

168 

169 // Applies the gaussian filter over every pixel using a [kernelSize X kernelSize] square mask for a batch of images

170 

171 // *param[in] srcPtr Input image batch

172 // *param[in] srcSize Array containing an RppiSize for each image in the batch

173 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

174 // *param[out] dstPtr Output image batch

175 // *param[in] stdDev Array containing an Rpp32f standard deviation to populate the kernel for each image in the batch

176 // *param[in] kernelSize Array containing an Rpp32u kernel size for each image in the batch (kernelSize[n] = 3/5/7 for optimal use)

177 // *param[in] nbatchSize Batch size or the number of images in the batch

178 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

179 // *returns a RppStatus enumeration.

180 // *retval RPP_SUCCESS : No error, Succesful completion

181 // *retval RPP_ERROR : Error

182 

183 RppStatus rppi_gaussian_filter_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32f *stdDev, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

184 RppStatus rppi_gaussian_filter_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32f *stdDev, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

185 RppStatus rppi_gaussian_filter_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32f *stdDev, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

186 #ifdef GPU_SUPPORT

187 RppStatus rppi_gaussian_filter_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32f *stdDev, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

188 RppStatus rppi_gaussian_filter_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32f *stdDev, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

189 RppStatus rppi_gaussian_filter_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32f *stdDev, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

190 #endif // GPU_SUPPORT

191 

192 /******************** nonlinear_filter ********************/

193 

194 // Applies the nonlinear filter over every pixel using a [kernelSize X kernelSize] square mask for a batch of images

195 

196 // *param[in] srcPtr Input image batch

197 // *param[in] srcSize Array containing an RppiSize for each image in the batch

198 // *param[in] maxSrcSize A single RppiSize which is the maxWidth and maxHeight for all images in the batch

199 // *param[out] dstPtr Output image batch

200 // *param[in] kernelSize Array containing an Rpp32u kernel size for each image in the batch (kernelSize[n] = 3/5/7 for optimal use)

201 // *param[in] nbatchSize Batch size or the number of images in the batch

202 // *param[in] rppHandle OpenCL-handle/HIP-handle for "_gpu" variants and Host-handle for "_host" variants

203 // *returns a RppStatus enumeration.

204 // *retval RPP_SUCCESS : No error, Succesful completion

205 // *retval RPP_ERROR : Error

206 

207 RppStatus rppi_nonlinear_filter_u8_pln1_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

208 RppStatus rppi_nonlinear_filter_u8_pln3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

209 RppStatus rppi_nonlinear_filter_u8_pkd3_batchPD_host(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

210 #ifdef GPU_SUPPORT

211 RppStatus rppi_nonlinear_filter_u8_pln1_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

212 RppStatus rppi_nonlinear_filter_u8_pln3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

213 RppStatus rppi_nonlinear_filter_u8_pkd3_batchPD_gpu(RppPtr_t srcPtr, RppiSize *srcSize, RppiSize maxSrcSize, RppPtr_t dstPtr, Rpp32u *kernelSize, Rpp32u nbatchSize, rppHandle_t rppHandle);

214 #endif // GPU_SUPPORT

215 

219 #ifdef __cplusplus

220 }

221 #endif

222 #endif

Rpp32u

unsigned int Rpp32u

32 bit unsigned int

Definition: rppdefs.h:89

RppPtr_t

void * RppPtr_t

void pointer

Definition: rppdefs.h:101

RppStatus

RppStatus

RPP RppStatus type enums.

Definition: rppdefs.h:109

Rpp32f

float Rpp32f

32 bit float

Definition: rppdefs.h:97

rpp.h

RPP top-level header with RPP handle API.

rppdefs.h

RPP common HOST/GPU typedef, enum and structure definitions.

RppiSize

RPPI Image size(Width/Height dimensions) type struct.

Definition: rppdefs.h:326