Face Recognition: Analytics

This page comprises the Analytics item overview and options to customize analytics. The item displays a list of analytics including status and the ability to manage analytics.

Overview

To open the Analytics item, in the left menu:

  1. Select the Face Recognition section
  2. Choose the Analytics item
  3. See analytics

Use and Functionality

The Face Recognition Analytics functional menu allows to:

  • Fill in the Camera field with:
    • Camera name or characters in the name
    • Analytics ID
    • Video stream ID
  • Select the required analytics status
  • Click the Reset button to clear the filters
The status options comprise All, Active, and Stopped.

See the list of analytics in the table below. It contains:

  • Analytics and folders ID
  • Camera comprises:
    • Folders' and separate video streams' names
    • Copy Name icon to copy the video stream name
    • Video source type
    • Additional hardware parameters
  • Video stream or video file playback status. For the Active and Offline statuses the system also displays:
    • Countdown since analytics launch
    • Last server connection to analytics (seconds ago)
  • Toolbox comprises:
    • Start/Stop
    • Edit
    • Search Results
    • View
    • Delete
  • To learn more about grouping video streams into folders and making the appropriate changes in the Video Streams item, read Video Streams.
  • To find out the ID of CPU/GPU and the server running the video stream, hover the mouse over the circle next to the status of the running analytics.

Create Analytics

To create new analytics, click the Create Analytics button:

The Create Face Recognition Analytics navigation menu allows to:

  • Click the Back to All Analytics button to return to the main Analytics item
  • See the title and serial number of the current tab
  • Click the Back or Next button to move among tabs:
    • General
    • Hardware
    • Notifications
    • Permissions

General Tab

The General tab provides the ability to set a video stream and customize analytics parameters.

To set a video stream:

  1. Click the Video field
  2. See the Set Video Stream pop-up window
  3. Fill in the Search field with:
    • Camera name or characters in the name
    • Video stream ID
  4. Select the required camera from the filtered list
  5. Click the Set Video Stream button to confirm the intention
To refresh the video preview, upon selecting the Set Video Stream button, click the Update Video Frame button above the frame. This button is available upon adding the video stream.

Recognition Options

To perform the recognition, apply these recognition options:

  1. Set the parameters:
    • Move the slider to the left (to decrease) or to the right (to increase) the detector accuracy
    • Set the minimum and maximum face height in pixels for detection
    • Set the delay time in seconds before recognizing the same face again in the Camera Buffer, sec parameter
    • Set the number of frames for the sample from which the best frame is selected for face detection in the Frames to Detect parameter
    • Click the toggles to enable/disable:
      • Medical mask detection
      • Age and gender detection
      • Blur face in preview mode for blurring the face area in the analytics live view mode
      • Liveness recognition
  2. Modify the detection zone:
    • Click and drag the handles with LMB to set the zone borders
    • Click and drag the area inside the zone with LMB to move the whole zone
    • Click the handle with RMB to delete it
    • Click the Reset Zone button to return the detection zone borders to their original position
  • Increasing the Detector Accuracy parameter results in more accurate recognition, fewer objects are recognized by the analytics, but some objects may be skipped. While decreasing the parameter, the recognition accuracy decreases and the analytics recognizes more objects, but false recognitions are possible.
  • The minimum value for the Min Face Height, px parameter is 20 pixels.
  • The maximum value for the Max Face Height, px parameter is limited only by the height of the frame. Set the value to 0 to remove the limit on the maximum height of the face in pixels.
  • The possible range for the Camera Buffer, sec parameter is from 1 to 600 sec. The optimal value depends on the average duration of the expected face presence in the zone. The parameter serves as a trigger for re-detection, initiating the process of re-detecting and recognizing faces after the specified time interval. A value of 0 disables this process.
  • The possible range for the Frames to Detect parameter is from 5 to 100 frames. The lower the value is set, the faster the sample is processing, but the quality of detection is lesser as well. The higher the value is set, the more accurate the face detection is, but it takes more hardware resources and time to choose the best frame for detection.
  • The Liveness parameter is responsible for checking the image of a person's face for artificiality like mannequins, dolls, and masks.
  • The detection zone is based on at least 3 handles.

Hardware Tab

The Hardware tab provides the ability to customize hardware parameters:

  • Choose the CPU or GPU hardware acceleration
  • Select the hardware decoder from the drop-down list:
    • CPU
    • Intel
    • NVDEC
  • Select the frame processing mode:
    • FPS to set the desired number of frames per second
    • Key Frame to set the frame processing only by keyframes
    • Once Every X Seconds to set intervals in seconds between frame processing
  • The recommended value for the FPS mode is 25.
  • The default parameters allow the production of analytics. To customize the analytics, set parameters as required.
  • To learn more about hardware settings, read How to Сonfigure the Hardware Tab Settings.

