PointCloudRangeImageCreator.h

Go to the documentation of this file.

//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2018-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//

#ifndef DW_POINTCLOUDPROCESSING_POINTCLOUDRANGEIMAGECREATOR_H_
#define DW_POINTCLOUDPROCESSING_POINTCLOUDRANGEIMAGECREATOR_H_

#include <dw/core/base/Types.h>
#include <dw/core/context/Context.h>
#include <dw/pointcloudprocessing/pointcloud/PointCloud.h>
#include <dw/image/Image.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwPointCloudRangeImageCreatorObject* dwPointCloudRangeImageCreatorHandle_t;
typedef const struct dwPointCloudRangeImageCreatorObject* dwConstPointCloudRangeImageCreatorHandle_t;

typedef enum {
    DW_POINT_CLOUD_IMAGE_TYPE_DISTANCE  = 0, 
    DW_POINT_CLOUD_IMAGE_TYPE_INTENSITY = 1, 
    DW_POINT_CLOUD_IMAGE_TYPE_2D_GRID   = 2, 
} dwPointCloudRangeImageType;

typedef struct
{
    float32_t farDist;  
    float32_t nearDist; 

    float32_t minElevationRadians; 
    float32_t maxElevationRadians; 
    float32_t minAzimuthRadians;   
    float32_t maxAzimuthRadians;   

    dwOrientedBoundingBox3f orientedBoundingBox; 
} dwPointCloudRangeImageClippingParams;

typedef struct
{
    dwMemoryType memoryType;                             
    uint32_t maxInputPoints;                             
    uint32_t width;                                      
    uint32_t height;                                     
    dwPointCloudRangeImageType type;                     
    dwTransformation3f transformation;                   
    dwPointCloudRangeImageClippingParams clippingParams; 
} dwPointCloudRangeImageCreatorParams;

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_initialize(dwPointCloudRangeImageCreatorHandle_t* const obj,
                                          dwPointCloudRangeImageCreatorParams const* const params,
                                          dwContextHandle_t const ctx);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_reset(dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_release(dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_getDefaultParams(dwPointCloudRangeImageCreatorParams* const params);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_getCUDAStream(cudaStream_t* const stream,
                                             dwConstPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_setCUDAStream(cudaStream_t const stream,
                                             dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_getImageProperties(dwImageProperties* const imageProperties,
                                                  dwConstPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_bindInput(dwPointCloud const* const pointCloud,
                                         dwPointCloudRangeImageCreatorHandle_t const obj);
DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_bindOutput(dwImageHandle_t const image,
                                          dwPointCloudRangeImageCreatorHandle_t const obj);
DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_bindPointCloudOutput(dwPointCloud* const pointCloud,
                                                    dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
dwStatus dwPCRangeImageCreator_process(dwPointCloudRangeImageCreatorHandle_t const obj);

// DEPRECATED API FUNCTIONS

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_initialize() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_initialize() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_initialize(dwPointCloudRangeImageCreatorHandle_t* const obj,
                                                  dwPointCloudRangeImageCreatorParams const* const params,
                                                  dwContextHandle_t const ctx);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_reset() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_reset() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_reset(dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_release() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_release() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_release(dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_getDefaultParams() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_getDefaultParams() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_getDefaultParams(dwPointCloudRangeImageCreatorParams* const params);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_getCUDAStream() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_getCUDAStream() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_getCUDAStream(cudaStream_t* const stream,
                                                     dwConstPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_setCUDAStream() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_setCUDAStream() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_setCUDAStream(cudaStream_t const stream,
                                                     dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_getImageProperties() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_getImageProperties() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_getImageProperties(dwImageProperties* const imageProperties,
                                                          dwConstPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_bindInput() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_bindInput() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_bindInput(dwPointCloud const* const pointCloud,
                                                 dwPointCloudRangeImageCreatorHandle_t const obj);
DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_bindOutput() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_bindOutput() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_bindOutput(dwImageHandle_t const image,
                                                  dwPointCloudRangeImageCreatorHandle_t const obj);
DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_bindOutputPointCloud() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_bindPointCloudOutput() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_bindOutputPointCloud(dwPointCloud* const pointCloud,
                                                            dwPointCloudRangeImageCreatorHandle_t const obj);

DW_API_PUBLIC
DW_DEPRECATED("dwPointCloudRangeImageCreator_process() is renamed / deprecated and will be removed in the next major release,"
              " use dwPCRangeImageCreator_process() instead")
// coverity[misra_c_2012_rule_5_1_violation] Deprecated API
dwStatus dwPointCloudRangeImageCreator_process(dwPointCloudRangeImageCreatorHandle_t const obj);

#ifdef __cplusplus
}
#endif

#endif // DW_POINTCLOUDPROCESSING_POINTCLOUDRANGEIMAGECREATOR_H_