ReportFramesAtStartTrigger

ID: Multimedia/ReportFramesAtStartTrigger

This is a versatile template for reporting the results of video analyses.

It reports (by default) the first frame of a video signal per trigger range and can visualize various additional information, such as applied masks or the matches from an image-in-image search.

Signals

VideoFrames

The video signal that shall be used for reporting.

  • Direction: IN

  • Optional: False

Matches

A signal of MatchList[ImageMatch] objects, as returned by the trace step template FindImage.

  • Direction: IN

  • Optional: True

Parameters

FrameOffset

Index offset of the frames to be reported. The default value of 0 leads to only the frame at the trigger start being reported. A value of (-1, 0, 1) leads to three reported frames: The last frame before the trigger, the frame at the trigger start and the frame thereafter.

  • Direction: IN

Mask

A mask to be visualized. The Mask object can be constructed from a mask file path. Alternatively, api.DataBrowser.BrowseMultimedia(deviceKey) can be used.

  • Direction: IN

MaskColor

An RGBA color value for the mask visualization. The default value of (0, 0, 0, 128) applies a black shading to the region outside of the mask with 50% opacity.

  • Direction: IN

MatchColor

An RGB color value to be used for visualizing image matches.

  • Direction: IN

Verdict

The verdict to be set for each trigger range.

  • Direction: IN

MaxReportImageCount

A maximum number of images to be added to the report.

  • Direction: IN