Table of Contents   MOBOTIX Online Help

MxAnalytics

Notes: This feature is not available on all camera models.

MxAnalytics allows tracking objects that move about in the image and to collect statistical information about these objects. To do so, the camera records the distribution of the objects and can present the results as a heatmap. In addition, you can define counting corridors, which are counting the objects that are passing through. These data are recorded in a reserved partition on a storage device that is directly attached to the camera. Note that the storage device needs to be partitioned accordingly when formatting the device in the Storage on External File Server / Flash Device dialog (see also MxAnalytics Data Storage on this page).

In order to use MxAnalytics, you need to configure this feature in the General MxAnalytics Settings dialog. After that, you can view the results in the MxAnalytics Overview dialog and export the data in different formats.

Notes:

Application Scenarios

In order to get reliable results, you should make sure to avoid all external influences that may degrade the results of MxAnalytics. If this is not possible, the results may be inaccurate. The following influences are unfavorable and should be avoided:

MxAnalytics has been designed for cameras mounted to a ceiling. Depending on the lens used, the camera should be mounted no lower and no higher than shown in this table:

Lens Minimum Height Maximum Height
L12 (1.8 mm) 2.5 m 6 m
L23 (3.6 mm), L25 (4.0 mm) 6 m 10 m

Configuring MxAnalytics in the General MxAnalytics Settings dialog follows these steps:

To view the results of MxAnalytics, open the MxAnalytics Overview dialog:


The "General MxAnalytics Settings" Dialog

General Settings

You can arm MxAnalytics permanently or use signal inputs and time table profiles to control the arming status.

Example:
In order to activate MxAnalytics only during the operating hours of a store, you need to create a Time Table Profile that matches the opening hours. Next, set the arming of MxAnalytics to Enabled and select the time table profile with the opening hours you just defined.

Hint: Using a time table profile to control the arming status of MxAnalytics reduces the storage space required and thus enlarges the time span covered by the collected data. This also improves the significance of the results, since objects outside of the analysis window are ignored and do not appear in the heatmap. For more information on the storage space, see Storage Requirements below.

Detection Settings

This sections contains general settings for object recognition.

Detection Area

In order to limit the analysis of MxAnalytics to a specific area, you can define several windows or polygons in this field. The most convenient method to define such a window is to use a [Shift]-click, click to define a rectangle in the live image, then click on Add detection area (see also Graphically Entering Image Areas). Note that it is also possible to exclude specific areas from detection. The syntax for a definition line is as follows:

Rectangle syntax:
[!]image sensor, horizontal coordinate, vertical coordinate, width, height
(optional parameters have square brackets)

Example: 0,0,0,1280,960

Polygon syntax:
[!]image sensor, poly=<hor. coordinate>x<vert. coordinate>/<hor. coordinate>x<vert. coordinate>/<hor. coordinate>x<vert. coordinate>{/<hor. coordinate>x<vert. coordinate}

(optional parameters have square brackets, parameters that can be used as often as needed have curly brackets)

Example: 0,poly=0x0/0x1280/960x1280/960x0

In order to exclude a specific area from detection, enter a "!" in front of the definition line.

Notes:

Hint 1: Limiting the detection area increases performance and delivers better results. in addition, doing so reduces the storage space required and thus enlarges the time span covered by the collected data. For more information on the storage space, see Storage Requirements below.

Hint 2: Image areas with reflecting surfaces should be excluded from detection to prevent negative influences on the analysis results.

If you are activating the display of the detection area, the camera shows the detection areas (rectangles and polygons) as well as the bounding box (the polygon containing all detection areas in the camera image).

Mounting Height

Enter the height in centimeters from the floor to the mounting position of the camera. The camera uses this information to properly display the results in the heatmap. When analyzing moving persons, the heatmap will be shown near the persons' feet.

Note: Mounting the camera at heights of less than 2 m/6 ft will reduce the accuracy of the analysis results.

Tilt Angle

Sets the tilt angle for this camera. If mounted to the ceiling, select –90°, if mounted to the wall, select . The camera uses this information to properly display the results in the heatmap.

Minimum Object Size

This parameter allows setting a minimum object size in pixels (smaller objects are ignored). The most convenient method is to use a [Shift]-click, click to define a rectangle in the live image, then click on Set minimum size (see also Graphically Entering Image Areas).

