Fields
======

:doc:`simple`
-------------
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.

:doc:`groups`
-------------
:py:class:`FieldGroup <pumpia.module_handling.fields.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).

:doc:`windows`
--------------
:py:class:`FieldWindow <pumpia.module_handling.fields.windows.FieldWindow>`'s can be used to group fields together in the user interface.

:doc:`viewer_fields`
--------------------
Viewer fields have the same parameters as :py:class:`Viewers <pumpia.widgets.viewers.BaseViewer>`, with the addition of the row and column that to position the viewer.
The following viewer fields are provided:

    * :py:class:`ViewerField <pumpia.module_handling.fields.viewer_fields.ViewerField>`
    * :py:class:`ArrayViewerField <pumpia.module_handling.fields.viewer_fields.ArrayViewerField>`
    * :py:class:`MonochromeViewerField <pumpia.module_handling.fields.viewer_fields.MonochromeViewerField>`
    * :py:class:`DicomViewerField <pumpia.module_handling.fields.viewer_fields.DicomViewerField>`
    * :py:class:`MonochromeDicomViewerFiel <pumpia.module_handling.fields.viewer_fields.MonochromeDicomViewerField>`

:doc:`roi_fields`
-----------------
If an :doc:`ROI </components/rois>` 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:

    * :py:class:`InputGeneralROI <pumpia.module_handling.fields.roi_fields.GeneralROIField>`
    * :py:class:`InputRectangleROI <pumpia.module_handling.fields.roi_fields.RectangleROIField>`
    * :py:class:`InputEllipseROI <pumpia.module_handling.fields.roi_fields.EllipseROIField>`
    * :py:class:`InputLineROI <pumpia.module_handling.fields.roi_fields.LineROIField>`
    * :py:class:`InputAngle <pumpia.module_handling.fields.roi_fields.AngleROIField>`
    * :py:class:`InputPointROI <pumpia.module_handling.fields.roi_fields.PointROIField>`

Contents
--------
.. toctree::
    simple
    groups
    windows
    viewer_fields
    roi_fields