spacr.ops_settings¶

Types, categories and help for every optical-pooled-screening setting.

So the registration happens ON THE WAY IN rather than being retrofitted. A setting with no type cannot be validated; a setting with no tooltip is a labelled box a user has to guess at; a setting in no category does not appear in the panel at all.

TOOLTIPS SAY WHAT THE SETTING DOES TO THE RESULT, not what it is named. “The number of features” tells a reader nothing they could not read off the label. “More features find more overlap and cost time and memory; below about 2000 a sparse field stops matching” tells them which way to move it and why.

Functions¶

`ops_defaults`([settings])	The settings the OPS engine reads, with their defaults filled in.
`register`(→ bool)	Register the OPS defaults, types, categories and help.

Module Contents¶

spacr.ops_settings.ops_defaults(settings=None)[source]¶

The settings the OPS engine reads, with their defaults filled in.

Parameters:: settings – caller’s settings, filled in with the defaults.
Returns:: the completed settings dict.

spacr.ops_settings.register(replace: bool = False) → bool[source]¶

Idempotent by default: a module imported from both the GUI and a headless run registers twice, and that must not be an error.

Parameters:: replace – overwrite an existing registration rather than declining.
Returns:: True when this call did the registering.