/dvs/git/dirty/gitlab-master_av/dw/sdk/tools/maps/maptool_here_to_dw_maps/README-maptool_here_to_dw_maps.md

Go to the documentation of this file.

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

@page dwx_maptool_here_to_dw_maps HERE Maps to DriveWorks Maps Converter Tool
@tableofcontents

@section dwx_map_here_description Description

The NVIDIA<sup>&reg;</sup> DriveWorks HERE Maps to DriveWorks Maps Converter tool downloads HERE Maps data<br>
from a server, and generates a DriveWorks Maps file. This file can be along a route defined <br> by a file type, or within a geometrical region.

For specific examples, please refer to the following:
- @ref dwx_map_here_examples_gps.
- @ref dwx_map_here_examples_kml.
- @ref dwx_map_here_examples_rect.
- @ref dwx_map_here_examples_radius.

@note SW Release Applicability: This tool is available in <b>NVIDIA DRIVE Software</b> releases.

@section dwx_map_here_prerequisites Prerequisites

This tool is available on the x86 Host System.

This tool creates output files that are placed into the current working directory by default. Please ensure the following for your convenience:
- Write permissions are enabled for the current working directory.
- Include the tools folder in the binary search path of the system.
- Execute from your home directory.

Ensure you have obtained the proper credentials to obtain proper credentials to access HERE HD Maps data.

@section dwx_map_here_usage Running the Tool

The HERE Maps to DriveWorks Maps Converter tool accepts the following parameters. Several of these parameters are required based on the route definition.<br>
For more information, please refer to the @ref dwx_map_here_examples.

Run the tool by executing:

    ./maptool_here_to_dw_maps --app_code=[app_code]
                              --app_id=[app_id]
                              --catalog=[catalog]
                              --output_file=dwMapCache.bin
                              --dw_gps_file=dwGPSfile.bin
                              --route_kml_file=route.kml
                              --minLon=[minimum longitude in degrees]
                              --maxLon=[maximum longitude in degrees]
                              --minLat=[minimum latitude in degrees]
                              --maxLat=[maximum latitude in degrees]
                              --lon=[longitude in degrees]
                              --lat=[latitude in degrees]
                              --download
                              [--hd_only]
                              [--here_cache_dir=[path to cache directory]]
                              [--no_roadboundaries]
                              [--use_colors]

@subsection dwx_map_here_usage_params Parameters

    --app_code=[HERE Maps app code]
            Description: The app code in order to access the HERE HD Maps service. 

    --app_id=[HERE Maps app ID]
            Description: The app ID in order to access the HERE HD Maps service.

    --catalog=[catalog]
            Description: Specifies the specific HERE maps catalog to download from. Note that most catalogs have a "na" (North America) or "weu" (Western Europe) tag specifying the region.
            Examples: --catalog=here-cit-hdmap-ext-na-1, --catalog=here-cit-hdmap-ext-weu-1, --catalog=here-hdlm-nds-na-3, --catalog=here-hdlm-nds-weu-3
            Default value: here-cit-hdmap-ext-na-1

    --output_file=[path to output file]
            Description: The output DriveWorks Maps file name in '.xml' or '.bin' format.
            Default value: dwMapCache.bin

    --dw_gps_file=[path to input file]
            Description: The input DriveWorks GPS file.

    --route_kml_file=[path to input file]
            Description: The input KML file extracted from Google Maps after specifying a route.

    --radius=[radius in meters for the radius query]
            Description: Radius in meters for the radius query.

    --minLon=[minimum longitude in degrees]
            Description: The minimum longitude of a map for a rectangular query.
            Default value: -37.270751

    --maxLon=[maximum longitude in degrees]
            Description: The maximum longitude of a map for a rectangular query.
            Default value: 37.470751

    --minLat=[minimum latitude in degrees]
            Description: The minimum latitude of a map for a rectangular query.
            Default value: -122.067341

    --maxLat=[maximum latitude in degrees]
            Description: The maximum latitude of a map for a rectangular query.
            Default value: -121.867341

    --lon=[longitude in degrees]
            Description: The longitudinal center of the map in degrees for a radius query.
            Example: --lon=122.25
            Default value: 121.967341

    --lat=[latitude in degrees]
            Description: The latitudinal center of the map in degrees for a radius query.
            Example: --lat=37.45
            Default value: 37.370751

    --download
            Description: If this parameter is provided, the tool downloads data from the server.

    --hd_only
            Description: If this parameter is provided, the tool only downloads HD quality map data.
                         Otherwise, it downloads both HD and SD quality map data.
                         This parameter is optional.

    --here_cache_dir=[path to cache directory]
            Description: The cache directory for the HERE Map data.
                         This parameter is optional.

    --no_roadboundaries
            Description: If this parameter is provided, the tool does not convert the outermost invisible lanes to road edges.
                         This parameter is optional.

    --use_colors
            Description: If this parameter is provided, the tool colors the boundaries.
                         Otherwise, the boundaries are colored white.
                         This parameter is optional.

@section dwx_map_here_examples Examples

@subsection dwx_map_here_examples_gps For Routes Defined by a DriveWorks GPS File

    ./maptool_here_to_dw_maps --app_code=[app_code]
                              --app_id=[app_id]
                              --catalog=[catalog]
                              --dw_gps_file=dwGPSfile.bin
                              --output_file=dwMapCache.bin
                              --download
                              --hd_only
                              --here_cache_dir=[path to cache directory]
                              --no_roadboundaries
                              --use_colors

@subsection dwx_map_here_examples_kml For Routes Defined by a KML File

    ./maptool_here_to_dw_maps --app_code=[app_code]
                              --app_id=[app_id]
                              --catalog=[catalog]
                              --route_kml_file=route.kml
                              --output_file=dwMapCache.bin
                              --download
                              --hd_only
                              --here_cache_dir=[path to cache directory]
                              --no_roadboundaries
                              --use_colors

For information on creating maps in KML format, see how @ref dwx_map_here_creating.

@subsection dwx_map_here_examples_rect For Regions Defined by a Rectangle

    ./maptool_here_to_dw_maps --app_code=[app_code]
                              --app_id=[app_id]
                              --catalog=[catalog]
                              --minLon=-122.3
                              --maxLon=-122.2
                              --minLat=37.4
                              --maxLat=37.5
                              --output_file=dwMapCache.bin
                              --download
                              --hd_only
                              --here_cache_dir=[path to cache directory]
                              --no_roadboundaries
                              --use_colors

@subsection dwx_map_here_examples_radius For Regions Defined by a Center and Radius

    ./maptool_here_to_dw_maps --app_code=[app_code]
                              --app_id=[app_id]
                              --catalog=[catalog]
                              --lon=-122.25
                              --lat=37.45
                              --radius=37.45
                              --output_file=dwMapCache.bin
                              --download
                              --hd_only
                              --here_cache_dir=[path to cache directory]
                              --no_roadboundaries
                              --use_colors

@section dwx_map_here_additional Additional Information

@subsection dwx_map_here_creating To Create a Route Map in KML Format

1. Navigate to https://www.google.com/mymaps/ in your browser.
2. Click the red **CREATE A NEW MAP** button, or open an existing map.
3. Click the **Add directions** button under the Search bar. A layer below your map called **Untitled layer** appears.
5. Create your route on the new **Untitled layer** by specifying a starting point **A** and destination **B**.
6. Click the **⋮** menu button to the right of your map title, and select **Export to KML/KMZ**.
7. Select your route layer from the drop-down menu, and check **Export as KML instead of KMZ. Does not support all icons**. Click **Download**.
8. Verify that your route map in KML format appears under `data/tools/maps/route.kml`.