VPI - Vision Programming Interface

3.1 Release

CannyEdges.h
Go to the documentation of this file.
1 /*
2  * Copyright 2022 NVIDIA Corporation. All rights reserved.
3  *
4  * NOTICE TO LICENSEE:
5  *
6  * This source code and/or documentation ("Licensed Deliverables") are
7  * subject to NVIDIA intellectual property rights under U.S. and
8  * international Copyright laws.
9  *
10  * These Licensed Deliverables contained herein is PROPRIETARY and
11  * CONFIDENTIAL to NVIDIA and is being provided under the terms and
12  * conditions of a form of NVIDIA software license agreement by and
13  * between NVIDIA and Licensee ("License Agreement") or electronically
14  * accepted by Licensee. Notwithstanding any terms or conditions to
15  * the contrary in the License Agreement, reproduction or disclosure
16  * of the Licensed Deliverables to any third party without the express
17  * written consent of NVIDIA is prohibited.
18  *
19  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
20  * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
21  * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
22  * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
23  * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
24  * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
25  * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
26  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
27  * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
28  * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
29  * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
31  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32  * OF THESE LICENSED DELIVERABLES.
33  *
34  * U.S. Government End Users. These Licensed Deliverables are a
35  * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
36  * 1995), consisting of "commercial computer software" and "commercial
37  * computer software documentation" as such terms are used in 48
38  * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
39  * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
40  * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
41  * U.S. Government End Users acquire the Licensed Deliverables with
42  * only those rights set forth herein.
43  *
44  * Any use of the Licensed Deliverables in individual and commercial
45  * software must include, in the user documentation and internal
46  * comments to the code, the above Disclaimer and U.S. Government End
47  * Users Notice.
48  */
49 
56 #ifndef NV_VPI_ALGORITHMS_CANNY_EDGE_DETECTOR_H
57 #define NV_VPI_ALGORITHMS_CANNY_EDGE_DETECTOR_H
58 
68 #include "../Export.h"
69 #include "../Status.h"
70 #include "../Types.h"
71 
72 #include <stdint.h>
73 
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77 
101 VPI_PUBLIC VPIStatus vpiCreateCannyEdgeDetector(uint64_t backends, int32_t imageWidth, int32_t imageHeight,
102  VPIPayload *payload);
103 
107 typedef struct
108 {
111 
114 
117  int32_t gradientSize;
119 
132 
192 VPI_PUBLIC VPIStatus vpiSubmitCannyEdgeDetector(VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input,
193  VPIImage output, float thresholdStrong, float thresholdWeak,
194  float edgeValue, float nonEdgeValue,
195  const VPICannyEdgeDetectorParams *params);
196 
197 #ifdef __cplusplus
198 }
199 #endif
200 
203 #endif /* NV_VPI_ALGORITHMS_CANNY_EDGE_DETECTOR_H */
VPIGradientMethod
Different method to generate gradients.
Definition: Types.h:743
VPINormType
Defines the magnitude of vectors.
Definition: Types.h:727
int32_t gradientSize
Gradient window size.
Definition: CannyEdges.h:117
VPIGradientMethod gradMethod
Specify the method used to generate gradient from the input image.
Definition: CannyEdges.h:113
VPINormType normType
Determine the norm to calculate the gradient intensity.
Definition: CannyEdges.h:110
VPIStatus vpiInitCannyEdgeDetectorParams(VPICannyEdgeDetectorParams *params)
Initialize vpiInitCannyEdgeDetectorParams with default values.
VPIStatus vpiSubmitCannyEdgeDetector(VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input, VPIImage output, float thresholdStrong, float thresholdWeak, float edgeValue, float nonEdgeValue, const VPICannyEdgeDetectorParams *params)
Runs the canny edge detector algorithm over an image.
VPIStatus vpiCreateCannyEdgeDetector(uint64_t backends, int32_t imageWidth, int32_t imageHeight, VPIPayload *payload)
Creates payload for vpiSubmitCannyEdgeDetector.
Structure that defines the parameters for vpiSubmitCannyEdgeDetector.
Definition: CannyEdges.h:108
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:256
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:268
VPIStatus
Status codes.
Definition: Status.h:81
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:250