Skip to content

93. Ingestion run

The ingestion run processes the object list and extracts the necessary information for performing scenario matching efficiently. It receives the object list and the map as inputs, with optional configuration files, and produces a directory with the results.

93.1 Making an ingestion run

Invoke an ingestion run by running the $FTX/logiq/bin/logiq_ingest script using the parameters described below.

93.1.1 Ingestion run parameters

Mandatory flags

--osc_file <ingestion configuration OSC2 file>
Ingestion OSC2 configuration file.

If the OSC2 configuration file sets the map and the object list paths, the --map and --object_list flags are not required.

--map <map>
Map that uses a map format supported by Foretify.
--object_list <object list>
The object list file used during ingestion in the Foretellix-defined object list data structure.

Optional flags

--work_dir <path>
Directory under which the ingestion results directory is created. If left unspecified the directory will be created under $HOME/foretify/runs
--output_prefix <string>
Prefix added to ingestion results directory name.
--data_dir <path>
Directory where input data is found, prepended to path of map and object list.
--roi <path>
Path to a region-of-interest JSON file. This file carves out a region of a larger map (provided using the --map flag) to speed up loading and processing.
--video_file <path>
Path to a video file. This file should be the video recording of the given object list. The path should be accessible by the GUI server. The video will be played in the GUI server from the start time value within the object_list.
--connection_string <simulation connection string>
Sets the config.sim.connection_string field to the provided net address. Used when connecting to an external simulator requires this setting.
--msp_connection_string <map server connection string
Sets the config.map.msp_connection_string field. Used when connecting to a map server.

93.1.2 Customize the denoiser feature

Use the [Denoiser feature][denoiser-feature] and configure the components in the Denoiser configuration YAML file.

93.1.3 Ingestion OSC2 configuration file

A standard ingestion configuration file is included automatically. The configuration file is located at $FTX/logiq/customers/common/osc/ingestion_run.osc.

Some projects may need further configuration. The R&D team provides customized configuration files for such cases.

A customized ingestion file example is listed below: 

# Copyright (c) 2025 Foretellix Ltd. All Rights Reserved.

import "$FTX/env/basic/msp/open_drive.osc"    # Support XODR maps
import " $FTX/logiq/customers/common/osc/ingestion_run.osc" # Import the basic ingestion_run.osc

extend test_config:
    set map = "map.xodr"                # set the map, no need to use --map
    set object_list = "object_list.pb"  # set the object list path, no need to use --object_list

# Further customizations can be added here

93.2 Ingestion output

The ingestion run creates a directory with the run results. The results directory is created under $WORK_DIR/runs. By default, WORK_DIR is set to $HOME/foretify.

By default, the results directory name consists of the date, time and a four-character hash string. A prefix can be added by using the --output_prefix <prefix> flag.

Use Foretify Manager to view the ingestion results. In order to use Foretify Manager, the run results directory must be uploaded to the Foretify Manager server.

See how to view run results in Foretify Manager.