1

Introduction

Reports are a graphical representation of the video analytics metadata collected from your locations running Camlytics Service software.

This is a very powerful analytics tool that allows you to research the trends of your business locations and channels in one place. Moreover, you can see shots from any of the cameras connected to the cloud in real-time.

For example, you can, without leaving your home or office, analyze event statistics from all stores of your chain which may be located in different cities and even countries.

There are many types of reports which will help you visualize the collected statistics in any flexible and custom way.

By default, the statistics data is stored in the cloud service for 3 months. However, if you need to see the data collected over a longer period of time, you can always increase the storage time of your data by adding extra storage units. Each storage period extends the data storage time by 3 months, i.e. to keep your data in the cloud for a year, you just need to add 3 extra storage units.

Described below is the difference between various types of reports and how they can be applied.


2

Single period

Single period report means that all data compared in the report is taken for one period of time, i.e. for example, you can compare the number of people entering and leaving today within one chart or compare the number of people who entered from different entrances over the past week in one chart. If you need to compare the same data over this week and the past week in the same chart, you would need to go with a multi-period instead.

Below are the available types of reports for a single period.

Real-time number:

Quantitative chart:

Distribution chart:

Heatmap:


3

Multi period

Multi-period means that it is possible to compare data from different time periods in one chart. Therefore, you can compare the number of people coming in today with the number of people coming in yesterday (or any other day), all in one chart.

Available types of reports:


4

Real-time number

Current crossings

This type of report can be used only if the channel calibration includes the Line event triggers.

This is a very simple and demonstrative view of the report. It shows how many times the selected line was crossed by an object during a certain period of time. The data in the report is updated in real-time (data update delay is around 1 minute).

This type of report can be used, for example, to display the number of people who came to a presentation. It would be convenient to display it on a large screen located in the presentation hall so that everyone could see this data in real-time.

In this report, you can choose the time period during which the objects crossing the selected line will be counted.

The image below shows the number of people who came in during the last hour. It is also possible to count all people coming in today or set the custom counting period.

Current crossings report fields

The description of the form fields is located here. Only Line event triggers are available for this kind of report.

Current occupancy

This report allows you to dynamically calculate the difference in intersections between different lines.

For example, you can see how many people are currently in your cafe or warehouse which has many entrances, exits, and cameras. The number of people is determined by calculating the difference in the intersections of all lines towards exit or entrance on all cameras.

To use this type of report, you must set up Line event triggers on all entrances and exits. You need to set the time at which there are definitely no objects in the location as Reset time since the object counter starts from that moment.

The frequency of the report numbers update is 3-5 seconds.

If you want to show the number of objects inside (for example, total 11 people inside property), select the display type Current occupancy.

If you want to show vacant places (for example, vacant parking spots in garage is 11 out of 20), select the display type Current vacancy and be sure to fill in the Max occupancy field.

If you want to track the history of your current occupancy (maximum, average or median values) during day, week, month, etc., you would need to add the Occupancy history report in addition to this one.

Current occupancy appearance

You can also set the occupancy report appearance dynamically depending on your business restrictions. For example, you can set that the report shows "You may enter" if the occupancy is up to 100 people and show "Do not enter" if the occupancy is above that number with different font and background colors. The appearance settings are available in the context menu of this report (see example below).

Below you can see the appearance settings to show "STOP" with red background if the occupancy is over 6 people and show "YOU MAY ENTER" otherwise.

Below you can see the data fields to fill for the new appearance setting. Message can be left blank.

Current occupancy report fields

The description of the form fields is located here. Only Line event triggers are available for this kind of report.

In general, the appearance settings are applicable to all real-time report types (Current occupancy, Current crossings or Current queue).

Current queue

This report allows you to dynamically show the number of objects inside a particular zone.

For example, you can see how many people are currently in your waiting area that is covered by one camera.

To use this type of report, you must set up your channel with at least one Zone event trigger.

The frequency of the report numbers update is 3-5 seconds.

If you want to track the history of your current queue (maximum, average or median values) during day, week, month, etc., you would need to add the Queue history report in addition to this one.

Real-time number alerts & webhooks

If you have a Current occupancy, Current crossings or Current queue report and you want to associate its data with some particular action, you may opt for Alerts.

To add alert for your real-time report, call the context menu of the report.

