Compass

Plugin Availability

The plugin will be visible when at least one viewer is available.

Display orientation compass on images.

Description

The Compass plugin overlays a compass rose on image viewers showing the orientation of North and East directions based on WCS information.

Key Features:

• Show/hide compass overlay

• Auto-update with WCS changes

• Works with multiple viewers

UI Access

Click the Compass icon in the plugin toolbar to toggle compass display.

API Access

plg = imviz.plugins['Compass']
plg.show = True  # Display compass
plg.show = False  # Hide compass

API References

Only the following attributes and methods are available through the public plugin API:

• show()

• open_in_tray()

• close_in_tray()

• viewer (ViewerSelect): Viewer to show orientation/compass information.

• data_label: label of the top-layer shown in the compass (read-only)

For detailed API documentation, see Compass.

See Also

• Compass - Imviz compass documentation