eelbrain.fmtxt.Report.add_image_figure

Report.add_image_figure(image, caption, alt=None)

Add an image in a figure frame to the section

Parameters:

• image (Image | ndarray | str | List[str] | FMTextElement | FMTextConstant) – Image, image array or target filename for the image. If a filename it should have the appropriate extension.

• caption (str | List[str] | FMTextElement | FMTextConstant) – Figure caption.

• alt (str) – Alternate text, placeholder in case the image can not be found (HTML alt tag).

Returns:

image – Image object that was added.

Return type:

Image

See also

add_figure

add an empty figure

Notes

Return the Image object which can be used to write the image data. If a function supports writing to a file-like object, it can be written with save_image(image). A function that writes a file to disk can be used as save_image(image..