enlighten.scope.Cursor.Cursor Class Reference

Encapsulates the main Graph x-axis cursor (vertical red line). More...

Public Member Functions
	__init__ (self, ctl)
	center (self)
	change_axis_callback (self, old_axis, new_axis)
	The user changed the current x-axis on the Graph.
	convert_location (self, old_axis, new_axis)
	deregister_observer (self, callback)
	dn_callback (self)
	enable_callback (self)
	get_pixel (self, spec=None)
	get_pos (self, spec=None)
	the returned X unit seems to be whatever is currently selected in the GUI
	is_enabled (self)
	is_outside_range (self)
	move_perc (self, perc)
	moved_callback (self, pos)
	recenter (self)
	register_observer (self, callback)
	set_enabled (self, flag)
	set_range (self, array=None)
	up_callback (self)
	update (self)

Public Attributes
	cb_enable = cfu.checkBox_cursor_scope_enabled
	change_axis_callback
	converter = AxisConverter(ctl)
	ctl = ctl
	current_percent = None
	cursor = pyqtgraph.InfiniteLine(movable=True, pen=self.ctl.gui.make_pen(widget="scope_cursor"))
	dn_callback
	ds_value = cfu.doubleSpinBox_cursor_scope
	enable_callback
	moved_callback
list	observers = []
	up_callback

Detailed Description

Encapsulates the main Graph x-axis cursor (vertical red line).

Note that StatusBar will register as an observer. AreaScanFeature does not, instead requesting the current value (in pixel space) each time it updates the area scan image.

Constructor & Destructor Documentation

__init__()

enlighten.scope.Cursor.Cursor.__init__	(		self,
			ctl )

Member Function Documentation

center()

enlighten.scope.Cursor.Cursor.center

(

self

)

change_axis_callback()

enlighten.scope.Cursor.Cursor.change_axis_callback	(		self,
			old_axis,
			new_axis )

The user changed the current x-axis on the Graph.

convert_location()

enlighten.scope.Cursor.Cursor.convert_location	(		self,
			old_axis,
			new_axis )

deregister_observer()

enlighten.scope.Cursor.Cursor.deregister_observer	(		self,
			callback )

dn_callback()

enlighten.scope.Cursor.Cursor.dn_callback

(

self

)

enable_callback()

enlighten.scope.Cursor.Cursor.enable_callback

(

self

)

get_pixel()

enlighten.scope.Cursor.Cursor.get_pixel	(		self,
			spec = None )

get_pos()

enlighten.scope.Cursor.Cursor.get_pos	(		self,
			spec = None )

the returned X unit seems to be whatever is currently selected in the GUI

is_enabled()

enlighten.scope.Cursor.Cursor.is_enabled

(

self

)

is_outside_range()

enlighten.scope.Cursor.Cursor.is_outside_range

(

self

)

move_perc()

enlighten.scope.Cursor.Cursor.move_perc	(		self,
			perc )

moved_callback()

enlighten.scope.Cursor.Cursor.moved_callback	(		self,
			pos )

recenter()

enlighten.scope.Cursor.Cursor.recenter

(

self

)

register_observer()

enlighten.scope.Cursor.Cursor.register_observer	(		self,
			callback )

set_enabled()

enlighten.scope.Cursor.Cursor.set_enabled	(		self,
			flag )

set_range()

enlighten.scope.Cursor.Cursor.set_range	(		self,
			array = None )

up_callback()

enlighten.scope.Cursor.Cursor.up_callback

(

self

)

update()

enlighten.scope.Cursor.Cursor.update

(

self

)

Member Data Documentation

cb_enable

enlighten.scope.Cursor.Cursor.cb_enable = cfu.checkBox_cursor_scope_enabled

change_axis_callback

enlighten.scope.Cursor.Cursor.change_axis_callback

converter

enlighten.scope.Cursor.Cursor.converter = AxisConverter(ctl)

ctl

enlighten.scope.Cursor.Cursor.ctl = ctl

current_percent

enlighten.scope.Cursor.Cursor.current_percent = None

cursor

enlighten.scope.Cursor.Cursor.cursor = pyqtgraph.InfiniteLine(movable=True, pen=self.ctl.gui.make_pen(widget="scope_cursor"))

dn_callback

enlighten.scope.Cursor.Cursor.dn_callback

ds_value

enlighten.scope.Cursor.Cursor.ds_value = cfu.doubleSpinBox_cursor_scope

enable_callback

enlighten.scope.Cursor.Cursor.enable_callback

moved_callback

enlighten.scope.Cursor.Cursor.moved_callback

observers

list enlighten.scope.Cursor.Cursor.observers = []

up_callback

enlighten.scope.Cursor.Cursor.up_callback

---

The documentation for this class was generated from the following file:

• enlighten/scope/Cursor.py