Radar.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) 2017 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_SENSORS_RADAR_RADAR_H__
#define DW_SENSORS_RADAR_RADAR_H__

#include <dw/core/Config.h>
#include <dw/core/Types.h>

#include <dw/sensors/Sensors.h>

#pragma pack(push,1) // Make sure we have consistent structure packings

typedef enum
{
    DW_RADAR_RANGE_SHORT = 0,

    DW_RADAR_RANGE_MEDIUM = 1,

    DW_RADAR_RANGE_LONG   = 2,

    DW_RADAR_RANGE_UNKNOWN = 4,

    DW_RADAR_RANGE_COUNT = 5,
} dwRadarRange;

typedef enum
{
    DW_RADAR_RETURN_TYPE_DETECTION = 0,

    DW_RADAR_RETURN_TYPE_TRACK  = 1,

    DW_RADAR_RETURN_TYPE_STATUS  = 2,

    DW_RADAR_RETURN_TYPE_COUNT = 3,
} dwRadarReturnType;

typedef enum
{
    DW_RADAR_DYNAMIC_STATE_MOVING = 0,

    DW_RADAR_DYNAMIC_STATE_STATIONARY = 1,

    DW_RADAR_DYNAMIC_STATE_ONCOMING = 2,

    DW_RADAR_DYNAMIC_STATE_CROSS_TRAFFIC = 3,

    DW_RADAR_DYNAMIC_STATE_UNKNOWN = 4,
} dwRadarDynamicState;

typedef struct
{
    dwRadarReturnType returnType;

    dwRadarRange range;
} dwRadarScanType;

typedef struct
{
    float32_t x;

    float32_t y;

    float32_t Vx;

    float32_t Vy;

    float32_t Ax;

    float32_t Ay;

    float32_t azimuth;

    float32_t radius;

    float32_t radialVelocity;

    float32_t radialAcceleration;

    float32_t rcs;

    float32_t elevationAngle;

    dwBool elevationValidity;
} dwRadarDetection;

typedef struct
{
    uint32_t id;

    uint32_t age;

    float32_t confidence;

    dwRadarDynamicState dynamicState;

    float32_t x;

    float32_t y;

    float32_t Vx;

    float32_t Vy;

    float32_t Ax;

    float32_t Ay;

    float32_t azimuth;

    float32_t azimuthRate;

    float32_t radius;

    float32_t radialVelocity;

    float32_t radialAcceleration;

    float32_t rcs;
} dwRadarTrack;

typedef struct
{
    float32_t x;

    float32_t y;

    float32_t z;

    float32_t yaw;

    float32_t pitch;

    float32_t roll;

    /*
     * Deviation of azimuth angle for returns (radians)
     * This is the deviation of the measured azimuth from what would be
     * expected based on the geometric boresight of the sensor.
     */
    float32_t azimuthDeviation[DW_RADAR_RANGE_COUNT];

    /*
     * Deviation of elevation angle for returns (radians)
     * This is the deviation of the elevation azimuth from what would be
     * expected based on the geometric boresight of the sensor.
     */
    float32_t elevationDeviation[DW_RADAR_RANGE_COUNT];

    dwBool sensorAligned;

    dwBool sensorOK;

    dwBool sensorDisturbed;

    dwBool sensorBlock;
} dwRadarStatus;

typedef struct
{
    uint32_t scanIndex;

    dwTime_t sensorTimestamp;

    dwTime_t hostTimestamp;

    dwRadarScanType scanType;

    uint32_t numReturns;

    void *data;
} dwRadarScan;

typedef struct
{
    float32_t velocity;

    float32_t acceleration;

    float32_t lateralAcceleration;

    float32_t yawRate;
} dwRadarVehicleState;

typedef struct
{
    uint32_t sensorId;

    dwTransformation radarPosition;

    float32_t wheelbase;

    float32_t damping;

    dwBool isReversed;
} dwRadarMountPosition;

#pragma pack(pop)

typedef struct
{
    uint8_t isDecodingOn;

    uint32_t numScanTypes;

    uint32_t supportedScanTypes[DW_RADAR_RETURN_TYPE_COUNT][DW_RADAR_RANGE_COUNT];

    uint32_t packetsPerScan;

    uint32_t maxReturnsPerScan;

    uint32_t scansPerSecond;

    uint32_t   inputPacketsPerSecond;
} dwRadarProperties;

#ifdef __cplusplus
extern "C" {
#endif

DW_API_PUBLIC
dwStatus dwSensorRadar_toggleScanType(dwBool enable, dwRadarScanType scanType, dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_setDataDecoding(dwBool enable, dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_readScan(const dwRadarScan **data, const dwRadarScanType type,
                                  const dwTime_t timeout_us, dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_returnScan(const dwRadarScan *scan, dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_processRawData(const dwRadarScan **data, const uint8_t *rawData, size_t size,
                                      dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_getProperties(dwRadarProperties *radarProperties, dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_setVehicleState(dwRadarVehicleState *data, dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorRadar_setMountPosition(dwRadarMountPosition *data, dwSensorHandle_t sensor);

#ifdef __cplusplus
}
#endif

#endif // DW_SENSORS_RADAR_RADAR_H__