DriveWorks SDK Reference
4.0.0 Release
For Test and Development only

tools/README.md
Go to the documentation of this file.
1 # Copyright (c) 2019-2020 NVIDIA CORPORATION. All rights reserved.
2 
3 @page dwx_tools_section Tools
4 @tableofcontents
5 
6 The NVIDIA<sup>&reg;</sup> DriveWorks SDK includes tools that you can use in your development.
7 
8 These tools create output files that are placed into the current working directory by default. Please ensure the following for your convenience:
9 - Write permissions are enabled for the current working directory.
10 - Include the tools folder in the binary search path of the system.
11 - Execute from your home directory.
12 
13 Additionally, if you experience a permissions error when you enter the
14 command to run a tool, re-enter the command preceded with `sudo`.
15 
16 @section dwx_tools_sensors Sensor Tools
17 
18 The DriveWorks Sensor Tools visualizes and controls sensor configurations.
19 
20 | Tool | Description |
21 |------|-------------|
22 \if DAV
23 | @ref pfc | Performs sanity checks on connected sensors. |
24 \endif
25 \if DW
26 | @ref dwx_rig_viewer_tool | Displays connected sensor configuration. |
27 | @ref dwx_rig_json2json_tool | Re-serializes rig files with the latest version. |
28 | @ref dwx_sensor_indexer_tool | Creates seek tables for all supported sensors. |
29 | @ref sensor_distribution_tool | Dispatches camera frames from a specific camera group. |
30 | @ref dwx_sipl_query_tool | Displays SIPL sensor devices and configurations. |
31 | @ref dwx_sensor_initializer_tool | Initializes all sensors listed in a rig file. |
32 
33 @section dwx_tools_recording Recording Tools
34 
35 The DriveWorks Recording Tools records data from the sensors attached to NVIDIA DRIVEā„¢ platforms.
36 
37 | Tool | Description |
38 |------|-------------|
39 | @ref dwx_recording_tools | Records sensor data. |
40 
41 @section dwx_tools_postrecording Post-Recording Tools
42 
43 The DriveWorks Post-Recording Tools post-processes and checks data captured from the @ref dwx_tools_recording.
44 
45 | Tool | Description |
46 |------|-------------|
47 | @ref dwx_postrecord_checker | Verifies data integrity for each recording session. |
48 | @ref dwx_recording_chopping_tool | Removes information from input recordings, based on a given timestamp or event range. |
49 | @ref dwx_replayer_tool | Replays sensor data and visualizes sensor configuration. |
50 | @ref dwx_video_exporter_tool | Exports RAW, LRAW, or H.264 recorded videos in a MP4 container. |
51 | @ref dwx_muxer_mp4_tool | Exports RAW or H.264 video streams in an MP4 container. |
52 | @ref dwx_headerdump_tool | Outputs recording header information. |
53 | @ref dwx_tools_lraw2raw | Converts an LRAW input file into a RAW output file. |
54 | @ref dwx_tools_extractlraw | Extracts encoded H.264 LRAW preview data to an output file. |
55 | @ref virtual_can_file_updater | Updates CAN based recordings to larger data packets. |
56 
57 @section dwx_tools_calibration Calibration Tools
58 
59 The DriveWorks Calibration Tools perform static sensor calibration.
60 
61 | Tool | Description |
62 |------|-------------|
63 | @ref dwx_camera_calibration_tools | Static camera calibration utilties. |
64 | @ref dwx_imu_calibration_tool | Static IMU calibration. |
65 
66 @section dwx_tensorRT_optimization DNN Optimization Tools
67 
68 The DriveWorks DNN Optimization Tools optimizes various models utilizing TensorRT.
69 
70 | Tool | Description |
71 |------|-------------|
72 | @ref dwx_tensorRT_tool | Optimizes Caffe, UFF, or ONNX models using TensorRT. |
73 
74 \endif
75 \if DAV
76 @section dwx_tools_datamapping Mapping Tools
77 
78 The DriveWorks Mapping Tools facilitates the conversion between different map file formats. For additional information, please refer to @ref maps_mainsection.
79 
80 | Tool | Description |
81 |-------|-------------|
82 | @ref dwx_maptool_dw_maps_to_kml | Converts a NVIDIA<sup>&reg;</sup> DriveWorks map file to a KML file.|
83 | @ref dwx_maptool_here_to_dw_maps | Downloads and converts HERE map data to a DriveWorks map file. |
84 | @ref dwx_maptool_tomtom_to_dw_maps | Downloads and converts TomTom map data to a DriveWorks map file. |
85 | @ref dwx_maptool_inspection | Allows to inspect DriveWorks map data. |
86 
87 @section dwx_tools_mapstream MapStream Cloud Tools
88 
89 The DriveWorks MapStream Cloud Tools downloads and uploads MapStream data with NVIDIA's DRIVE Mapping Cloud.
90 
91 | Tools | Description |
92 |-------|-------------|
93 | @ref dwx_tool_mapperception_download_client | Downloads MapStream data and Maps from NVIDIA's DRIVE Mapping Cloud. |
94 | @ref dwx_tool_mapperception_upload_client | Uploads MapStream data to NVIDIA's DRIVE Mapping Cloud. |
95 
96 \endif
97 \if DW
98 @section dwx_tools_general General Tools
99 
100 These are general tools for Driveworks which may be useful to you.
101 
102 | Tools | Description |
103 |-------|-------------|
104 | @ref dwx_info_tool | Prints out general Driveworks information, such as version, in a parseable JSON format. |
105 
106 @page dwx_camera_calibration_tools Camera Calibration Tools
107 
108 The DriveWorks Calibration Tools facilitate system calibration. For step-by-step instructions on using the following tools, please refer to the @ref dwx_camera_calibration tutorial.
109 
110 | Tool | Description |
111 |------|-------------|
112 | @ref dwx_calibration_graph_cli | Creates a calibrated graph file. |
113 | @ref dwx_calibration_graph_to_rig | Creates a rig file from a calibrated graph. |
114 | @ref dwx_calibration_recorder | Extracts images and intrinsics constraints for calibration from live camera streams or videos.
115 | @ref dwx_intrinsics_constraints | Extracts intrinsics constraints for calibration from videos and image sets. |
116 | @ref dwx_calibration_int_val | Validates the intrinsic parameters for a calibrated camera. |
117 | @ref dwx_calibration_camera_mask | Creates a camera mask from calibration data. |
118 
119 \endif