VPI - Vision Programming Interface

3.2 Release

AprilTags.h
Go to the documentation of this file.
1 /*
2  * Copyright 2024 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_APRIL_TAGS_H
57 #define NV_VPI_ALGORITHMS_APRIL_TAGS_H
58 
59 #include "../Export.h"
60 #include "../Status.h"
61 #include "../Types.h"
62 
63 #include <stdint.h>
64 
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68 
83 typedef enum
84 {
106 
111 typedef struct
112 {
116  const uint16_t *tagIdFilter;
127 
143 
172 VPI_PUBLIC VPIStatus vpiCreateAprilTagDetector(uint64_t backends, int32_t inputWidth, int32_t inputHeight,
173  VPIAprilTagDecodeParams const *params, VPIPayload *payload);
174 
208 VPI_PUBLIC VPIStatus vpiSubmitAprilTagDetector(VPIStream stream, uint64_t backend, VPIPayload payload,
209  uint32_t maxDetections, VPIImage input, VPIArray outDetections);
210 
242 VPI_PUBLIC VPIStatus vpiSubmitAprilTagPoseEstimation(VPIStream stream, uint64_t backend, VPIArray inDetections,
243  const VPICameraIntrinsic intrinsics, float tagSize,
244  VPIArray outPoses);
245 
248 #ifdef __cplusplus
249 }
250 #endif
251 
252 #endif /* NV_VPI_ALGORITHMS_APRIL_TAGS_H */
int32_t tagIdFilterSize
Size of tagIdFilter array if not NULL.
Definition: AprilTags.h:120
const uint16_t * tagIdFilter
Optional array of tag ids from family which represent valid detections.
Definition: AprilTags.h:116
VPIAprilTagFamily family
Which family to detect.
Definition: AprilTags.h:125
int32_t maxBitsCorrected
Maximum number of bits to correct during decoding.
Definition: AprilTags.h:123
VPIStatus vpiSubmitAprilTagPoseEstimation(VPIStream stream, uint64_t backend, VPIArray inDetections, const VPICameraIntrinsic intrinsics, float tagSize, VPIArray outPoses)
Submits a AprilTag pose estimation operation to the stream.
VPIStatus vpiCreateAprilTagDetector(uint64_t backends, int32_t inputWidth, int32_t inputHeight, VPIAprilTagDecodeParams const *params, VPIPayload *payload)
Creates a AprilTag detector payload.
VPIStatus vpiInitAprilTagDecodeParams(VPIAprilTagDecodeParams *params)
Initializes VPIAprilTagDecodeParams with default values.
VPIStatus vpiSubmitAprilTagDetector(VPIStream stream, uint64_t backend, VPIPayload payload, uint32_t maxDetections, VPIImage input, VPIArray outDetections)
Submits a AprilTag detector operation to the stream.
VPIAprilTagFamily
Specify the family of AprilTags to detect.
Definition: AprilTags.h:84
@ VPI_APRILTAG_STANDARD52H13
Standard52h13 family.
Definition: AprilTags.h:104
@ VPI_APRILTAG_STANDARD41H12
Standard41h12 family.
Definition: AprilTags.h:102
@ VPI_APRILTAG_25H9
25h9 family
Definition: AprilTags.h:90
@ VPI_APRILTAG_36H11
36h11 family
Definition: AprilTags.h:94
@ VPI_APRILTAG_INVALID
Invalid value.
Definition: AprilTags.h:86
@ VPI_APRILTAG_CIRCLE49H12
Circle49h12 family.
Definition: AprilTags.h:98
@ VPI_APRILTAG_36H10
36h10 family
Definition: AprilTags.h:92
@ VPI_APRILTAG_16H5
16h5 family
Definition: AprilTags.h:88
@ VPI_APRILTAG_CIRCLE21H7
Circle21h7 family.
Definition: AprilTags.h:96
@ VPI_APRILTAG_CUSTOM48H12
Custom48h12 family.
Definition: AprilTags.h:100
Decode parameters for vpiCreateAprilTagDetector.
Definition: AprilTags.h:112
struct VPIArrayImpl * VPIArray
A handle to an array.
Definition: Types.h:232
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:256
float VPICameraIntrinsic[2][3]
Camera intrinsic matrix.
Definition: Types.h:655
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