Display Modes

Display mode classes are responsible for the translation of values to color, provide functions like windowing and implement helper functions for displaying the results.

class pyseus.modes.BaseMode

Defines the interface for display mode classes.

adjust_window(move_steps, scale_steps)

Move and scale the window simultaneously.

apply_window(data)

Apply current window settings to data.

black = None

Value translated to black (lower bound of window).

data_max = None

Maximum value used for resetting the window.

data_min = None

Minimum value used for resetting the window.

generate_thumb(data, size)

Resize data for use as a thumbnail. Thumbnail size is controlled in settings.ini.

get_pixmap(data)

Convert data into a QPixmap object.

move_window(steps)

Move the window up / down; results in a darker / lighter image. Step size is controlled in settings.ini.

prepare(data)

Prepare data for display (see prepare_raw) and apply windowing settings.

prepare_raw(data)

Prepare data for analysis. Use amplitude or phase data occording to the current display mode.

reset_window()

Reset the window to cover the entire range of values in the data.

scale_window(steps)

Shrink / widen the window; results in higher / lower contrast. Step size is controlled in settings.ini.

classmethod setup_menu(app, menu, ami)

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

setup_window(data)

Analyze data and set window and boundary conditions (min, max).

classmethod start(app)

Set the respective tool as active.

temporary_window(data)

Analyze data and set window (black, white). Used for temporary changes in window settings like thumbnail generation.

white = None

Value translated to white (upper bound of window).

Built-in Display Modes

Grayscale Mode

class pyseus.modes.Grayscale

Display class for grayscale images with simple windowing.

set_source(src)

Use amplitude (1) or phase (0) infromation in data.

source = None

Determines wheter amplitude (0) or phase (1) information from the data is used. Default ist amplitude (0).

Custom Display Modes

Just extend the BaseMode class and add the mode class to the PySeus.modes list.