Assistants

Assistants open an interactive Matplotlib window so a user can pick points, boxes, rotations or labels and feed the result straight into a correction or analysis. They all derive from BaseAssistant.

Geometry selection

PointSelectionAssistant(img, **kwargs)	Interactive assistant for picking a set of points on a 2d image.
BoxSelectionAssistant(img, **kwargs)	Interactive assistant for drawing one or more rectangular boxes on an image.
RectangleSelectionAssistant(img, **kwargs)	Assistant for selecting a rectangle in an image.
SubregionAssistant(img, **kwargs)	Graphical assistant to define subregions in 2d and 3d.
CropAssistant(img, **kwargs)	Graphical assistant for cropping images as part of CurvatureCorrection.
RotationCorrectionAssistant(img, **kwargs)	Class defining an assistant to set up darsia.RotationCorrection.

Label editing

LabelsAssistant([labels, background])	Assistant to modify labels.
LabelsPickAssistant(labels, background, **kwargs)	Module for LabelsAssistant to pick labels.
LabelsMaskSelectionAssistant(labels[, ...])	Module for LabelsAssistant to select a mask from labels.
LabelsMergeAssistant(labels[, background])	Module for LabelsAssistant to merge labels.
LabelsSegmentAssistant(labels, background[, ...])	Module for LabelsAssistant to segment labels.
MonochromaticAssistant(img, **kwargs)	Assistant to choose monochromatic image.

Advanced

BaseAssistant(img, **kwargs)	Matplotlib based interactive assistant.
LabelsAssistantMenu(img[, background])	Module for LabelsAssistant to choose what to do with labels.