# Color Clustering

Color clustering determines the dominant colors in an image or video frame by clustering similar colors. The task returns the color at the center of each cluster, and the proportion of the pixels that belong to each cluster. If you configure a color dictionary, the task clusters colors around the colors that are defined in the dictionary, and returns a name (such as "light blue" or "red") for each cluster.

Configuration Parameter | Description
--- | ---
ColorDictionary | A dictionary file that associates names with RGB color values.
ColorSpace | The color space in which the results of analysis are provided.
ColorThreshold | Discards colors that do not make up a significant proportion of the frame.
CombineNamedColors | A Boolean value that specifies whether to combine clusters that have the same color name.
Input | The image track to process.
MaxInputQueueLength | Can be used to place a limit on latency.
NumParallel | The maximum number of video frames to analyze simultaneously.
Region | Specifies a region of the frame to process, instead of the entire frame.
RegionUnit | Specifies the units used by the `Region` parameter.
RestrictToInputRegion | Specifies whether to analyze a region of the input image or video frame that is specified in the input record, instead of the entire image.
SampleInterval | The interval at which frames are selected to be analyzed.
SegmentDuration | The maximum duration of a record in the `SegmentedResult` track.
Type | The analysis engine to use. Set this parameter to `ColorCluster`.

## Output Tracks

Output track | Type | Description | Output1This column indicates whether the information contained in the track is included by default in the output created by an output task (when you don't set the Input parameter for the output task).
--- | --- | --- | ---
`ClusteredImage` | ColorClusterImage | Contains one record for each event. Each record contains the source image, cropped to the analyzed region and modified so that it only contains colors that match the center of a color cluster. If the analyzed region is not rectangular any pixels outside the region are transparent (or black if you use an image format that does not support transparency). | No
`Data` | ColorClusterResult | Contains one record, describing the analysis results, for each input record. | No
`Result` | ColorClusterResult | Contains a record, describing the analysis results, for each event. When the input is images, Media Server considers each image separately. When the input is video from an ingest engine, or an engine that does not support tracking, Media Server begins a new result when there is a significant change in the color clustering. When the input is video from an engine that supports tracking (for example number plate recognition), results begin and end at the times provided by the other analysis task (for example when the vehicle appears and disappears). The IDs used for the color cluster records are also inherited from the input records. | Yes
`SegmentedResult` | ColorClusterResult | (Available only when processing video). Contains one or more records, describing the analysis results, for each event. The maximum duration of records in this track is limited by the parameter SegmentDuration, so multiple records are created with the same ID when an event exceeds this duration. | Yes
`Start` | ColorClusterResult | The same as the `Data` track, except it contains only the first record of each event. | No
`End` | ColorClusterResult | The same as the `Data` track, except it contains only the last record of each event. | No

ColorClusterResult

Field name | Type | Description
--- | --- | ---
id | UUIDData | A universally unique identifier to identify the analyzed image or video frame.
colorspace | String | The color space in which the results are presented.
cluster | An array of ColorClusters | Information about the colors in the analyzed frame.

ColorCluster

Field name | Type | Description
--- | --- | ---
Color | String | The color at the center of a cluster.
Colorname | String | Only present if you set the parameter ColorDictionary. Provides the name of the color from the dictionary.
Proportion | Float | The proportion of pixels in the frame that belong to the cluster.

ColorClusterImage

Field name | Type | Description
--- | --- | ---
id | UUIDData | A universally unique identifier to identify the analyzed image or video frame.
image | ImageData | The source image, containing only colors that match the center of a color cluster, and cropped to the analyzed region. If the analyzed region is not rectangular any pixels outside the region are transparent (or black if you use an image format that does not support transparency).

© Copyright 2019 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a mail client, and then send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm