Microscope Python SDK built-in nodes

These descriptors are embedded in the viewer's offline catalogue and correspond to built-in source/layer nodes.

WSI region

Stable type ID: microscope.source
Version: 1
Required pack: Microscope Python SDK built-ins (microscope-python source catalogue)

Browser-captured viewport, selected ROI, bounded region, overview, or the whole WSI. Slide pixels stay in this browser.

Inputs

Port	Type	Required
—	None	—

Outputs

Port	Type
image	image

Parameters

Name	Type	Default	Constraints / notes
scope	enum	viewport	label: Scope; values: ["viewport", "roi", "rectangle", "overview", "whole_slide"]
x	integer	0	label: X (level-0 pixels); min: 0; max: 100000000
y	integer	0	label: Y (level-0 pixels); min: 0; max: 100000000
width	integer	1024	label: Width (level-0 pixels); min: 1; max: 100000000
height	integer	1024	label: Height (level-0 pixels); min: 1; max: 100000000
mpp	number	0.5	label: Working MPP (µm/px); min: 0.01; max: 100
input_id	string	``	label: Runtime input; local runtime only; excluded from portable workflow data

Execution requirements: {"mode": "source", "version": 1}

Layer source · binary mask

Stable type ID: microscope.layer_source_mask
Version: 1
Required pack: Microscope Python SDK built-ins (microscope-python source catalogue)

Snapshot an existing mask layer from the current WSI for this job.

Inputs

Port	Type	Required
—	None	—

Outputs

Port	Type
mask	mask

Parameters

Name	Type	Default	Constraints / notes
layer_id	string	``	label: ; local runtime only; excluded from portable workflow data
input_id	string	``	label: ; local runtime only; excluded from portable workflow data

Execution requirements: {"mode": "region", "version": 1}

Layer source · probability

Stable type ID: microscope.layer_source_probability
Version: 1
Required pack: Microscope Python SDK built-ins (microscope-python source catalogue)

Snapshot an existing probability layer from the current WSI for this job.

Inputs

Port	Type	Required
—	None	—

Outputs

Port	Type
probability	probability

Parameters

Name	Type	Default	Constraints / notes
layer_id	string	``	label: ; local runtime only; excluded from portable workflow data
input_id	string	``	label: ; local runtime only; excluded from portable workflow data

Execution requirements: {"mode": "region", "version": 1}

Layer source · instance labels

Stable type ID: microscope.layer_source_labels
Version: 1
Required pack: Microscope Python SDK built-ins (microscope-python source catalogue)

Snapshot an existing instance-label layer from the current WSI for this job.

Inputs

Port	Type	Required
—	None	—

Outputs

Port	Type
labels	labels

Parameters

Name	Type	Default	Constraints / notes
layer_id	string	``	label: ; local runtime only; excluded from portable workflow data
input_id	string	``	label: ; local runtime only; excluded from portable workflow data

Execution requirements: {"mode": "region", "version": 1}

Layer source · grayscale

Stable type ID: microscope.layer_source_gray
Version: 1
Required pack: Microscope Python SDK built-ins (microscope-python source catalogue)

Snapshot an existing grayscale layer from the current WSI for this job.

Inputs

Port	Type	Required
—	None	—

Outputs

Port	Type
gray	gray

Parameters

Name	Type	Default	Constraints / notes
layer_id	string	``	label: ; local runtime only; excluded from portable workflow data
input_id	string	``	label: ; local runtime only; excluded from portable workflow data

Execution requirements: {"mode": "region", "version": 1}

Layer source · ROI polygons

Stable type ID: microscope.layer_source_roi
Version: 1
Required pack: Microscope Python SDK built-ins (microscope-python source catalogue)

Snapshot WSI level-0 polygons; coordinates are not geographic longitude/latitude.

Inputs

Port	Type	Required
—	None	—

Outputs

Port	Type
rois	roi

Parameters

Name	Type	Default	Constraints / notes
layer_id	string	``	label: ; local runtime only; excluded from portable workflow data
input_id	string	``	label: ; local runtime only; excluded from portable workflow data

Execution requirements: {"mode": "region", "version": 1}