VPI - Vision Programming Interface

1.0 Release

WarpMap.h
Go to the documentation of this file.
1 /*
2  * Copyright 2020-2021 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_WARPMAP_H
57 #define NV_VPI_WARPMAP_H
58 
59 #include "Export.h"
60 #include "Status.h"
61 #include "Types.h"
62 #include "WarpGrid.h"
63 
64 #include <stdint.h>
65 
77 #ifdef __cplusplus
78 extern "C" {
79 #endif
80 
87 typedef struct
88 {
92 
96  int16_t numHorizPoints;
100  int16_t numVertPoints;
101 
105  int16_t pitchBytes;
106 
112 } VPIWarpMap;
113 
126 
133 VPI_PUBLIC void vpiWarpMapFreeData(VPIWarpMap *warpMap);
134 
145 
146 #ifdef __cplusplus
147 }
148 #endif
149 
152 #endif /* NV_VPI_WARPMAP_H */
Declaration of VPI status codes handling functions.
Defines all types needed for programming with VPI.
Declares structures and constants used for warp grid definition.
VPIStatus
Status codes.
Definition: Status.h:81
Stores a keypoint coordinate.
Definition: Types.h:255
VPIWarpGrid grid
Warp grid control point structure definition.
Definition: WarpMap.h:91
VPIKeypoint * keypoints
Pointer to an array with control point positions in the input image corresponding to those in the out...
Definition: WarpMap.h:111
int16_t pitchBytes
Number of bytes between one control point and the one immediately below.
Definition: WarpMap.h:105
int16_t numHorizPoints
Number of points horizontally.
Definition: WarpMap.h:96
int16_t numVertPoints
Number of points vertically.
Definition: WarpMap.h:100
void vpiWarpMapFreeData(VPIWarpMap *warpMap)
Deallocates the warp map control points allocated by vpiWarpMapAllocData.
VPIStatus vpiWarpMapGenerateIdentity(VPIWarpMap *warpMap)
Fills the given warp map with an identity mapping.
VPIStatus vpiWarpMapAllocData(VPIWarpMap *warpMap)
Allocates the warp map's control point array for a given warp grid.
Holds VPI's warp grid definition.
Definition: WarpGrid.h:157
Defines the mapping between input and output images' pixels.
Definition: WarpMap.h:88