AddImageToReport¶

ID: Display/AddImageToReport

This template can be used to add an image to the trace analysis report.

It uses the method Report.Image() which is documented in the TraceanalysisAPI documentation (see chapter ‘API references’ in the program help).

Signals¶

Parameters¶

imageSource¶

(str|Image|Frame|numpy.ndarray|bytes)

The image source can be one of the following: - an absolute file path - an Image or Frame object - a NumPy array in OpenCV style: shape is (height, width, 3) of type numpy.uint8, the three colors have the order BGR! - bytes object with image data

• Direction: IN

name¶

(str) - The filename (with correct extension). Will be used as filename if an image file is created in the report folder. If name is None and the source is a path or an Image or Frame, the name of the imageSource is used.

• Direction: IN

title¶

(str) - the image title

• Direction: IN

embedded¶

(bool) - True, if the image file should be embedded in the test report, else the image file is stored in the test report folder.

• Direction: IN

limitPreviewSize¶

(bool) - If True (default), the preview image shown in the report will be limited to a maximum size.

• Direction: IN

autoDelete¶

(bool) - Only applicable if imageSource is a file path. True, if the image file should be automatically deleted, else False.

• Direction: IN