Configuration

You can configure OMNI Agent through the web interface or manually by editing files from OMNIAgent folder available at the address:

• Linux: ~/.local/share/OMNIAgent
• Windows: %LocalAppData%/OMNI Agent

Configuration files for editing are located in the config folder. For your convenience, configuration files with default settings are available for review in the config.default folder. Note that any value changed in config files takes precedence over the default configuration.

The following basic settings can be modified through the web interface or by editing run_params.json and log_params.json configuration files.

info

After adding or changing values in the configuration files, restart OMNI Agent.

Basic Modules

You can configure all parameters specified below by editing config/run_params.json.

• To enable/disable the body detection module, set the value for pipelines.body_detector.enabled:(Boolean) as true (module enabled) or false (module disabled).

• To enable/disable the face detection module, set the value for pipelines.face.enabled:(Boolean) as true (module enabled) or false (module disabled). Note: Disabling this module also stops Agent synchronization with the local database.

• To enable/disable age and gender estimation, set the value for pipelines.age_gender.enabled:(Boolean) as true (module enabled) or false (module disabled).

• To enable/disable estimation of emotions, set the value for pipelines.emotions.enabled:(Boolean) as true (module enabled) or false (module disabled).

• To enable/disable the mask detector, set the value for pipelines.mask_attribute.enabled:(Boolean) as true (module enabled) or false (module disabled).

The modules listed above can also be enabled/disabled via OMNI Agent web interface. To do this, select Settings→Advanced settings at OMNI Agent web interface and activate the necessary options (Body tracking, face tracking, mask detection, age and gender estimation, emotion estimation).

Anonymous Mode

OMNI Agent has the anonymous mode enabled by default. In the anonymous mode, face images aren’t transferred to OMNI Platform that ensures personal data protection and excludes the possibility of person recognition outside the system. You can enable or disable the anonymous mode at OMNI Agent web interface or by editing **run_params.json**.

To enable/disable the anonymous mode through the web interface, click on Settings icon at OMNI Agent web page and select an appropriate option in the opened tab.

For configuration via config/run_params.json set the value for anonymous_mode:(Boolean) as true (module enabled) or false (module disabled).

Events

You can enable/disable event transmission through the agent's web interface or by editing the config/run_params.json file.

To enable/disable the events through the web interface, click on Advanced Settings icon at OMNI Agent web page and select an appropriate option in the opened tab (Activity events, identification events, non-identification events).

For configuration via config/run_params.json set the value for enable_activities, enable_identification and enable_non_identification as true (module enabled) or false (module disabled).

Proxy Server

If the user gets access to the Internet through a proxy server, this connection should also be enabled to install and configure OMNI Agent. To use a proxy server, click on Settings icon at OMNI Agent web interface and select a system or custom proxy server in the opened tab. When choosing a custom proxy server, enter its address in a special field. After changes are completed, click the Save button.

Port of Web Configurator

You can configure all parameters specified in this section by editing config/run_params.json.

By default, the web configurator runs on port 8080. To change the port, add the http_server_port: (int) field in the configuration file and specify the desired port for opening the web configurator.

Thresholds for Face and Body Matchers

You can configure all parameters specified in this section by editing config/run_params.json.

Matcher is 3DiVi Face SDK component that allows performing the following comparison operations with face biometric templates:

• Verification 1:1 - comparing of two biometric templates (faces) between each other, estimating of coincidence;
• Identification 1:N - comparing of one biometric template (face) with other templates (faces), searching and estimating of coincidence.

When comparing face templates, Matcher calculates the difference between biometric features of faces. The calculations result in a measure of correspondence between face images and the probability of belonging to one person.

Face matcher settings:

• Score: The probability of correct recognition. Score value is float in a range [0..1]. To use score, follow the steps below:

  • Stop OMNI Agent (close the terminal window with the agent)

  • Add an entry desired_score (float) to the configuration file. Recommended parameter value is 0.85.

  • Run OMNI Agent.

    When the score is specified, faR and frR are not taken into account in recognition.

• faR: False acceptance rate (FAR) shows the system resistance to false acceptance errors. Such an error occurs when the biometric system recognizes a new face as previously detected one. This rate is measured by the number of false-acceptance recognitions divided by the total number of recognition attempts. You can change the faR value at desired_far (float) parameter. By default, the faR value equals to 1e-5.

• frR: False rejection rate (FRR). When a system fails to recognize previously detected face, false rejection occurs. The rate shows the percentage of recognition attempts with false rejection result. You can change the frR value at desired_frr (float) parameter. By default, the frR value equals to 0.

tip

Make sure the score values specified for OMNI Agent and OMNI Platform match. Otherwise, some of the activities generated from the transferred agent processes will not be linked to the corresponding profile, which means that notifications for such activities won't be received.

For example:

• score specified for OMNI Agent = 0.7
• score specified for OMNI Platform = 0.85

In this case, activities generated from Agent processes with a score value in the range [0.7, 0.85) will not be attached to the corresponding profile, and notifications for them will also not appear.

To configure the score value for OMNI Platform, see section 2.1.3.2 in OMNI Platform Administrator Guide.

Body matcher settings:

To exclude low-confidence matches, you can change confidence thresholds for body detection and comparison.