Light and Shadow

The camera provides three pre-defined settings to adapt the camera to the illumination profile at the location. In addition, you can select a custom setting to manually adjust the light and shadow settings of the camera.

Available Settings:

Sensitivity

This parameter controls the sensitivity of the analysis. A higher value means that the software only recognizes objects that have a noticeable color difference to the background. A lower value means that the software also recognizes objects that are hard to recognize against the background.

Object Display Settings

The following settings for displaying objects in MxAnalytics are available:

Counting Corridor Settings

A counting corridor is used to count objects that are passing through the corridor. Note that software also recognizes the direction of movement of these objects. Each line in the definition field represents one counting corridor. The definition of a counting corridor consists of its start and end points and its width. The syntax of a counting corridor definition is as follows:

image sensor,start=<hor. coordinate>x<ver. coordinate>,end=<hor. coordinate>x<ver. coordinate>,width=<width>,id=<identification number>[,name=<string>][,north=<string>][,south=<string>]
(optional parameters have square brackets)

Notes:

Example: 0,start=800x440,end=800x520,width=360,id=1,name=Entrance 1st floor\, left,north=In,south=Out

Parameter Description
Image Sensor Selects the image sensor (camera image) to use for this counting corridor definition:
  • 0: Right camera image on dual cameras, default setting on mono cameras.
  • 1: Left camera image on dual cameras.
start Start coordinate of the counting corridor, defined by its horizontal and vertical coordinate.
end End coordinate of the counting corridor, defined by its horizontal and vertical coordinate.
width Width of the counting corridor.
id The identification number (ID) of the corridor shown in the image. You can thus visually identify the corridors.
name The name of the corridor (e.g. "South Entrance") that will be shown in the report later on.
(Optional parameter)
north The description of objects passing through the corridor in the direction of the arrow/north (e.g. "In") that will be shown in the report later on.
(Optional parameter)
south The description of objects passing through the corridor in the opposite direction of the arrow/south (e.g. "Out") that will be shown in the report later on.
(Optional parameter)

Graphically Entering Counting Corridors

In order to draw a counting corridor in the live image, keep [Ctrl+Shift] pressed and click in the live image. In order to define the direction and length of the counting corridor, hold down the [Ctrl] key and click again into the live image. The next click sets the width of the counting corridor. Then click on the button in the dialog to add the counting corridor definition to the corresponding definition field.

Counting Corridor Style

The software provides the following settings to show the corridors in the camera image:

Text Color

Allows setting a color for the counters and the corridor IDs.

Heatmap Settings

A heatmap shows the distribution of the objects, i.e., where objects are staying and how they move, as a colored heat image. The warmer the color, the more objects are staying at a specific location. When analyzing moving persons, the heatmap will be shown near the persons' feet.

Reference Image

If you want to always use the same image as a background for the heatmap, you can save a "reference image" in the camera. If no reference image has been saved or you deleted an existing reference image by clicking on Delete, the software uses the current live image of the camera as background.

Hint: You should save a reference image if no objects are visible in the live image. This avoids that objects are interfering with the display of the heatmap later on.

Live Image Display

Shows the current heatmap on the live image of the camera. This feature is mainly aimed at quickly checking the configuration.

Caution: You should only briefly show the heatmap in the camera's live image, since this feature generates high CPU loads and results in reduced live image rates of the camera. Before closing the dialog, you should make sure that you deactivate the Show Heatmap checkbox and that you save the changes permanently by clicking on Set/Close at the bottom of the dialog.

Note: While you are displaying the heatmap in the camera image, the heatmap will also show on the recorded image (except when using the Full Image recording mode).


The "MxAnalytics Overview" Dialog

Open the MxAnalytics Overview dialog to define the reports that are to be generated by the camera:

Status

This section of the dialog contains general information about the records that are available. The information covers the date/time of the first and last records as well as information on the storage space used and the total number of records. In addition, you can manually create a new record (Force new record) and reset MxAnalytics completely by deleting all records (Delete all records).

Notes:

Heatmap

Click on Show to get a heatmap based on the current data in a separate browser window. The heatmap contains the MxAnalytics results since the last reset of the data or since activating MxAnalytics (whichever is applicable).

Counting Corridors

This section contains a summary table of the defined counting corridors, their descriptions and the current counter values.