There are 2 types of alerts:

  • Email
  • Webhooks

Email allows you to receive email when the report value is exceeded. For example, you want to get an email when there are more than 100 people in your shop.

Webhooks allow you perform any custom action when the condition happens. For example, you can display an alert on your own website when there are more than 100 people in your shop. Or you want to show the realtime occupancy rate in your locations on your website. In the configuration below the occupancy data will be sent to a http address via POST query every minute.

Below you can see the new alert fields. Alert timeout field defines when the alert will be repeated if the condition is fulfilled.

If you want to receive constant notifications on the current occupancy number or current zone queue you would need to set the alert condition as 0 and alert timeout as 1 minute - and the webhook will be called every minute with fresh data.

In case you are interested in webhooks for each analytics event on your location/channels, you should refer to the API docs.


5

Quantitative chart

Events

This type of report is used to compare the quantities of different types of events.

Events reports are divided into Comparison and Sum.

For example, the Comparison graph will help you compare the number of people who enter a room with the number of people who leave a room after a given time interval.

The graph below shows that there are fewer people who enter through the first entrance than people who exit through it.

The Sum graph can, for example, be used to count people who have entered the room from several different entrances. Below you can see the total number of people who entered through multiple entrances.

Events report fields

To create the Events report, you need to fill in the following form (a description of its fields can be found here):

 

Activity

This type of report is used to assess how long in total objects (people, cars) were staying in the zone.

It can be used, for example, to see for how long your employees stayed in a workplace in total. Or how much time there were moving cars on a road.

Activity report fields

The form is filled in according to the description of fields. Only Zone event triggers are available for this report.

 

Occupancy history

This type of report is based on the Current occupancy report and represents the history of occupancy data from the real-time number.

It is very convenient for tracing your locations occupancy trends during day, week, month, etc. The calculated value can be maximum, median or average values of the real-time occupancy numbers.

Queue history

This type of report is based on the Current queue report and represents the history of queue data (number of objects inside a particular zone) from the real-time number.

It is very convenient for tracing your zone occupancy trends during day, week, month, etc. The calculated value can be maximum, median or average values of the real-time queue numbers.

Speed

This type of report is based on the article about vehicle speed detection. It evaluates all Line crossed events and combines them with detected Object id to estimate the object's speed.

The resulting chart can be built for one or multiple periods (for example, in case you want to compare the average speed during this week and during past week).

During the report creation you would need to choose the channel, two line triggers (see the aricle for instructions on how to set them up), value method (average or maximum) and distance between the lines. The distance is measured either in meters or in feet (depends on the portal settings). The resulting speed will be measured in km/h or in mp/h also depeding on the same settings. When you save the report you'll see "Report is getting ready" message. You should wait a minute or so while the data gets aggregated and then update the page and you'll see something like this:

speed detection report chart

If you want to access the report data directly you can open the context menu and click on Speed data table. In the speed table you will see all the entries with exact speed, object ID and time and ability to receive snapshot for each of the events. There are data filters and csv export available as well.

speed calculation camera report

When you calibrate Camlytics Light for this report keep in mind that the greater the distance between the lines, the better, but make sure that all cars are always detected prior to crossing any of the lines. It is also important to set lines a bit off the camera image edges to make sure all vehicles are detected prior to the lines crossing - the speed is only detected when both lines are triggered. See the example below (in this case the speed will be registered only for vehicles traveling north-east to south-west).

speed camera software

Important! Tripweres must be calibrated in the same direction (all directions, or both right, or both left) in order to register correct speed events.

Trajectory

This type of report allows you to track and compare the movement paths of objects.

For example, using this report, you can track the movement of vehicles at an intersection so that you can correctly set up a traffic light or set traffic priority signs.

In Camlytics Service app, set the triggers on each side of the intersection. For example, we have a t-junction, let's denote its sides with the letters A, B and C, as shown in the picture below.

preparing a trajectory report

Given the one-way traffic in the direction from A to C, we are interested in the ratio of the number of vehicles moving in 3 directions: A -> B, A -> C and B -> C.

On sides A and C, we create one trigger each, and on side B - 2, since there is two-way traffic and we need to track the movement of vehicles in both directions.

In the report, respectively, we also create 3 series: A -> B, A -> C, B -> C.

First series A -> B

