VPI - Vision Programming Interface

2.2 Release

ORB.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_ORB_H
57 #define NV_VPI_ALGORITHMS_ORB_H
58 
68 #include "../Export.h"
69 #include "../Status.h"
70 #include "../Types.h"
71 #include "FASTCorners.h"
72 
73 #include <stddef.h>
74 #include <stdint.h>
75 
76 #ifdef __cplusplus
77 extern "C" {
78 #endif
79 
83 typedef struct
84 {
89 
93  int32_t maxFeatures;
94 
98  int32_t pyramidLevels;
99 
103  uint8_t enableRBRIEF;
104 
109 } VPIORBParams;
110 
128 
153 VPI_PUBLIC VPIStatus vpiCreateORBFeatureDetector(uint64_t backends, size_t capacity, VPIPayload *payload);
154 
214 VPI_PUBLIC VPIStatus vpiSubmitORBFeatureDetector(VPIStream stream, uint64_t backend, VPIPayload payload,
215  VPIPyramid input, VPIArray outCorners, VPIArray outDescriptors,
216  const VPIORBParams *params, VPIBorderExtension border);
217 
218 #ifdef __cplusplus
219 }
220 #endif
221  // end of VPI_OrbFeatureDetector
223 
224 #endif /* NV_VPI_ALGORITHMS_ORB_H */
Declares functions that implement support for FAST Corners.
VPICornerScore
Enum defining different types of corner scores.
Definition: Types.h:340
struct VPIArrayImpl * VPIArray
A handle to an array.
Definition: Types.h:232
Structure that defines the parameters for vpiSubmitFASTCornerDetector.
Definition: FASTCorners.h:82
VPICornerScore scoreType
The scoring criteria for ordering the top N FAST corners.
Definition: ORB.h:108
int32_t maxFeatures
The maximum number of features alloted per level of the scale pyramid.
Definition: ORB.h:93
uint8_t enableRBRIEF
Whether or not to enable rBRIEF (rotationally invariant BRIEF).
Definition: ORB.h:103
VPIFASTCornerDetectorParams fastParams
Parameters for oFAST implementation.
Definition: ORB.h:88
int32_t pyramidLevels
The number of levels in the scale pyramid to utilize.
Definition: ORB.h:98
VPIStatus vpiInitORBParams(VPIORBParams *params)
Initializes VPIORBParams with default values.
VPIStatus vpiCreateORBFeatureDetector(uint64_t backends, size_t capacity, VPIPayload *payload)
Creates a ORB payload.
VPIStatus vpiSubmitORBFeatureDetector(VPIStream stream, uint64_t backend, VPIPayload payload, VPIPyramid input, VPIArray outCorners, VPIArray outDescriptors, const VPIORBParams *params, VPIBorderExtension border)
Submits a ORB operation to the stream.
Structure that defines the parameters for both vpiCreateORBFeatureDetector and vpiSubmitORBFeatureDet...
Definition: ORB.h:84
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:268
struct VPIPyramidImpl * VPIPyramid
A handle to an image pyramid.
Definition: Types.h:262
VPIStatus
Status codes.
Definition: Status.h:81
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:250
VPIBorderExtension
Image border extension specify how pixel values outside of the image domain should be constructed.
Definition: Types.h:277