Fields

Simple Fields

Simple fields to represent the following:

  • Strings

  • Integers

  • Floats

  • Dates

  • Booleans

  • Options

Fields are reset before analysis if their reset_on_analysis parameter is set to True, this may be useful for debugging.

Labels are automatically generated by replacing underscores with spaces and capitalising words, unless provided by verbose_name. The ttk style for the label and entry can be provided.

Field Groups

FieldGroup’s can be used to group fields together so they have the same value. Can only be used in collections, used to share information between modules (e.g. if two modules should use the same ROI size).

Field Window

FieldWindow’s can be used to group fields together in the user interface.

Viewer Inputs and Outputs

Viewer fields have the same parameters as Viewers, with the addition of the row and column that to position the viewer. The following viewer fields are provided:

Region of Interest Fields

If an ROI is generated procedurally then it must be registered with the relevant field register_roi to access it in the user interface. A registered ROI can be accessed through the roi attribute of the relevant field.

The following ROI fields are provided:

Contents