first series for trajectory report

Second series A -> C

second series for trajectory report

Third series B -> C

third series for trajectory report

As a result, we obtain a chart with each of the trajectories activations.

trajectory report


6

Distribution chart

Density

If calibration in your channel includes Zones, then you may be interested to know the distribution of the number of objects (people, cars) in these zones. This report can be very useful if you want to observe and assess the congestion of the zones - analyze queues or other places with large quantities of people or vehicles.

The report below shows that for 0.25% of the time the hallway was empty, for 7.17% of the time the hallway had one person in it, 2 people for 43.27% of the time, 3 people for 41.51%, 4 for 7.73% and 5 people for 0.07% of the time.

The percentage of time is visible when you hover over the desired sector of the chart.

Density report fields

The form is filled in according to the description of fields. Only Zone event triggers are available for this report.

Dwell time

This report allows you to assess the distribution of the time that objects existed in a zone. For example, to see how quickly your line moves. Also, the chart displays data on the minimum, maximum, and average time spent by objects in a zone.

According to the chart below, most people yesterday did not stay in the hall for more than 30 seconds (around 8,000 people), a small number was in the zone from 30 to 60 seconds. It is also visible that the waiting time never exceeded 2 minutes.

You can group the data in this type of report by steps from 10 to 60 seconds. In the chart below, the grouping is set to 30 seconds.

Dwell time report fields

 

The form is filled in according to the description of the fields. Only Zone event triggers are available for this report.

Vehicles classification

This report allows you to assess the distribution of the vehicles types.

Vehicles classification report fields

 

The form is filled in according to the description of the fields.

Gender & age

This report allows you to assess the distribution of faces by gender and age.

Gender & age report fields

 

The form is filled in according to the description of the fields.


7

Heatmap

Motion

Heatmaps show "hot" and "cold" areas in a video scene that indicate places where objects concentrated for a long time, i.e. areas with high and low activity.

Heatmaps can be very useful for analyzing the concentration of various objects – people, vehicles, etc.

For example, on the trading floor of a store, you can track the areas of the highest buyer activity as well as the areas that people do not visit. This data can be very efficiently used to optimize the layout of the premises. In the image below, you can track the areas where cars tend to slow down more often.

Heatmaps are divided into two types:

  • Linear
  • Logarithmic

You can see the way the linear map differs from the logarithmic in the pictures below.

If it is important to see the zones with maximum activity and the lower activity zones are not that important, then you should choose a linear heatmap.

If your goal is to look at the zones where there was at least some activity, even though it is much lower than the maximum, then the logarithmic heatmap is more suitable for you, as the difference between the values on it is smoothed out with the decimal logarithm.

Heatmap grouping

It is possible to group heatmaps from various channels. What can it be used for?

For example, you have several cameras in the same room. If you create reports on a heatmap without grouping, then there may be a zone with high activity in the view of one of the cameras which is not visible from any other cameras. In such a case, the zone of maximum activity of the heatmap of this camera will be the same shade as the zone of maximum activity of heatmaps of other cameras, but the absolute values can differ a lot. This makes it very difficult to compare heatmaps on different channels.

To show the "real" situation, the reports for cameras located in the same room (or for cameras with intersecting visibility zones), need to be combined into one group. In this case, you will get a relevant view of the concentration of objects on all heatmaps of the group put together.

Motion report fields

Heatmap adding form:

Here, on top of the general fields, the group selection for your heatmap is added.

Hourly/Daily events

This report shows the distribution of events by day or by hour, depending on the type you have selected.

The report gives a great overview of your premise activity during the whole week or the whole month.

For example, on the map below, you can see at what time and what day of the week more cars enter the parking lot.

Daily/Hourly events report fields

Description of form fields here.

 


8

Add report

To add a new report, click the Add report button in the upper right corner of the screen. In the drop-down menu, choose whether there will be a report for one period of time or for several periods.

After choosing a reporting period, you get to the page for selecting a report type.

Here you need to choose the type of data visualization.

Below are the available types of reports.

Real-time number:

Quantitative chart:

Distribution chart:

Heatmap:

Events, Dwell time, Activity and Occupancy reports are divided into two display types:

  • Comparison - displayed as lines, one line for each of the series, represents the absolute quantities.
  • Sum - displayed as stacked bars, one bar for each of the series, represents the absolute quantities and the total sum of the series.

