2 * Copyright (c) 2019-2020 NVIDIA CORPORATION. All rights reserved.
4 * NVIDIA Corporation and its licensors retain all intellectual property
5 * and proprietary rights in and to this software, related documentation
6 * and any modifications thereto. Any use, reproduction, disclosure or
7 * distribution of this software and related documentation without an express
8 * license agreement from NVIDIA Corporation is strictly prohibited.
11 @page dwx_calibration_graph_to_rig Calibrated Graph to Rig File Tool
14 @section dwx_calibration_graph_to_rig_description Description
16 The NVIDIA<sup>®</sup> DriveWorks Calibrated Graph to Rig File tool extracts the relevant parts from a JSON calibrated graph file as input, into a JSON rig file as output.<br>
17 This output file can be parsed by the @ref rig_mainsection module within DriveWorks.
19 @note SW Release Applicability: This tool is available in both <b>NVIDIA DriveWorks</b> and <b>NVIDIA DRIVE Software</b> releases.
21 @section dwx_calibration_graph_to_rig_prereqs Prerequisites
23 This tool is available on the x86 Host System and NVIDIA DRIVE<sup>™</sup> OS Linux.
25 This tool creates output files that are placed into the current working directory by default. Please ensure the following for your convenience:
26 - Write permissions are enabled for the current working directory.
27 - Include the tools folder in the binary search path of the system.
28 - Execute from your home directory.
30 @section dwx_calibration_graph_to_rig_usage Running the Tool
32 Run the tool by executing:
34 /calibration-graph-to-rig --graph=[path to input calibrated-graph.json file]
35 --rig=[path to input rig.json file]
36 --output=[path to output rig file]
38 @subsection dwx_calibration_graph_to_rig_parameters Parameters
40 --graph=[path to input calibrated-graph.json file]
41 Description: The input calibrated graph file.
42 If only this parameter is provided, a `rig.json` file is created from scratch.
44 --rig=[path to input rig.json file]
45 Description: The input rig file.
46 If this parameter and `--graph` are both provided, the calibration data from the `calibrated-graph.json` file
47 is merged with the input `rig.json` file.
49 --output=[path to output rig file]
50 Description: The output rig file. If this parameter is specified, the `calibrated-graph.json` and `rig.json` files
51 are saved to a separate file. The default setting overwrites the input `rig.json` file.
53 @section dwx_calibration_graph_to_rig_output Output
55 The tool generates a `rig.json` file in the current folder as output. This file lists all cameras used during calibration with their intrinsic \n and extrinsic calibration data. If an existing `rig.json` file is passed to the application as input, all camera entries are modified with the new calibration results.<br>
56 For additional information regarding the format for the produced JSON file, please refer to @ref rig_mainsection and @ref rigconfiguration_usecase0.
58 @section dwx_calibration_graph_to_rig_additional Additional Information
60 This tool uses the center of the rear axle projected to the ground as a coordinate system origin.<br>
61 For additional information regarding this coordinate system, please refer to @ref dwx_coordinate_systems.