Skip to content

Region Editor

The Region Editor lists every region on the current image, with its class and area. Use it to classify, recolour, select, delete, import and export regions. Open it with the Open the Region Editor button in the toolbar.

The Region Editor

  • It opens as a floating dialog docked on the right. You can drag, resize and maximise it, and keep it open while you draw.
  • Edits apply live to the image. There is no save or cancel. Every edit can be undone with Ctrl+Z.
  • Regions are tracked per image (and per slice for stacks). Switching images shows that image's regions.
  • Regions live in memory only. Export them, or Save regions to server when your application offers it, to keep them.
  • Geometry is edited on the image (see Region tools), not in the table.

The button at the end of the toolbar opens this page.

Toolbar

The Region Editor toolbar

Button Icon What it does
Show region labels Shows each region's class name on the image. Slower with many regions.
Fill regions in their colour Fills regions in their class colour (an atlas's look), with labels inside.
See the regions through the volume Volume view only. Off: the volume hides the parts of regions behind it. On: regions show through.
Import regions A GeoJSON file, or a label volume (.nii, .nii.gz, .nrrd) with its ontology JSON. See Import.
Import a folder A folder of per-slice GeoJSON files (one per slice, in name order, with its regionset.json), an OME-Zarr store or zip files.
Download regions as geojson file Opens Export Regions. See Export.
Save regions to server Opens Save Regions As. Available when the host application stores regions.
Import regions from server Pick a GeoJSON file, a folder of per-slice files or a label volume on the server. Shown only when the host supports it.
Download mask of the regions as PNG Opens Save Mask. See Masks.
x512 — Rounds every rectangle's width and height to the nearest multiple of 512 pixels. Polygons are unchanged.
Select all regions Selects every region (and up to 5,000 features of a large region set).
Edit class on selected rows Sets one class on every selected region.
Edit colour of selected regions Opens Region colour.
Delete selected regions Deletes the selected regions from the table and the image.
Delete all regions Asks "Are you sure you want to delete all regions?", then deletes every region on this image.
Help Opens this page.

x512 and small rectangles

x512 rounds to the nearest multiple, so a side shorter than 256 pixels becomes 0.

Classes panel

The Classes panel above the table lists the classes with their colours and region counts. It is described in Annotation classes.

Class tree

Class tree of an atlas region set

A region set with a class hierarchy (a brain atlas, for example) shows its classes as a tree. Switch between tree and list with / .

Action How
Expand / collapse / . Top-level classes start expanded.
Pick a class Click its row (or press Enter): the class and all its subclasses are picked and their regions selected. The header shows "name · title".
Add to the pick Shift, Ctrl or Cmd + click.
Find a class Type in Search by name; Enter picks the first match.
Show or hide The eye hides or shows the class and its subclasses. A partly hidden subtree shows a partial eye.
Show in 3D Show in the volume, in 3D (volume views).
One surface or each cell (Spatial omics 3D, classes of cells).

Classes not present on the current slice are greyed out. Hover a row to see its full title. Picking a class selects at most 5,000 features from a large region set.

Picked classes drive Select from ROIs in Spatial omics 3D. Selecting anything else (a region on the image, a table row) replaces the pick.

The table

Column What it shows
Class The region's class. Pick one from the dropdown (the colour follows), or click Rename / free-form label to type a name (Enter applies, Esc cancels).
Surface The region's area on this slice.
Volume Volume views: the volume of the region's class over the whole stack (its area on every slice, one slice thick).
Deletes that region.

The table shows 10 rows per page by default (10, 25 or 50).

Area units

Image Unit
No physical pixel size px²
With a pixel size µm², switching to mm² from 1,000,000 µm²
Volumes voxels, µm³ or mm³

Holes are subtracted and the parts of a multi-part region are added. Values of 1,000 or more are rounded to whole numbers; smaller values show two decimals.

Selecting rows

Action How
Select a row Click it. The region is highlighted on the image.
Add or remove a row Ctrl / Cmd + click.
Select a range Shift + click.

Selecting a region on the image selects its row (the table turns to its page). Clicks on a colour picker, a trash icon or the class editor do not change the selection.

Large region sets

A very large annotation file (for example thousands of cells from QuPath) loads as a region set: it is drawn at a level of detail that suits the zoom, and its features are listed after your regions in the table. Selecting, reclassifying or renaming a feature turns it into an ordinary region. See Limits.

Set class on selected regions

Set class on the selected regions

Select rows, then click . The panel Set class on N selected region(s) offers:

  • Choose a class…: applies a class at once (with a filter when there are more than 8 classes);
  • …or a new class: type a name and press Enter or Add class & set it.

Region colour

The Region colour dialog

Select rows, then click . The Region colour dialog shows one colour picker per class among the selected regions (unclassified regions appear as "Unclassified"). Apply sets the outline colour of those regions only. A colour set this way is kept: the class colour no longer overrides it.

Regions in 3D

In the Volume view (and with the slice editor), regions drawn on slices can be shown as 3D surfaces per class:

  • Show in the volume, in 3D on a class row reconstructs that class (and its subclasses) from every slice's outlines into a translucent surface. Open lines become sheets.
  • With the Selection tool, click a surface in the 3D view to pick its class; Shift-click adds to the pick. Picked classes turn nearly opaque and the others fade.
  • The Volume column gives each class's volume.

Messages

Message Meaning
Regions imported The import worked; the detail says how many slices were annotated.
Import discarded You switched images while the file was being read, so it was not applied.
Different size A label volume's slices do not match the image size.
Error importing regions / Error importing the file The file could not be read; the detail says why.
Regions saved Saved to the server.
Error saving regions / Error exporting regions Saving or exporting failed.
Could not show the region in 3D The class surface could not be built.