Common fields

The forms for adding various types of reports differ from each other, but they have many fields that are common to all.

Report name - this field contains the name of the new report. By this name, you can identify your report on a dashboard. We recommend using a clear and descriptive name that allows you to exactly identify which data is displayed under the report. For example, "Number of people entered today" or "Comparison of people entered this week".

Display type - in this field you must select the display type of the report. Events, Dwell time, Activity and Occupancy reports are divided into 2 types: comparison and sum; Motion heatmap is divided into linear and logarithmic.

Period - defines which period you want to display the data for. You can select a predefined period, such as today, yesterday, or last month, or you can specify any custom period by selecting the start and end dates of this period in the corresponding fields.

Time filter - by activating this field, you can filter events that happen at a specific time of day. For example, if you are only interested in the number of incoming people in the period from 8:00 AM to 11:00 AM, you must activate the time filter and specify the initial and final value of this interval in the corresponding fields.

Step - this field indicates the grouping period of the data in the report. This field changes depending on the reporting period. This improves the relevancy and visibility of the charts. If the reporting period is 1 or several days, it is better to choose the Hour step, if the period is one week or several weeks, the Day will be the best step, and so on. The step is adjusted automatically every time you change the reporting period.

Color - the series on the chart will be shown in the selected color.

Series name - enter the name by which you will distinguish your series in the legend of the chart. Make the name as descriptive as possible, for example, "People going down the escalator".

Location - choose the location that contains the channel that you are interested in.

Channel - select the channel that you want to display data from.

Event trigger - select the event trigger that generates visualized data. For example, Line for the counting results display.

Data type - choose the type of event that is going to build the series. For example, Line crossed, Camera obstructed, or Zone max. occupancy.

Classification - this field is used to filter the report data by the origin that generated that data. For example, if you want to display only counting for vehicles and skip pedestrians in your report, choose Vehicle. Note, that this field must be used only if you know exactly what you do (calibration wise) as it can alter the display results significantly. We recommend leaving it as a default.


9

Edit/Remove/Export/Clone report

To edit the report, click the report menu button in the form of three dots in the upper right corner. In the menu that opens, select the Edit item.

In the form that opens, make the necessary changes and save the report.

The editing form is no different from the report adding form.

Export report

You can export any report data into a .csv or .png file except for Current crossings and Current occupancy reports.

To export a report, click the report menu button in the form of three dots in the upper right corner. In the menu that opens, select the Export item.

The .csv file with data will be generated for all kinds of reports except the lifetime heatmap. In this case, the .png image will be generated.

Remove report

To remove a report, click the report menu button in the form of three dots in the upper right corner, and in the menu that opens, select Remove. In the window that appears, confirm the deletion of the report by clicking the OK button.

Clone report

Cloning allows you to duplicate all the report form fields to be able to add a replica if you add multiple similar reports.

Expand report

If your report contains statistics for a long period of time, then a large amount of data can be inconveniently squashed.

In this case, you can expand your report to the full width of the screen by clicking the Expand button in the upper right corner.

Similarly, you can shrink back the report to its original width.

Sorting reports

You can sort reports on the panel by dragging and dropping.

To drag a report, hover over the area with report title, left-click and hold the mouse button, then move the report to a new location.


10

Share/Embed report

If you want to display any report on your own website or solution you can insert it via embed code, just as you would do with a YouTube video! To do that, just choose the re item from the report context menu.

embed report

Width - adjust the max widget width.

Sharing link - comes in handy when you want to share your report with someone why doesn't have access to your cloud profile. Anyone with this URL will be able to see the report.

Embed code - text that you would insert into your webpage HTML code to display the report on that page. All embedded reports are updated dynamically without needing to refresh the page.

embed report widget chart


11

Report feeds

If you want to export your report data dynamically via JSON or CSV format, you can do it via Feeds option.

report feed

JSON feed - represents numeric values of the chart data. Updated every time the chart data is updated.

CSV feed - represents numeric values of the chart data. CSV file will downloaded on each query.

feed report widget chart


12

Email reports

If you want to receive daily/weekly/monthly/etc emails with the data from any of your counting reports, you can set it up via Feeds.

See this article for the information on how to set up periodic email reports, or check the video below.