parameters

Manages image analysis parameters.

Settings are stored in a file named parameters.yaml in the analysis subfolder of the folder containing the input images. If that file does not yet exist, it will be created and initialized with default values. The user may edit that file manually for a given analysis run.

After calling init, read or modify parameter values with the get and set functions.

init(folder: Path)

Loads configuration from parameters.yaml in given folder.

If that file does not yet exist, it will be created and initialized with default values for the parameters.

save()

Saves configuration to file, preserving comments from first load.

get(section: str, name: str) → Any

Returns the value of the named parameter from the given section.

set(section: str, name: str, value: Any)

Set the value of the named parameter from the given section.

defaults_file() → Path

Returns the configuration file with the default parameter values.

The default values are stored in a file named parameters.yaml. The primary copy is distributed with this application and stored along with the executable. Typically, files in this location would be read-only, so we provide the user with a copy in their config folder instead, as they can then edit it.