Detection Configuration

Encapsulates detection configurations which are provided as part of detection region inputs to EyesOnIt.

Example

{
	"regions": [
		{
			"enabled": true,
			"name": "Front Street",
			"polygon": [...],
			"motion_detection": {...},
			"detection_configs": [
				{
					"class_name": "vehicle",
					"class_threshold": 10,
					"object_size": 350,
					"object_descriptions": [
						{
							"text": "black sedan",
							"threshold": 90,
							"alert": true,
							"background_prompt": false
						},
						{
							"text": "street building",
							"threshold": null,
							"alert": false,
							"background_prompt": true
						}
					],
					"conditions": [
						{
							"type": "count_greater_than",
							"count": 0
						}
					],
					"alert_seconds": 1.0,
					"reset_seconds": 5.0,
					"vms_config": null
				}
			]
		}
	]
}

Input Attributes

Name	Type	Description
class_name	string	optional. The name of a common object type to detect. EyesOnIt currently accepts the following common object types: "person", "vehicle", "animal", "bag". If not used, this should be null. Either class_name or object_descriptions must be used to define the objects to detect in each configuration.
class_threshold	number	optional. The threshold value for the common object type detection. If object descriptions are also specified to validate the class detection, set this to a low value between 10 and 30 to make sure that all instances of the class are detected. The object detection will then remove any false positives. If object descriptions are not used, set this to the desired alert threshold.
object_size	integer	the estimated object size in pixels. The object size overview contains guidance for determining the size of your object.
object_descriptions	array of ObjectDescription	optional. Object descriptions used to detect specific objects in your image or video. If not used, this should be null. Either class_name or object_descriptions must be used to define the objects to detect in each configuration.
conditions	array of DetectionCondition	Specifies alert conditions, either as a count condition or a line cross condition.
alert_seconds	number	the number of seconds that the detection confidence must exceed the confidence threshold before an alert is triggered and a notification is sent.
reset_seconds	number	the number of seconds after an alert that the detection confidence must not exceed the confidence threshold before the alert state gets reset so a new alert can be triggered
vms_config	VMS Config	the video management system alerting configuration