Hint: You can use other programs to get the current counting corridor configuration and the current counter values using the following link: http://192.168.72.10/control/stat_export?function=counter. The data are returned in JSON format.

Counting Corridor Report Profiles

This section contains a summary table of the defined counting corridor report profiles. If no report profiles have been defined yet, you can do so in the Counting Corridor Report Profiles dialog.

Hint: If you want the camera to automatically send a counting corridor report via e-mail, FTP or IP Notify, make sure that both status LEDs in the corresponding line (Profile and Time Task) are green. If this is not the case, create a new e-mail profile, FTP profile or IP Notify profile and then add a new time task for this profile.

Heatmap Report Profiles

This section contains a summary table of the defined heatmap report profiles. If no report profiles have been defined yet, you can do so in the Heatmap Report Profiles dialog.

Hint: If you want the camera to automatically send a heatmap report via e-mail, FTP or IP Notify, make sure that both status LEDs in the corresponding line (Profile and Time Task) are green. If this is not the case, create a new e-mail profile, FTP profile or IP Notify profile and then add a new time task for this profile.


The "Counting Corridor Report Profiles" Dialog

A counting corridor is used to count objects that are passing through the corridor. Note that software also recognizes the direction of movement of these objects.

Open this dialog to define different reports (weekly/monthly), which can be used in other dialogs. You can then send these reports via e-mail or request them using MxEasy, MxControlCenter or via the camera's remote control (control command, videomotionanalysis section).

Test Profile/Get Report

This section allows testing the profiles listed in this dialog. Select the desired profile and the week, then click on Get report. The camera shows the results in a new window (one table per counting corridor), which can be printed immediately. If you click on Download as CSV table, you can download the file and process the corresponding table in other programs (spreadsheet, databases, etc.).

Profiles & Options

The following parameters are displayed for each profile:

Parameter Description
Profile Name of the profile, as it is displayed in other selection boxes.
Counting Corridors Selects the counting corridors to include in the report.
Columns Defines the columns of the report table. Each column can show one day or a range of subsequent days to show totals (e.g. Mon – Fri and Sat – Sun).
Export Range Specifies the range to be included in the report (weekly or monthly report).
Week/Month Depending on the selection in the Export Range section, you chose to include the current or the last week, or the current or the last month, respectively, in the report.
Time Selects the time range per day that is to be included in the report.
Export Format If the report is sent via e-mail, you can chose to attach the file either as HTML or as CSV file.
Report Title Enter the title of the generated report. You can also use dynamic text containing Variables. Besides the system variables, you can use additional special variables that are exclusively available for counting corridor report profiles. For an example of how these options can be used, see the Example for Dynamic Text in Report Titles below.

Example for a Weekly Report

A weekly report shows a table in which one line contains the counter values for one hour.

Example: A weekly report with the columns Mon,Tue,Wed,Thu,Fri,Mon - Fri and a daily range of 08:00 - 20:00 results in the following table:

Counting Corridor Report ... - South Entrance
TimeMondayTuesdayWednesdayThursdayFridayMonday - Friday
InOutInOutInOutInOutInOutInOut
8:00 - 9:00000000450045
9:00 - 10:0000000051000510
10:00 - 11:0000000011300113
11:00 - 12:00000000000000
12:00 - 13:00000000000000
13:00 - 14:00000000000000
14:00 - 15:00000000000000
15:00 - 16:00000000000000
16:00 - 17:00000000000000
17:00 - 18:00000000000000
18:00 - 19:00000027000027
19:00 - 20:00000002000002
Total0000291028001237

Example for a Monthly Report

A monthly report shows a table in which one line contains the counter values for one calendar week.

Example: A monthly report with the columns Mon,Tue,Wed,Thu,Fri,Mon - Fri and a daily range of 08:00 - 20:00 results in the following table:

Counting Corridor Report ... - South Entrance
WeekMondayTuesdayWednesdayThursdayFridayMonday - Friday
InOutInOutInOutInOutInOutInOut
3178798979828182968072411407
3275698187828575806691379412
33797684958379102808175429405
3486899289748784859179427429
3581889377000000174165

Note: A hyphen in a cell means that there are no counter values available for this hour. This may be caused by an analysis that had been activated at the time or a time range in the past, for which the corresponding data record is not available any more.


Variable Description

