Detailed Description
Defines the analytics configuration to use for a video input.
This include the detection settings such as object size, sensitivity and regions of the frame to apply the detection to.
Availability
Available in version 7.3.0 of Decoder SDK. Requires a server version greater than 7.0
#include <AnalyticsConfig.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int32_t | GetInput () const |
| Gets the input that this analytics configuration applies to. More... | |
| DB_EDGEVIS_SDK bool | SetInput (int32_t input) |
| Sets the input that this analytics configuration will apply to. More... | |
| DB_EDGEVIS_SDK bool | GetEnabled () const |
| Gets the enabled state of analytics on this input. More... | |
| DB_EDGEVIS_SDK void | SetEnabled (bool enable) |
| Sets the enabled state for analytics on this input. More... | |
| DB_EDGEVIS_SDK double | GetSensitivity () const |
| Gets the analytics detection sensitivity. More... | |
| DB_EDGEVIS_SDK void | SetSensitivity (double sensitivity) |
| Sets the analytics detection sensitivity. More... | |
| DB_EDGEVIS_SDK double | GetMinDetectionWidth () const |
| Gets the minimum object width to detect. More... | |
| DB_EDGEVIS_SDK void | SetMinDetectionWidth (double min_width) |
| Sets the minimum object width to detect. More... | |
| DB_EDGEVIS_SDK double | GetMinDetectionHeight () const |
| Gets the minimum object height to detect. More... | |
| DB_EDGEVIS_SDK void | SetMinDetectionHeight (double min_height) |
| Sets the minimum object height to detect. More... | |
| DB_EDGEVIS_SDK double | GetMaxDetectionWidth () const |
| Gets the maximum object width to detect. More... | |
| DB_EDGEVIS_SDK void | SetMaxDetectionWidth (double max_width) |
| Sets the maximum object width to detect. More... | |
| DB_EDGEVIS_SDK double | GetMaxDetectionHeight () const |
| Gets the maximum object height to detect. More... | |
| DB_EDGEVIS_SDK void | SetMaxDetectionHeight (double max_height) |
| Sets the maximum object height to detect. More... | |
| DB_EDGEVIS_SDK AnalyticsConfigMode | GetMode () const |
| Determine the analytics detection mode in use. More... | |
| DB_EDGEVIS_SDK void | SetMode (const AnalyticsConfigMode mode) |
| Set the analytics detection mode to use. More... | |
| DB_EDGEVIS_SDK bool | GetFilterHeadlights () const |
| Determine if headlight filtering is enabled for analytics on this input. More... | |
| DB_EDGEVIS_SDK void | SetFilterHeadlights (const bool enable) |
| Set the headlight filtering enabled state for analytics on this input. More... | |
| DB_EDGEVIS_SDK bool | GetFilterOOF () const |
| Determine if out-of-focus (OOF) filtering is enabled for analytics on this input. More... | |
| DB_EDGEVIS_SDK void | SetFilterOOF (const bool enable) |
| Determine if out-of-focus (OOF) filtering is enabled for analytics on this input. More... | |
| DB_EDGEVIS_SDK int32_t | GetOOFFilterValue () const |
| Determine the current level of the out-of-focus (OOF) filtering. More... | |
| DB_EDGEVIS_SDK void | SetOOFFilterValue (const int32_t value) |
| Set the level of the out-of-focus (OOF) filtering. More... | |
| DB_EDGEVIS_SDK bool | GetDetectStationary () const |
| Determine if stationary object (eg. More... | |
| DB_EDGEVIS_SDK void | SetDetectStationary (const bool stationary) |
| Determine if stationary object (eg. More... | |
| DB_EDGEVIS_SDK int32_t | GetMinPresence () const |
| Determine the minimum time in secocds that an object must be detected before triggering an alarm. More... | |
| DB_EDGEVIS_SDK void | SetMinPresence (const int32_t presence) |
| Set the minimum time in secocds that an object must be detected before triggering an alarm. More... | |
| DB_EDGEVIS_SDK std::vector< AnalyticsRegion > | GetRegions () const |
| Get the detection regions defined for this input. More... | |
| DB_EDGEVIS_SDK bool | SetRegions (std::vector< AnalyticsRegion > regions) |
| Set the detection regions defined for this input. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::AnalyticsConfig::GetInput | ( | ) | const |
Gets the input that this analytics configuration applies to.
- Returns
- The zero-based input index that this analytics config is associated with.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsConfig::SetInput | ( | int32_t | input | ) |
Sets the input that this analytics configuration will apply to.
- Parameters
-
id The zero-based input index that this analytics config shall be associated with.
- Returns
- True if the input was accepted, false if the input was rejected.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsConfig::GetEnabled | ( | ) | const |
Gets the enabled state of analytics on this input.
- Returns
- The enable state of analytics on this input.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetEnabled | ( | bool | enable | ) |
Sets the enabled state for analytics on this input.
- Parameters
-
enable True to enable analytics for this input, false to disable analytics for this input.
| DB_EDGEVIS_SDK double EdgeVisDecoderSDK::AnalyticsConfig::GetSensitivity | ( | ) | const |
Gets the analytics detection sensitivity.
- Returns
- The analytics sensitivity value between 0 (least sensitive) and 1 (most sensitive).
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetSensitivity | ( | double | sensitivity | ) |
Sets the analytics detection sensitivity.
- Parameters
-
sensitivity The analytics sensitivity value to use. Values will be clamped to between a min and max value.
| DB_EDGEVIS_SDK double EdgeVisDecoderSDK::AnalyticsConfig::GetMinDetectionWidth | ( | ) | const |
Gets the minimum object width to detect.
- Returns
- The minimum object width as a proportion of the frame width.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetMinDetectionWidth | ( | double | min_width | ) |
Sets the minimum object width to detect.
The minimum object width as a proportion of the frame width. The value must be 0.015 or greater. Values less than this will be clamped.
| DB_EDGEVIS_SDK double EdgeVisDecoderSDK::AnalyticsConfig::GetMinDetectionHeight | ( | ) | const |
Gets the minimum object height to detect.
- Returns
- The minimum object height as a proportion of the frame height.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetMinDetectionHeight | ( | double | min_height | ) |
Sets the minimum object height to detect.
The minimum object height as a proportion of the frame height. The value must be 0.100 or greater. Values less than this will be clamped.
| DB_EDGEVIS_SDK double EdgeVisDecoderSDK::AnalyticsConfig::GetMaxDetectionWidth | ( | ) | const |
Gets the maximum object width to detect.
- Returns
- The maximum object width as a proportion of the frame width.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetMaxDetectionWidth | ( | double | max_width | ) |
Sets the maximum object width to detect.
The maximum object width as a proportion of the frame width. The value must be 0.750 or less. Values more than this will be clamped.
| DB_EDGEVIS_SDK double EdgeVisDecoderSDK::AnalyticsConfig::GetMaxDetectionHeight | ( | ) | const |
Gets the maximum object height to detect.
- Returns
- The maximum object height as a proportion of the frame width.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetMaxDetectionHeight | ( | double | max_height | ) |
Sets the maximum object height to detect.
The maximum object height as a proportion of the frame height. The value must be 0.750 or less. Values more than this will be clamped.
| DB_EDGEVIS_SDK AnalyticsConfigMode EdgeVisDecoderSDK::AnalyticsConfig::GetMode | ( | ) | const |
Determine the analytics detection mode in use.
- Returns
- The analytics detection mode which may be sterile zone or public safety.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetMode | ( | const AnalyticsConfigMode | mode | ) |
Set the analytics detection mode to use.
- Parameters
-
mode The analytics detection mode to use. This may be sterile zone or public safety.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsConfig::GetFilterHeadlights | ( | ) | const |
Determine if headlight filtering is enabled for analytics on this input.
- Returns
- The headlight filter state of analytics on this input.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetFilterHeadlights | ( | const bool | enable | ) |
Set the headlight filtering enabled state for analytics on this input.
- Parameters
-
enable The headlight filter state to set.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsConfig::GetFilterOOF | ( | ) | const |
Determine if out-of-focus (OOF) filtering is enabled for analytics on this input.
This is useful for insects or water droplets on camera lenses.
- Returns
- The out-of-focus (OOF) filter state of analytics on this input.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetFilterOOF | ( | const bool | enable | ) |
Determine if out-of-focus (OOF) filtering is enabled for analytics on this input.
This is useful for insects or water droplets on camera lenses.
- Parameters
-
enable The out-of-focus (OOF) filter state to set.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::AnalyticsConfig::GetOOFFilterValue | ( | ) | const |
Determine the current level of the out-of-focus (OOF) filtering.
The valid range is 0-6. The default value is 3.
- Returns
- The out-of-focus (OOF) filter level.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetOOFFilterValue | ( | const int32_t | value | ) |
Set the level of the out-of-focus (OOF) filtering.
The valid range is 0-6. The default value is 3. Values outwith the valid range will be clamped.
- Parameters
-
value The out-of-focus (OOF) filter level to set.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsConfig::GetDetectStationary | ( | ) | const |
Determine if stationary object (eg.
luggage) detection is enabled.
- Returns
- enable True if stationary object detection is enabled, false otherwise.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetDetectStationary | ( | const bool | stationary | ) |
Determine if stationary object (eg.
luggage) detection is enabled for analytics on this input.
- Parameters
-
stationary True to enable stationary object detection, false to disable.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::AnalyticsConfig::GetMinPresence | ( | ) | const |
Determine the minimum time in secocds that an object must be detected before triggering an alarm.
The valid range is 0-60. The default is 0.
- Returns
- The minimum object detection time in seconds.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsConfig::SetMinPresence | ( | const int32_t | presence | ) |
Set the minimum time in secocds that an object must be detected before triggering an alarm.
The valid range is 0-60. The default is 0. Values outwith the valid range will be clamped.
- Parameters
-
presence The minimum object detection time in seconds.
| DB_EDGEVIS_SDK std::vector<AnalyticsRegion> EdgeVisDecoderSDK::AnalyticsConfig::GetRegions | ( | ) | const |
Get the detection regions defined for this input.
- Returns
- A vector containing detection regions.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsConfig::SetRegions | ( | std::vector< AnalyticsRegion > | regions | ) |
Set the detection regions defined for this input.
- Parameters
-
regions A vector containing the detection regions to use for this input.
- Returns
- True if the detection regions were valid, false if the supplied regions were invalid (eg. duplicated region IDs)
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/AnalyticsConfig.h