Notifications Tab

The Notifications tab allows managing the events notifications. Check the Send Events to Event Manager box to allow the system to send all notifications to the Event Manager and then to external resources:

The default parameters allow the production of analytics. To customize the analytics, set parameters as required.

Permissions Tab

The Permissions tab provides the ability to:

5 permis.jpg

  • Assign analytics access rights for Roles:
    1. Select the required role from the drop-down list
    2. Click the Add Role button
    3. Select the checkboxes for the required access rights
    4. Click the Delete icon to remove the unnecessary role
  • Assign analytics access rights for Users:
    1. Select the required user from the drop-down list
    2. Click the Add User button
    3. Select the checkboxes for the required access rights
    4. Click the Delete icon to remove the unnecessary user
  • Select the checkboxes for the required analytics access rights by default
  • Select the Save button to confirm the intention in the navigation menu
  • The default parameters are active only if no Roles or Users are added.
  • The quantity of added Roles and Users is not limited.

Once saved, the Face Recognition Analytics editor opens to allow the users to:

  • Modify parameters
  • Set parameters
  • Run the created analytics
  • Proceed to live view mode

Edit Analytics

To edit settings in the selected analytics, click the Edit icon on the toolbox:

The Edit Face Recognition Analytics navigation menu allows to:

  • Click the Back to All Analytics button to return to the main Analytics item
  • See the setting tabs and move among them by clicking their titles:
    • General
    • Hardware
    • Notifications
    • Advanced Settings
    • Permissions
  • Select the Stop button to disable the analytics:
    • Yes to confirm the analytics disabling
    • No to cancel the intention or close the pop-up window
  • Select the Start button to enable the analytics
  • Click the Live View button to see the selected analytics process in real-time
  • Select the Save button to apply the changes to the selected analytics
  • The current tab is always highlighted.
  • Analytics editing is available only when selected analytics is disabled.
  • The Stop button is available only when the current analytics is active.
  • The Start button is available only when the current analytics is stopped.
  • The Live View button is available only when the current analytics is active.

To view editing parameters for the General, Hardware, Notifications, and Permissions tabs, except for Video Stream editing, read Create Analytics.

Advanced Settings Tab

The Advanced Settings tab allows the users to select a server from the drop-down list to run the analytics:

Analytics Status

To enable or disable the analytics and view the change of the analytics status:

  1. Select the Start button to enable the analytics
  2. Click the Stop button to disable the analytics process
  3. Confirm the intention

To enable or disable multiple analytics at once, click the Select Analytics button:

The Select Analytics functional menu allows to:

  1. Check the boxes next to the required folders or separate analytics to select them
  2. Click the Start Analytics button and confirm the intention in the pop-up window to enable all selected analytics
  3. Click the Stop Analytics button and confirm the intention in the pop-up window to disable all selected analytics
  4. Click the Cancel button to quit the analytics selection

View Analytics

To see the selected analytics in real-time, click the View icon on the toolbox:

The View icon becomes available only when selected analytics is active. 

Live view analytics mode allows to:

  1. View the video from the camera in real-time mode. At the bottom of the block:
    • Hover the mouse over the Settings icon to:
      • Select the desired video format
      • Click the Update Video Stream button to manually update the video
    • Click the Enlargement icon to expand the video to full-screen
  2. View recognized faces from lists:
    • Click the required frame to open the extended face recognition information. In the pop-up window:
      • See the person's data
      • Use frame view tools:
        • Zoom Out icon (-) to zoom out from a specific area of the frame
        • Zoom In icon (+) to zoom in on a specific area of the frame
        • Reset View icon (~) to reset the frame to its original size and position
        • Target icon to zoom in on the detected object in the frame
        • Enlargement icon to open the frame in full-screen (in the full-screen press the Esc button to return to default view)
        • Hover the mouse over the Extra Options icon to:
          • Select the Save Image option to download the event frame in full-size
          • Select the Export Event option to download the PDF report of the event
    • Click the required person's name to open the ID Card
    • Click the required list name to open the list
  3. View all faces detected by the analytics and click the required frame to open the extended face recognition information
  4. Click the Edit Analytics button to make changes to the current analytics settings
  5. Click the View All Analytics Events button to see all events from the selected analytics
  • The ID Card and list names are also displayed in the video next to the person with the ID Card in the list.
  • Click and drag the image across the zoomed-in frame to view different parts of it.
  • The Event Information pop-up window for faces without lists contains the additional option to add a person to the list by clicking the Create ID Card in List button.

View Search Results

To view selected analytics search results in the Analytics item, click the Search Results icon on the toolbox:

Delete Analytics

To delete the analytics:

  1. Select the Delete icon on the toolbox
  2. Confirm the intention