Overview

The Color Classifier node classifies the predominant color of objects in a ROI, or of a ROI in the frame. This functionality is useful for applications requiring color-based classification of objects or areas within a video feed.

Inputs & Outputs

Inputs: 1, Media Format: Raw Video
Outputs: 1, Media Format: Raw Video
Output Metadata: nodes.node_id, recognized_objs, recognized_obj_ids, recognized_obj_count, recognized_obj_delta, value_changed_delta, unrecognized_obj_count, unrecognized_obj_delta

Properties

Property	Description	Type	Default	Required
`roi_labels`	Regions of interest labels	hidden		Yes
`rois`	Regions of interest. Conditional on roi_labels.	polygon	null	Yes
`processing_mode`	Processing mode. Options: ROIs, at an Interval (`rois_interval`), ROIs, upon a Trigger (`rois_trigger`), Objects in an ROI (`objects`).	enum	rois_interval	Yes
`trigger`	Trigger Condition. Queue ROI for lookup when this condition evaluates to true. Conditional on processing_mode being rois_trigger.	trigger-condition	null
`objects_to_process`	Object types to process. ex. `car`,`person`,`car.red`. Conditional on processing_mode being objects.	model-label	null
`min_obj_size_pixels`	Min. width and height of an object. Conditional on processing_mode being objects.	number	64
`obj_lookup_size_change_threshold`	Object size ratio change threshold. Slider min: 0.1, max: 2.0, step: 0.2. Conditional on processing_mode being objects.	slider	0.1
`max_lookups_per_obj`	Max. attempts per object. Conditional on processing_mode being objects.	number	5
`min_confidence_threshold`	Minimum confidence threshold. Only consider results above this threshold in the color classification. Slider min: 0, max: 1.0, step: 0.05.	slider	0.2	Yes
`interval`	Lookup interval in seconds. Queue objects or ROIs for lookup at least this many seconds apart.	number	1
`display_roi`	Display ROI on video?	bool	true
`display_objinfo`	Display results on video? Options: Disabled (disabled), Bottom left (bottom_left), Bottom right (bottom_right), Top left (top_left), Top right (top_right).	enum	bottom_left
`debug`	Log debugging information?	bool	false

Metadata

The output metadata includes information about the color classification results, such as color labels and any changes in their recognition status. This allows for a comprehensive understanding of the scene being analyzed.

Color labels output by this node include: 'black', 'blue', 'brown', 'green', 'grey', 'orange', 'pink', 'purple', 'red', 'white', 'yellow'

Output Metadata

Metadata Property	Description
`objects[index].attributes[index].label`	Object color label if `processing_mode` was set to `objects`
`nodes.[node_id].rois.[roi_id].label_changed_delta`	Indicates if there has been a change in the color label of the ROI.
`nodes.[node_id].rois.[roi_id].label_available`	Indicates if a color label is available for the ROI.
`nodes.[node_id].rois.[roi_id].label`	Color label if one is available for the ROI.
`nodes.[node_id].recognized_obj_count`	The count of recognized objects with color classification.
`nodes.[node_id].recognized_obj_delta`	The change in the count of recognized objects.
`nodes.[node_id].label_changed_obj_delta`	The change in the count of objects with changed color labels.
`nodes.[node_id].unrecognized_obj_count`	The count of unrecognized objects.
`nodes.[node_id].unrecognized_obj_delta`	The change in the count of unrecognized objects.