Heat Map: 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 Heat Map section
  2. Choose the Analytics item
  3. See analytics

Use and Functionality

The Heat Map 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
    • 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 Heat Map 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
    • 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:
    • Set the required time frame
    • Check the FishEye box and set the parameters as required:
      • Ifov parameter to set the fisheye aperture in degrees
      • Ofov parameter to set the output frame aperture in degrees
  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
  • The possible range for the Ifov parameter is from 0 to 180 degrees. The default value is 180 degrees.
  • The possible range for the Ofov parameter is from 0 to 180 degrees. The default value is 120 degrees.
  • The detection zone is based on at least 3 handles.

Hardware Tab

The Hardware tab provides the ability to customize hardware parameters:

  • Analytics functions exclusively on CPU resources; the GPU option is unavailable for selection
  • Analytics exclusively utilizes CPU resources for decoding; alternative options are not selectable
  • 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.

Permissions Tab

The Permissions tab provides the ability to:

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

Select the Save button to confirm the intention in the navigation menu. Once saved, the Heat Map Analytics editor opens to allow the users to:

  • Modify parameters
  • Set parameters
  • Run the created analytics

Edit Analytics

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

The Edit Heat Map 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
    • Advanced Settings
    • Permissions
  • Select the Stop Analytics 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 Analytics button to enable the analytics
  • Select the Save button to apply the changes to the selected analytics
  • Current tab is always highlighted.
  • Analytics editing is available only when selected analytics is disabled.
  • Stop Analytics button is available only when the current analytics is active.
  • Start Analytics button is available only when the current analytics is stopped.

To view editing parameters for the General, Hardware, 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

Delete Analytics

To delete the analytics:

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