ContrastMode

class glue_qt.viewers.matplotlib.toolbar_mode.ContrastMode(viewer, **kwargs)

Bases: ToolbarModeBase

Uses right mouse button drags to set bias and contrast, DS9-style.

The horizontal position of the mouse sets the bias, the vertical position sets the contrast.

The move_callback defaults to calling _set_norm on the viewer with the instance of ConstrastMode as the sole argument.

Attributes Summary

action_text
enabled	A property that callback functions can be added to.
icon
shortcut
status_tip
tool_id
tool_tip

Methods Summary

activate()	Activates all MPL event handlers associated with this mouse mode.
choose_vmin_vmax()
close()
deactivate()	Deactivates all MPL event handlers associated with this mouse mode.
get_clip_percentile()
get_vmin_vmax()
key(event)	Handles key press events.
menu_actions()	List of QtWidgets.QActions to be attached to this tool as a context menu.
move(event)	MoveEvent.
press(event)	Handles mouse presses.
release(event)	Handles mouse release events.
set_clip_percentile(lo, hi)	Percentiles at which to clip the data at black/white
set_vmin_vmax(vmin, vmax)

Attributes Documentation

action_text = 'Contrast'

enabled

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

icon = 'glue_contrast'

shortcut = 'B'

status_tip = None

tool_id = 'image:contrast'

tool_tip = 'Adjust the bias/contrast'

Methods Documentation

activate()

Activates all MPL event handlers associated with this mouse mode.

choose_vmin_vmax()

close()

deactivate()

Deactivates all MPL event handlers associated with this mouse mode.

get_clip_percentile()

get_vmin_vmax()

key(event)

Handles key press events.

Calls key_callback method.

Parameters:

eventmatplotlib.backend_bases.KeyEvent

The event that was triggered

menu_actions()

List of QtWidgets.QActions to be attached to this tool as a context menu.

move(event)

MoveEvent. Update bias and contrast on Right Mouse button drag

press(event)

Handles mouse presses.

Logs mouse position and calls press_callback method.

Parameters:

eventmatplotlib.backend_bases.MouseEvent

The event that was triggered

release(event)

Handles mouse release events.

Logs mouse position and calls release_callback method.

Parameters:

eventmatplotlib.backend_bases.MouseEvent

The event that was triggered

set_clip_percentile(lo, hi)

Percentiles at which to clip the data at black/white

set_vmin_vmax(vmin, vmax)