inset

Description

Inset an image inside another. Uses RGB versions of both images, as defined by the RGB mapping set in the previous nodes. Does not honour regions of interest. Note that there is no RGB mapping in the canvas for the tab - RGB mappings should be set in the input nodes.

The rectangle can be set either from an ROI or from a rectangle which can be drawn on the canvas. If neither is set, no insetting will be done and only the background will be shown. The rectangle can be cleared by clicking "Clear rect" in the tab, but any ROI takes priority.

Ignores DQ and uncertainty


Connections

Inputs

Index Name Type Desc
0 img img (none)
1 inset img (none)
2 roi roi (none)

Outputs

Index Name Type Desc
0 (none) img (none)

Parameters

insetinsetrectThe rectangle in which to inset the image (ordered)x: integer (default 0)The x coordinate of the top left corner
y: integer (default 0)The y coordinate of the top left corner
w: integer (default -1)The width of the rectangle
h: integer (default -1)The height of the rectangle
caption: string (default '')Caption to put on the inset
captiontop: boolean (default False)Put the caption at the top of the inset
fontsize: integer (default 10)Font size for the caption
thickness: integer (default 2)Thickness of the border
colourColour of the border and caption (ordered)r: int or float (default 1.0)The red component 0-1
g: int or float (default 1.0)The green component 0-1
b: int or float (default 0.0)The blue component 0-1

Automatically generated by generate_autodocs.py

Date: 2025-02-17T16:09:18.986731