Overview

The Proximity Detector node detects and creates groups of objects when they are close to or far from each other. This node makes it easy to build common use cases such as Object left behind, Crowd forming, Service times for drive throughs, etc.

This node requires a AI Model Node and a Track Objects Node before it in order to function properly.

Inputs & Outputs

• Inputs : 1, Media Format : Raw Video
• Outputs : 1, Media Format: Raw Video
• Output Metadata : Presence Information

Properties

+person,person+person,bag-person,car.red+personAccepted formats:object_label: any object of this type, with or without a classifier attribute. Example: car, object_label.class_type: any object of this type that has a specific classifier attribute. Example: car.red, object_label.: any object of this type that has at least one classifier attribute. Example: car. (this will matchcar.red, car.yellow, etc) | model-label | null | true | | proximity_mode| Proximity mode. Options:distanceObject distance (A+B: A with B in distance limit, A-B: A without B in distance limit),enclosedObject within (A+B: A inside B, A-B: A outside B),containsObject contains (A+B: A contains B, A-B: A does not contain B) | enum | "distance" | false | |distance_threshold| Pixel distance between two objects to be considered as within a '+' group or outside a '-' group. Range: 0-1. Specified as percentage of video source width. Min: 0, Max: 1.0, Step: 0.05. Conditional on proximity_mode being set todistance. | slider | 0.1 | true | | merge_mode| Group merge mode. Options:no_merge, same_type, any_type| enum | same_type | false | |min_group_size| Ignore groups smaller than this size. | number | 1 | true | |min_group_lifespan| Ignore groups that exist for less than this amount of time in seconds. | float | 1.0 | true | |output_mode| Group output mode. Options:object(Output each group as an individual object with a unique ID),attribute(Adds the 2nd (& subsequent) objects (B) as attributes to the primary object (A)) | enum | "object" | false | |group_lifespan_trigger_threshold| Set a trigger when the group lifespan exceeds this time in seconds. | float | 5 | true | |group_size_trigger_threshold| Set a trigger when the group size exceeds this number. | number | 1 | true | |display_groups_mode| Display groups on video. Options:none, above_threshold, all| enum | "above_threshold" | false | |display_properties| Display group properties. Options:basic, intermediate, detailed| enum | "intermediate" | false | |display_roi| Display ROI on video? | bool | true | false | |tracking_mode| Tracking mode. Options:centroid, top_center, bottom_center, left_center, right_center| enum | "centroid" | false | |object_contain_mode| Object containment mode. Options:bbox(Bounding box inside other object's bounding box),tracking_point(Selected tracking point inside other object's bounding box) | enum | "tracking_point" | false | |negative_attribute_prefix` | Prefix for negative attributes. Conditional on output_mode being set to "attribute". | string | "-" | false |

Metadata

Example

"nodes": {
    "annotate_proximity1": {
        "type": "annotate_proximity",
        "rois": {
            "<roi_label>": {
                "coords": [[<point1_x>, <point1_y>], 
                           [<point2_x>, <point2_y>], 
                           [<point3_x>, <point3_y>]],
                "groups_entered_delta": <int>,
                "groups_above_lifespan_threshold_count": <int>,
                "groups_above_lifespan_threshold_delta": <int>,
                "groups_above_size_threshold_count": <int>,
                "groups_above_size_threshold_delta": <int>,                  
                "current_group_count": <int>,
                "groups": [
                  	{
                        "id": <group unique ID>,
                        "label": "<group type>",
                        "objects": [<object_id1>, <object_id2>, ....],
						"lifespan": <seconds>                      
                    }
                ]
            }
        }
    }
}

Format