Variable Description Note
REPORT: Current report
$(REPORT.TIME) Time span of the current report Weekly report WW/YYYY (YYYY-MM-DD – YYYY-MM-DD)
Monthly report: Month YYYY
CORRIDOR: Selected corridor
$(CRD.ID)
$(CORRIDOR.ID)
Displays the ID of the current counting corridor.  
$(CRD.NAME)
$(CORRIDOR.NAME)
Displays the name of the current counting corridor.  

Examples for Dynamic Text in Report Titles

Using variables and placeholders, the camera can dynamically integrate information into the report titles.

Scenario You want to show the camera name and the timestamp in the report title.
Definition of the title Counting Corridor Report – $(REPORT.TIME)$(CORRIDOR.NAME)$(id.nam)
Explanation
$(id.nam) Name of the camera
$(TMS) Current timestamp

The "Heatmap Report Profiles" Dialog

A heatmap shows the distribution of the objects, i.e., where objects are staying and how they move, as a colored heat image. The warmer the color, the more objects had been staying at a specific location. When visualizing the results, you can set a range of minimum and maximum values to include in the heatmap, and you can set the heatmap's transparency.

Open this dialog to define different reports, which can be used in other dialogs. You can then send these reports via e-mail or request them using MxEasy, MxControlCenter or via the camera's remote control (control command, videomotionanalysis section).

Custom Report

This section allows getting a heatmap that covers a given time range within the range of recorded data. Firs, select the desired time range for the heatmap. Click on Get report to show this heatmap in a separate browser window.

Hint: Click in a date field to show a calendar. The days with available data have a light green background and can be selected.

Test Profile/Get Report

This section allows testing the profiles listed in this dialog. To do so, select the desired profile and the day, then click on Get report. The distribution of objects is shown in a new window on a current live image of the camera or a reference image (if such an image has been saved; see reference image). You can print the heatmap from this window or save the heatmap as JPG file.

Profiles & Options

The following parameters are displayed for each profile:

Parameter Meaning
Profile Name of the profile, as it is displayed in other selection boxes.
Export Range Specifies the range to be included in the report (current or last day).
Time Selects the time range per day that is to be included in the report.
Legend Adds a legend to the image on the heatmap report, which includes the minimum and maximum values in O/h (Objects/hour).
Value Range Usually, you will display all values in the heatmap (minimum value = 0%, maximum value = 100%). By adjusting the minimum and maximum values, you can influence the displayed results as follows:
  • Minimum Value: If you enter a value greater than 0 in the left field, the areas with less traffic are not shown in the heatmap image.
  • Maximum Value: If you enter a value less than 100 in the right field, the areas with more traffic are highlighted even more in the heatmap image. This done by displaying all values equal or higher than the adjusted maximum value in the color of the maximum (red).
Transparency Controls the heatmap transparency. A higher value will show more of the image in the background.

Additional Information

MxAnalytics Data Storage

In order to to use the export features of MxAnalytics, the camera needs to store the analysis data on the integrated SD card of the camera. The data are stored on an MxAnalytics partition and are safely stored in case of a power failure. To format the SD card accordingly, open the Storage on External File Server / Flash Device dialog (Storage Target).

Configuring the Storage

Hint: You can leave this help page open during the entire process to properly follow the step-by-step instructions.

Storage Requirements

The results of MxAnalytics are stored every 15 minutes. When running the analysis 24/7, the resulting volume of data can reach up to 1 GB per month. If you want to analyze longer periods of time, you need to make sure that the MxAnalytics volume is large enough. Note that once the reserved storage capacity of the partition has been reached, the oldest records will be overwritten.

Hint: In order to maximize the storage space for MxAnalytics on the SD card, you can use most of the space for MxAnalytics storage when formatting. For event storage, you can use an external file server or a USB harddisk, for example.


Storing the Configuration

Click on the Set button to activate your settings and to save them until the next reboot of the camera.

Click on the Factory button to load the factory defaults for this dialog (this button may not be present in all dialogs).

Click on the Restore button to undo your most recent changes that have not been stored in the camera permanently.

Click on the Close button to close the dialog. While closing the dialog, the system checks the entire configuration for changes. If changes are detected, you will be asked if you would like to store the entire configuration permanently.


© 2001-2020 MOBOTIX AG, Germany · http://www.mobotix.com/