• Body detection confidence threshold is given in detector_confidence (float) parameter and equals to 0.9 by default with a range of values from 0 to 1.

• Body comparison confidence threshold is given in cos_reident_confidence (float) parameter and equals to 0.6 by default with a range of values from -1 to 1.

Logging

You can view the logs in the logfile_*.log file in the log folder. To change the logging level, go to the log_params.json configuration file and set a value for the sev_level(string) parameter. Available logging levels: TRACE, DEBUG, INFO, WARNING, ERROR, FATAL (listed in ascending order of importance).

Multi Camera

Connecting the additional video stream (camera)

OMNI Agent supports connection to multiple video streams (cameras).

• To connect an additional video stream via the OMNI Agent web interface, click Add a camera on the cameras page and specify the IP/USB camera.
• To add an additional video stream to OMNI Agent by editing the configuration file, follow the steps below:
  • In the config/run_params.json configuration file, create a new camera object in the web_cams array. To do this, simply copy the already existing camera object from the web_cams array.
  • Specify the IP address or ID of the new connected camera in the stream parameter of the new camera object. For USB cameras, you additionally need to specify the frame size: width and height.
  • Run and activate the OMNI Agent.

As a result, the OMNI Agent will transfer data to OMNI Platform from two video streams (cameras).

To connect and operate additional video streams, you will need a machine with the following design characteristics:

• CPU: Number of cores = 1 core + 3 x number of video streams @3GHz with AVX support. When one of the modules (face/body) is disabled, 1 processor core is removed. In this case, the number of cores = 1 + 2 x number of video streams.
• RAM: 1GB + 1 GB x number of video streams. The amount of free RAM required is specified. If one of the modules (face/body) is disabled, the thread multiplier is expected to decrease by 25%. In this case, the amount of RAM = 1GB + 0.75GB x number of video streams.
• HDD: 3GB free space.

Traces

To analyze the processing results and identify arisen problems, it is possible to save a highly detailed processing log. We call this log a trace.

To enable/disable trace collection, open the log_params.json configuration file, find the traces object, set the values for enable (trace enabling, true/false) and trace_interval_in_msec (trace collection interval, integer).

When trace recording is enabled, OMNI Agent will write to the console a message like

"Starting to write the trace...", "Trace written: " <UUID>

After the last message, a new file is written with a name equal to the written UUID.

Received traces are saved in the subdirectory available at the address:

• Linux: ~/.local/share/OMNIAgent/Traces
• Windows: %LocalAppData%/OMNI Agent/Traces

The corresponding files conform to the BSON format when reading from the second byte.

Video Files

To run OMNI Agent for processing video files, follow the steps below:

1. Connect OMNI Agent to OMNI Platform (launch the Agent, enter the server URL, and the email and password of your OMNI Platform account).

2. At Add a Camera page enter 123 in the URL field of IP camera.

3. Close OMNI Agent by closing the terminal.

4. Open config/run_params.json configuration file:

• Windows: %LocalAppData%\OMNIAgent\config\run_params.json
• Linux: ~/.local/share/OMNIAgent/config/run_params.json

5. In the “web_cams” section, in the “stream” field, specify the path to the video file.

6. Add the fields below:

• "is_benchmark_camera": true
• "is_nonlocking_camera": true

7. Specify values for "title" and "real_name" fields (optional).

An example of the filled -in “web_cams” section for running OMNI Agent to process a video file:

"web_cams": [ { "color_camera": { "creationDate": "2023-06-22T15:15:07.262920+00:00", "height": 720, "id": "81e4b383-6449-4041-bb69-ba01210c884f", "lastModified": "2023-06-22T15:15:07.262911+00:00", "real_name": null, "stream": "C:\\Users\\Q\\Downloads\\vid.mp4", "title": "vid", "is_benchmark_camera": true, "is_nonlocking_camera": true, "type": "IP", "width": 1280 } } ]

8. Run OMNI Agent.

OMNI Agent will stop after video file processing is completed. Processing results in the format of processes and/or events will be transferred to OMNI Platform or third-party service via webhooks.

note

For stable operation of OMNI Agent, it is not recommended to process multiple video files at the same time.

GPU

Software requirements:

• Windows:

  • CUDA Toolkit 11.8
  • cuDNN v8.8.0 for CUDA 11.x

• Linux:

  • CUDA Toolkit 11.8
  • cuDNN v8.8.0 for CUDA 11.x

Hardware requirements:

• CUDA compatible GPU (NVIDIA GTX 1050 Ti or better up to and including RTX 4090 (Compute capability 3.5-9.0))

To run OMNI Agent on GPU, open the recognizer configuration file (for example, method12v1000_recognizer.xml) in the conf folder and change the value of the use_cuda field from 0 to 1.

Data Retransmission

When the connection is failed, the data sent by Agent is saved in a special storage. When the connection is restored, this data is resent to the server.

Open the configuration file TDV/tdv_connection_params.json and provide values for the following variables:

• resend_on_success_count: int - number of packets to resend. Default value is 15
• data_keeper_max_bytes: int64 - the maximum number of bytes in the storage. Default value is 68719476736 (1 << 36) (64GB)