ImageLayer.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// 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 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. 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 products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2019-2020 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_MAPS_IMAGELAYER_H_
#define DW_MAPS_IMAGELAYER_H_

#include <dw/maps/ContentLayers.h>
#include <dw/image/Image.h>

#ifdef __cplusplus
extern "C" {
#endif

//#######################################################################################
// Image Layer
//#######################################################################################

extern const char* const DW_MAPS_IMAGE_LAYER_ID_LIDAR_GROUND_REFLECTANCE;
extern const char* const DW_MAPS_IMAGE_LAYER_ID_LIDAR_ELEVATION_MODEL;
extern const char* const DW_MAPS_IMAGE_LAYER_ID_LIDAR_GIRAFFE_PLANE_RAW;
extern const char* const DW_MAPS_IMAGE_LAYER_ID_LIDAR_GIRAFFE_PLANE;
extern const char* const DW_MAPS_IMAGE_LAYER_ID_RADAR_DETECTIONS_RAW;
extern const char* const DW_MAPS_IMAGE_LAYER_ID_RADAR_DETECTIONS_RCS;
extern const char* const DW_MAPS_IMAGE_LAYER_ID_RADAR_DETECTIONS;

typedef struct dwMapsImageId
{
    uint64_t low;  
    uint64_t high; 
} dwMapsImageId;

typedef enum dwMapsImageType {
    DW_MAPS_IMAGE_TYPE_UNKNOWN                  = (1 << 0), 
    DW_MAPS_IMAGE_TYPE_LIDAR_GROUND_REFLECTANCE = (1 << 1), 
    DW_MAPS_IMAGE_TYPE_LIDAR_ELEVATION_MODEL    = (1 << 2), 
    DW_MAPS_IMAGE_TYPE_LIDAR_HEIGHT_SLICE_RAW   = (1 << 3), 
    DW_MAPS_IMAGE_TYPE_RADAR_DETECTIONS_RCS     = (1 << 4), 
    DW_MAPS_IMAGE_TYPE_RADAR_DETECTIONS_RAW     = (1 << 5), 
    DW_MAPS_IMAGE_TYPE_RADAR_DETECTIONS         = (1 << 6), 
    DW_MAPS_IMAGE_TYPE_LIDAR_HEIGHT_SLICE       = (1 << 7)  
} dwMapsImageType;

typedef struct dwMapsImage
{
    dwMapsImageId id;              
    dwImageCPU* image;             
    dwMapsImageType mapsImageType; 
    float32_t meterPerPx;          
    dwTransformation3f toLocal;    
} dwMapsImage;

typedef struct dwMapsImageLayerProperties
{
    dwMapsImageType mapsImageType; 
    size_t maxWidthPixels;         
    size_t maxHeightPixels;        
} dwMapsImageLayerProperties;

DW_API_PUBLIC
dwStatus dwMapsImageLayer_checkType(dwConstMapsContentLayerHandle_t contentLayerHandle);

DW_API_PUBLIC
dwStatus dwMapsImageLayer_getProperties(dwMapsImageLayerProperties* properties,
                                        dwConstMapsContentLayerHandle_t imageLayerHandle);

//#######################################################################################
// Image Layer View
//#######################################################################################

DW_API_PUBLIC
dwStatus dwMapsImageLayerView_getImageCount(uint32_t* imageCount,
                                            dwConstMapsImageLayerViewHandle_t imageLayerViewHandle);

typedef struct dwMapsImageBuffer
{
    dwMapsImage* buffer; 
    size_t maxSize;      
    size_t size;         
} dwMapsImageBuffer;

DW_API_PUBLIC
dwStatus dwMapsImageLayerView_getLocalImages(dwMapsImageBuffer* localImageBuffer,
                                             dwMapsGeoPoint localOrigin,
                                             const dwMatrix3d* localToENURotation,
                                             dwConstMapsImageLayerViewHandle_t imageLayerViewHandle);

//#######################################################################################
// Maps Image Storage
//#######################################################################################

typedef struct dwMapsImageStorageObject* dwMapsImageStorageHandle_t;
typedef struct dwMapsImageStorageObject const* dwConstMapsImageStorageHandle_t;

DW_API_PUBLIC
dwStatus dwMapsImageStorage_initialize(dwMapsImageStorageHandle_t* imageStorageHandle,
                                       dwMapProviderHandle_t providerHandle,
                                       dwConstMapsContentLayerHandle_t imageLayer,
                                       dwContextHandle_t contextHandle);

DW_API_PUBLIC
dwStatus dwMapsImageStorage_release(dwMapsImageStorageHandle_t imageStorageHandle);

DW_API_PUBLIC
dwStatus dwMapsImageStorage_getMapsImage(dwMapsImage* image,
                                         const dwMapsRoadSegmentId* roadSegmentId,
                                         dwMapsImageStorageHandle_t imageStorageHandle);

DW_API_PUBLIC
dwStatus dwMapsImageStorage_returnMapsImage(dwMapsImage* image,
                                            dwMapsImageStorageHandle_t imageStorageHandle);

DW_API_PUBLIC
dwStatus dwMapsImageStorage_getProperties(dwImageProperties* imageProperties,
                                          dwMapsImageStorageHandle_t imageStorageHandle);

#ifdef __cplusplus
}
#endif

#endif // DW_MAPS_IMAGELAYER_H_