Aggregate Metadata

Aggregates Metadata that matches specified wildcard patterns and adds resulting value for subsequent nodes to use.

Overview

This node Aggregates Metadata that matches specified wildcard patterns and adds resulting value for subsequent nodes to use. It is useful when you want to build triggers that act across various metadata properties (such as when an object enters any ROIs vs a specific ROI in the Occupancy Monitor Node).

Inputs & Outputs

  • Inputs : 1, Media Format : Raw Video
  • Outputs : 1, Media Format: Raw Video
  • Output Metadata : Aggregated Value

Properties

PropertyDescriptionTypeDefaultRequired
metadata_patternsex. nodes.annotate_motion1.rois.*.motion. Comma-separated metadata pattern(s) to aggregate. Replace desired aggregation level with *. Format: comma-separated metadata paths or patterns.stringnullYes
aggregation_modeAggregation mode. Options: Any (logical OR) (any): Convert any numbers to boolean: Non-zero = True; All (logical AND) (all): Convert any numbers to boolean: Non-zero = True; Sum (sum): Convert any booleans to numbers: True = 1, False = 0.enumanyYes

Output Metadata

The fields below are declared by this node's metadata schema; the JSON values are representative examples.

PathTypeDescription
nodes.<node_id>.aggregate_valueboolean or numberBoolean or number containing the result aggregated from the configured metadata values.
nodes.<node_id>.typestringIdentifies the node type that produced this metadata.

JSON example

{
  "nodes": {
    "aggregate_metadata1": {
      "aggregate_value": 0,
      "type": "aggregate_metadata"
    }
  }
}

Did this page help you?