Skip to main content
Version: 2.2.0

Configuration

You can configure OMNI Agent through the web interface or manually by editing files from the workspace folder, which stores configuration and activation files, a local database, and other files necessary for Agent operation.

To access OMNI Agent settings via the web interface, click the Settings icon in the upper right corner of OMNI agent web interface.

The workspace folder is by default located 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. After adding or changing values in the configuration files, you must restart OMNI Agent.

Enable/Disable Main Modules

You can configure all parameters specified below by editing 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).

img.png

Enable/Disable 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 run_params.json set the value for anonymous_mode:(Boolean) as true (module enabled) or false (module disabled).

Proxy Server Connection

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.

img.png

Change the Standard Port of Web Configurator

You can configure all parameters specified in this section by editing 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.

Change the Thresholds for Face and Body Matchers

You can configure all parameters specified in this section by editing 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:

  • 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.

You can also set faR and frR values in the Advanced settings of OMNI Agent web interface.

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.

View Logs/Change Logging Level

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).

Transfer Data via Webhooks

To set up data transfer via webhooks, go to the run_params.json configuration file and specify values for the webhook_tracking_subscribers parameter. This parameter represents a list of objects to determine the address of the server that receives data from OMNI agent and is available in two versions:

Version 1

{
"url": "http://127.0.0.1:5000/trigger" // address with the endpoint
}

Version 2 (default)

{ 
"host": "127.0.0.1", // address
"port": "5000", // port
"is_secured": false, // http/https flag
"path": "/trigger" // endpoint
}

You can also add a webhook in the Advanced settings of OMNI Agent web interface.

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 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.