doc/tutorials/dwx_tutorials_basic.md

Go to the documentation of this file.

# Copyright (c) 2019-2020 NVIDIA CORPORATION.  All rights reserved.

@page basic_tutorials Basic Tutorials
@tableofcontents

If you are new to this SDK, begin with this section to get a general overview of DriveWorks. Ensure you have a firm understanding <br>
before proceeding to the @ref intermediate_tutorials and @ref advanced_tutorials.

These basic tutorials teach you how to re-build existing samples, learn about the foundation modules, and create your first application. <br>
They also teach you how to access all supported sensors and replay recorded data.<br>

@section dwx_101_tutorials DriveWorks 101

| Tutorial | Description |
|------|-------------|
| @ref dwx_samples_building | Compiling DriveWorks samples from sources on multiple platforms. |
| @ref dwx_conventions | An overview on naming conventions, coordinate systems, and alignment. |
| @ref core_usecase5 | Understanding the DriveWorks context. |
| @ref core_usecase2 | Retrieving system and platform information. |
| @ref dwx_hello_world | Putting it all together: creating your first DriveWorks based application. |
| @ref dwx_samples_gpu | Switching between iGPU and dGPU. |
| @ref core_usecase4 | Leveraging DriveWorks logging mechanisms. |
| @ref core_usecase3 | Conventions for avoiding runtime memory corruption. |

**Modules used:** @ref core_mainsection.
<br>
<br>

@section dwx_sensors_tutorials Accessing Sensors

@subsection dwx_sensors_overview_tutorials Sensors Overview

| Tutorial | Description |
|------|-------------|
| @ref sensors_usecase1 | The general workflow required to use all supported sensors. |
| @ref sensors_usecase2 | Querying all supported sensors on a given platform. |
| @ref sensors_usecase3 | Converting raw sensor data into a byte stream. |
| @ref sensors_usecase4 | Obtaining accurate timing information. |
| @ref sensors_usecase5 | Using virtual sensors to replay pre-recorded data. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection.
<br>
<br>

@subsection dwx_sensors_camera_tutorials Camera Usage

| Tutorial | Description |
|------|-------------|
| @ref camera_usecase1 | An example on accessing camera sensors. |
| @ref camera_usecase3 | Using the NvMedia Sensor Input Processing Library on live sensors. |
| @ref camera_usecase4 | Using the NvMedia Sensor Input Processing Library on recordings. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref camera_mainsection.
<br>
<br>

@subsection dwx_sensors_canbus_tutorials CANBUS Usage

| Tutorial | Description |
|------|-------------|
| @ref canbus_usecase1 | An example on accessing the CANBUS. |
| @ref canbus_usecase2 | Parsing raw CANBUS data. |
| @ref canbus_usecase3 | The DriveWorks interpreter for the DBC format. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref canbus_mainsection.
<br>
<br>

@subsection dwx_sensors_gps_tutorials GPS Usage

| Tutorial | Description |
|------|-------------|
| @ref gps_usecase1 | An example on accessing GPS sensors. |
| @ref gps_usecase2 | An example on reading GPS data in raw format. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref gps_mainsection.
<br>
<br>

@subsection dwx_sensors_imu_tutorials IMU Usage

| Tutorial | Description |
|------|-------------|
| @ref imu_usecase1 | An example on accessing IMU sensors. |
| @ref imu_usecase2 | An example on reading IMU data in raw format. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref imu_mainsection.
<br>
<br>

@subsection dwx_sensors_lidar_tutorials Lidar Usage

| Tutorial | Description |
|------|-------------|
| @ref lidar_usecase1 | Reading Lidar decoded data from live and virtual sensors. |
| @ref lidar_usecase2 | Reading and decoding Lidar raw data. |
| @ref lidar_usecase3 | Reducing packet loss. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref lidar_mainsection.
<br>
<br>

@subsection dwx_sensors_radar_tutorials Radar Usage

| Tutorial | Description |
|------|-------------|
| @ref radar_usecase1 | An example on accessing Radar sensors. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref radar_mainsection.
<br>
<br>

@subsection dwx_sensors_time_tutorials Time Usage

| Tutorial | Description |
|------|-------------|
| @ref time_usecase1 | An example on receiving time synchronized Lidar packets from a live Lidar sensor. |

**Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref time_mainsection.
<br>
<br>

@section dwx_rig_tutorials Accessing Rig Configurations

| Tutorial | Description |
|------|-------------|
| @ref rigconfiguration_usecase0 | How rigs are described in DriveWorks. |
| @ref rigconfiguration_usecase1 | Accessing Vehicle Properties and Sensors From a Rig File |

**Modules used:** @ref core_mainsection | @ref rig_mainsection.
<br>
<br>

@section dwx_utility_tutorials Utilities

| Tutorial | Description |
|------|-------------|
| @ref ipc_usecase1 | Inter Process Communication with Sockets. |
| @ref renderer_usecase1 | An introduction on low level rendering APIs. |
| @ref renderer_usecase2 | A more advanced method for drawing points, lines, triangles, boxes, ellipses, and grids. |

**Modules used:** @ref ipc_mainsection | @ref renderer_mainsection.
<br>
<br>

@section dwx_calib_record_tutorials Static Calibration and Recording Data

| Tutorial | Description |
|------|-------------|
| @ref dwx_calibration_overview | Overview over the static calibration tools. |
| @ref dwx_camera_calibration | An in-depth guide for how to statically calibrate your cameras. |
| @ref dwx_recording_devguide_group | Everything you need to know about the DriveWorks recording tool. |