DriveWorks SDK Reference
3.0.4260 Release
For Test and Development only

/dvs/git/dirty/gitlab-master_av/dw/sdk/doc/tutorials/dwx_tutorials_basic.md
Go to the documentation of this file.
1 # Copyright (c) 2019-2020 NVIDIA CORPORATION. All rights reserved.
2 
3 @page basic_tutorials Basic Tutorials
4 @tableofcontents
5 
6 @note The following tutorials are applicable to modules in both **NVIDIA DriveWorks** and **NVIDIA DRIVE Software** releases.
7 
8 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>
9 before proceeding to the @ref intermediate_tutorials and @ref advanced_tutorials.
10 
11 These basic tutorials teach you how to re-build existing samples, learn about the foundation modules, and create your first application. <br>
12 They also teach you how to access all supported sensors and replay recorded data.<br>
13 
14 @section dwx_101_tutorials DriveWorks 101
15 
16 | Tutorial | Description |
17 |------|-------------|
18 | @ref dwx_samples_building | Compiling DriveWorks samples from sources on multiple platforms. |
19 | @ref dwx_conventions | An overview on naming conventions, coordinate systems, and alignment. |
20 | @ref core_usecase5 | Understanding the DriveWorks context. |
21 | @ref core_usecase2 | Retrieving system and platform information. |
22 | @ref dwx_hello_world | Putting it all together: creating your first DriveWorks based application. |
23 | @ref dwx_samples_gpu | Switching between iGPU and dGPU. |
24 | @ref core_usecase4 | Leveraging DriveWorks logging mechanisms. |
25 | @ref core_usecase3 | Conventions for avoiding runtime memory corruption. |
26 
27 **Modules used:** @ref core_mainsection.
28 <br>
29 <br>
30 
31 @section dwx_sensors_tutorials Accessing Sensors
32 
33 @subsection dwx_sensors_overview_tutorials Sensors Overview
34 
35 | Tutorial | Description |
36 |------|-------------|
37 | @ref sensors_usecase1 | The general workflow required to use all supported sensors. |
38 | @ref sensors_usecase2 | Querying all supported sensors on a given platform. |
39 | @ref sensors_usecase3 | Converting raw sensor data into a byte stream. |
40 | @ref sensors_usecase4 | Obtaining accurate timing information. |
41 | @ref sensors_usecase5 | Using virtual sensors to replay pre-recorded data. |
42 
43 **Modules used:** @ref core_mainsection | @ref sensors_mainsection.
44 <br>
45 <br>
46 
47 @subsection dwx_sensors_camera_tutorials Camera Usage
48 
49 | Tutorial | Description |
50 |------|-------------|
51 | @ref camera_usecase1 | An example on accessing camera sensors. |
52 | @ref camera_usecase3 | Using the NvMedia Sensor Input Processing Library on live sensors. |
53 | @ref camera_usecase4 | Using the NvMedia Sensor Input Processing Library on recordings. |
54 
55 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref camera_mainsection.
56 <br>
57 <br>
58 
59 @subsection dwx_sensors_canbus_tutorials CANBUS Usage
60 
61 | Tutorial | Description |
62 |------|-------------|
63 | @ref canbus_usecase1 | An example on accessing the CANBUS. |
64 | @ref canbus_usecase2 | Parsing raw CANBUS data. |
65 | @ref canbus_usecase3 | The DriveWorks interpreter for the DBC format. |
66 
67 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref canbus_mainsection.
68 <br>
69 <br>
70 
71 @subsection dwx_sensors_gps_tutorials GPS Usage
72 
73 | Tutorial | Description |
74 |------|-------------|
75 | @ref gps_usecase1 | An example on accessing GPS sensors. |
76 | @ref gps_usecase2 | An example on reading GPS data in raw format. |
77 
78 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref gps_mainsection.
79 <br>
80 <br>
81 
82 @subsection dwx_sensors_imu_tutorials IMU Usage
83 
84 | Tutorial | Description |
85 |------|-------------|
86 | @ref imu_usecase1 | An example on accessing IMU sensors. |
87 | @ref imu_usecase2 | An example on reading IMU data in raw format. |
88 
89 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref imu_mainsection.
90 <br>
91 <br>
92 
93 @subsection dwx_sensors_lidar_tutorials Lidar Usage
94 
95 | Tutorial | Description |
96 |------|-------------|
97 | @ref lidar_usecase1 | Reading Lidar decoded data from live and virtual sensors. |
98 | @ref lidar_usecase2 | Reading and decoding Lidar raw data. |
99 | @ref lidar_usecase3 | Reducing packet loss. |
100 
101 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref lidar_mainsection.
102 <br>
103 <br>
104 
105 @subsection dwx_sensors_radar_tutorials Radar Usage
106 
107 | Tutorial | Description |
108 |------|-------------|
109 | @ref radar_usecase1 | An example on accessing Radar sensors. |
110 
111 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref radar_mainsection.
112 <br>
113 <br>
114 
115 @subsection dwx_sensors_time_tutorials Time Usage
116 
117 | Tutorial | Description |
118 |------|-------------|
119 | @ref time_usecase1 | An example on receiving time synchronized Lidar packets from a live Lidar sensor. |
120 
121 **Modules used:** @ref core_mainsection | @ref sensors_mainsection | @ref time_mainsection.
122 <br>
123 <br>
124 
125 @section dwx_rig_tutorials Accessing Rig Configurations
126 
127 | Tutorial | Description |
128 |------|-------------|
129 | @ref rigconfiguration_usecase0 | How rigs are described in DriveWorks. |
130 | @ref rigconfiguration_usecase1 | Accessing Vehicle Properties and Sensors From a Rig File |
131 
132 **Modules used:** @ref core_mainsection | @ref rig_mainsection.
133 <br>
134 <br>
135 
136 @section dwx_utility_tutorials Utilities
137 
138 | Tutorial | Description |
139 |------|-------------|
140 | @ref ipc_usecase1 | Inter Process Communication with Sockets. |
141 | @ref renderer_usecase1 | An introduction on low level rendering APIs. |
142 | @ref renderer_usecase2 | A more advanced method for drawing points, lines, triangles, boxes, ellipses, and grids. |
143 
144 **Modules used:** @ref ipc_mainsection | @ref renderer_mainsection.
145 <br>
146 <br>
147 
148 @section dwx_calib_record_tutorials Static Calibration and Recording Data
149 
150 | Tutorial | Description |
151 |------|-------------|
152 | @ref dwx_calibration_overview | Overview over the static calibration tools. |
153 | @ref dwx_camera_calibration | An in-depth guide for how to statically calibrate your cameras. |
154 | @ref dwx_recording_devguide_group | Everything you need to know about the DriveWorks recording tool. |