DriveWorks SDK Reference
5.20.37 Release
For Test and Development only

Rectifier.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2015-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
46#ifndef DW_IMAGEPROCESSING_GEOMETRY_RECTIFIER_H_
47#define DW_IMAGEPROCESSING_GEOMETRY_RECTIFIER_H_
48
50#include <dw/core/base/Types.h>
51#include <dw/image/Image.h>
53
54#ifdef __cplusplus
55extern "C" {
56#endif
57
63typedef struct dwRectifierObject* dwRectifierHandle_t;
64
86 dwCameraModelHandle_t cameraIn,
87 dwCameraModelHandle_t cameraOut,
89
105
123
154
173
196 dwRect* roi, dwRectifierHandle_t obj);
197
215DW_DEPRECATED("dwwRectifier_warp has been deprecated, please use dwRectifier_apply")
216dwStatus dwRectifier_warp(dwImageCUDA* outputImage, const dwImageCUDA* inputImage,
217 bool setOutsidePixelsToBlack, dwRectifierHandle_t obj);
218
219#ifdef VIBRANTE
236DW_DEPRECATED("dwwRectifier_warpNvMedia has been deprecated, please use dwRectifier_apply")
238#endif
256DW_DEPRECATED("dwwRectifier_warpROI has been deprecated, please use dwRectifier_apply")
257dwStatus dwRectifier_warpROI(dwImageCUDA* outputImage, const dwImageCUDA* inputImage,
258 bool setOutsidePixelsToBlack, const dwRect roi, dwRectifierHandle_t obj);
259
277
296
314dwStatus dwRectifier_warpPointsCPU(dwVector2f* outputPoints, const dwVector2f* inputPoints,
315 uint32_t pointCount, dwRectifierHandle_t obj);
316
329DW_DEPRECATED("dwRectifier_warpPointsCPUInPlace has been deprecated, please use dwRectifier_warpPointsCPU passing same input and output")
331 uint32_t pointCount, dwRectifierHandle_t obj);
332
351dwStatus dwRectifier_warpPointsGPU(dwVector2f* outputPoints, const dwVector2f* inputPoints,
352 uint32_t pointCount, dwRectifierHandle_t obj);
353
367DW_DEPRECATED("dwRectifier_warpPointsGPUInPlace has been deprecated, please use dwRectifier_warpPointsGPU passing same input and output")
369 uint32_t pointCount, dwRectifierHandle_t obj);
370
387
404
421
438
439#ifdef __cplusplus
440}
441#endif
443#endif // DW_RECTIFIER_H_
NVIDIA DriveWorks API: Camera Methods
NVIDIA DriveWorks API: Core Methods
dwStatus
Status definition.
Definition: ErrorDefs.h:44
Defines a 3x3 matrix of floating point numbers by using only one array.
Definition: MatrixTypes.h:135
NVIDIA DriveWorks API: Core Types
struct dwCameraModelObject * dwCameraModelHandle_t
A pointer to the handle representing a calibrated camera model.
Definition: CameraModel.h:67
float float32_t
Specifies POD types.
Definition: BasicTypes.h:59
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:85
#define DW_DEPRECATED(msg)
Definition: Exports.h:68
#define DW_API_PUBLIC
Definition: Exports.h:56
struct dwImageObject * dwImageHandle_t
Definition: Image.h:105
struct dwImageObject const * dwConstImageHandle_t
Definition: Image.h:106
Defines a CUDA image.
Definition: Image.h:526
Defines an NvMedia image.
Definition: Image.h:542
Specifies a pool of images.
Definition: Image.h:113
Defines the properties of the image.
Definition: Image.h:495
DW_API_PUBLIC dwStatus dwRectifier_warpPointsInPlaceGPU(dwVector2f *points, uint32_t pointCount, dwRectifierHandle_t obj)
Warps an array of dwVector2f on the GPU and writes on the same buffer.
DW_API_PUBLIC dwStatus dwRectifier_warpNvMedia(dwImageNvMedia *outputImage, const dwImageNvMedia *inputImage, dwRectifierHandle_t obj)
Warps the image from the input camera model to the model of the output camera using the Tegra VIC eng...
DW_API_PUBLIC dwStatus dwRectifier_warpROI(dwImageCUDA *outputImage, const dwImageCUDA *inputImage, bool setOutsidePixelsToBlack, const dwRect roi, dwRectifierHandle_t obj)
Warps the image from the input camera model to the model of the output camera limiting the computatio...
DW_API_PUBLIC dwStatus dwRectifier_warpPointsGPU(dwVector2f *outputPoints, const dwVector2f *inputPoints, uint32_t pointCount, dwRectifierHandle_t obj)
Warps an array of dwVector2f on GPU.
DW_API_PUBLIC dwStatus dwRectifier_getDistortionMap(dwImageCUDA *distortionMap, dwRectifierHandle_t obj)
Gets the distortion map as a 2-channel single plane image.
DW_API_PUBLIC dwStatus dwRectifier_release(dwRectifierHandle_t obj)
Releases the rectifier module.
DW_API_PUBLIC dwStatus dwRectifier_getHomography(dwMatrix3f *homography, dwRectifierHandle_t obj)
Gets the homography matrix used.
DW_API_PUBLIC dwStatus dwRectifier_setHomographyFromRotation(float32_t roll, float32_t pitch, float32_t yaw, dwRectifierHandle_t obj)
Calculates and sets the homography matrix used based on a value for roll, pitch and yaw.
DW_API_PUBLIC dwStatus dwRectifier_appendAllocationAttributes(dwImageProperties *const imgProps, dwRectifierHandle_t obj)
Append the allocation attribute such that the images created of type DW_IMAGE_NVMEDIA can be fed to d...
DW_API_PUBLIC dwStatus dwRectifier_warp(dwImageCUDA *outputImage, const dwImageCUDA *inputImage, bool setOutsidePixelsToBlack, dwRectifierHandle_t obj)
Warps the image from the input camera model to the model of the output camera using CUDA on the GPU.
DW_API_PUBLIC dwStatus dwRectifier_setCUDAStream(cudaStream_t stream, dwRectifierHandle_t obj)
Sets the CUDA stream used.
DW_API_PUBLIC dwStatus dwRectifier_getCUDAStream(cudaStream_t *stream, dwRectifierHandle_t obj)
Gets the CUDA stream used.
DW_API_PUBLIC dwStatus dwRectifier_registerImages(dwImagePool imagePool, dwRectifierHandle_t handle)
All (both input and output) images that the rectifier engine has to work with (NvMedia2D VIC mode onl...
struct dwRectifierObject * dwRectifierHandle_t
A pointer to the handle representing a rectifier.
Definition: Rectifier.h:63
DW_API_PUBLIC dwStatus dwRectifier_apply(dwImageHandle_t outputImage, const dwConstImageHandle_t inputImage, dwRect *roi, dwRectifierHandle_t obj)
Warps the image from the input camera model to the model of the output camera using either CUDA on th...
DW_API_PUBLIC dwStatus dwRectifier_setHomography(const dwMatrix3f *homography, dwRectifierHandle_t obj)
Sets the homography matrix used.
DW_API_PUBLIC dwStatus dwRectifier_warpPointsCPU(dwVector2f *outputPoints, const dwVector2f *inputPoints, uint32_t pointCount, dwRectifierHandle_t obj)
Warps an array of CPU dwVector2f on a preallocated output CPU buffer.
DW_API_PUBLIC dwStatus dwRectifier_warpPointsInPlaceCPU(dwVector2f *points, uint32_t pointCount, dwRectifierHandle_t obj)
Warps an array of CPU dwVector2f and writes on the same buffer.
DW_API_PUBLIC dwStatus dwRectifier_initialize(dwRectifierHandle_t *obj, dwCameraModelHandle_t cameraIn, dwCameraModelHandle_t cameraOut, dwContextHandle_t ctx)
Initializes a rectifier based on an input and output camera model and a homography.
DW_API_PUBLIC dwStatus dwRectifier_reset(dwRectifierHandle_t obj)
Resets the rectifier module.
NVIDIA DriveWorks API: Image Conversion and Streaming Functionality
Defines a rectangle.
Defines a two-element single-precision floating-point vector.
Definition: MatrixTypes.h:48