Tools

Tools provide different ways to evaluate data.

All tools extend the BaseTool class, guaranteeing basic functionality.

class pyseus.tools.BaseTool(app)

Defines the basic functionality for RoI evaluation functions.

clear()

Resets region of interest, image overlays and result display.

draw_overlay(pixmap)

Draws the tool specific overlay on the displayed image.

end_roi(x, y)

End marking a region of interest (on mouse button up).

recalculate(data)

Evaluates the data in the set region of interest.

classmethod setup_menu(app, menu, ami)

Add the mode to the menu bar in the main window.

classmethod start(app)

Set the respective mode as active.

start_roi(x, y)

Start marking a region of interest (on mouse button down).

Built-in Tools

Area Tool

class pyseus.tools.AreaTool(app)

Class providing simple RoI evaluation.

roi = None

Coordinates of the current region-of-interest.

Line Tool

class pyseus.tools.LineTool(app)

Class providing simple evaluation along a line

line = None

Start and end coordinates of the current line.

class pyseus.tools.line.LineToolWindow

Dispalys LineTool results in a chart window.

load_data(data, axes)

Display a list of values in the chart.

Custom Tools

Just extend the BaseTool class and add the class to the PySeus.tools list.