spacr.ops_settings¶
Types, categories and help for every optical-pooled-screening setting.
Each setting is registered with its type, tooltip and category when it is added. A setting with no type cannot be validated, a setting with no tooltip has no help text, and a setting in no category does not appear in the panel.
Tooltips describe the setting’s effect on the result rather than repeating its name. For example, “The number of features” repeats the label, whereas “More features find more overlap and cost time and memory; below about 2000 a sparse field stops matching” states the effect of raising or lowering it.
Functions¶
|
The settings the OPS engine reads, with their defaults filled in. |
|
Register the OPS defaults, types, categories and help. |
|
Register both spatial submodules' defaults, types, categories and help. |
|
The settings the Spatial Map Barcodes engine reads, filled in. |
|
The settings the Spatial Mask Generation engine reads, filled in. |
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]¶
Register the OPS defaults, types, categories and help.
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.
- spacr.ops_settings.register_spatial(replace: bool = False) bool[source]¶
Register both spatial submodules’ defaults, types, categories and help.
- Parameters:
replace – overwrite existing registrations rather than declining.
- Returns:
True when this call did the registering.