boxMask

sans.guiframe.local_perspectives.plotting.boxMask

class sans.guiframe.local_perspectives.plotting.boxMask.BoxMask(base, axes, color='black', zorder=3, side=None, x_min=0.0080000000000000002, x_max=0.0080000000000000002, y_min=0.0025000000000000001, y_max=0.0025000000000000001)

Bases: sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor

BoxMask Class: determine 2 rectangular area to find the pixel of a Data inside of box.

Uses PointerInteractor , VerticalDoubleLine,HorizontalDoubleLine.

Parameters:
  • zorder – Artists with lower zorder values are drawn first.
  • x_min – the minimum value of the x coordinate
  • x_max – the maximum value of the x coordinate
  • y_min – the minimum value of the y coordinate
  • y_max – the maximum value of the y coordinate
clear()

Clear the slicer and all connected events related to this slicer

clear_markers()

Clear old markers and interfaces.

connect_markers(markers)

Connect markers to callbacks

dpixel(x, y, nudge=False)

Return the step size in data coordinates for a small step in screen coordinates. If nudge is False (default) the step size is one pixel. If nudge is True, the step size is 0.2 pixels.

draw()
freeze_axes()
get_mask()

return mask as a result of boxcut

get_params()

Store a copy of values of parameters of the slicer into a dictionary.

Return params:the dictionary created
move(x, y, ev)

Process move to a new position, making sure that the move is allowed.

moveend(ev)

After a dragging motion this function is called to compute the error and the sum of pixel of a given data 2D

onClick(ev)

Prepare to move the artist. Calls save() to preserve the state for later restore().

onDrag(ev)

Move the artist. Calls move() to update the state, or restore() if the mouse leaves the window.

onHilite(ev)

Hilite the artist reporting the event, indicating that it is ready to receive a click.

onKey(ev)

Respond to keyboard events. Arrow keys move the widget. Escape restores it to the position before the last click.

Calls move() to update the state. Calls restore() on escape.

onLeave(ev)

Restore the artist to the original colour when the cursor leaves.

onRelease(ev)
restore()

Restore the roughness for this layer.

save(ev)

Remember the roughness for this layer and the next so that we can restore on Esc.

set_cursor(x, y)
set_params(params)

Receive a dictionary and reset the slicer with values contained in the values of the dictionary.

Parameters:params – a dictionary containing name of slicer parameters and values the user assigned to the slicer.
thaw_axes()
update()

Respond to changes in the model by recalculating the profiles and resetting the widgets.

class sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask(base, axes, color='black', zorder=3, side=None, x_min=0.0080000000000000002, x_max=0.0080000000000000002, y_min=0.0025000000000000001, y_max=0.0025000000000000001)

Bases: sans.guiframe.local_perspectives.plotting.boxMask.BoxMask

clear()

Clear the slicer and all connected events related to this slicer

clear_markers()

Clear old markers and interfaces.

connect_markers(markers)

Connect markers to callbacks

dpixel(x, y, nudge=False)

Return the step size in data coordinates for a small step in screen coordinates. If nudge is False (default) the step size is one pixel. If nudge is True, the step size is 0.2 pixels.

draw()
freeze_axes()
get_mask()

return mask as a result of boxcut

get_params()

Store a copy of values of parameters of the slicer into a dictionary.

Return params:the dictionary created
move(x, y, ev)

Process move to a new position, making sure that the move is allowed.

moveend(ev)

After a dragging motion this function is called to compute the error and the sum of pixel of a given data 2D

onClick(ev)

Prepare to move the artist. Calls save() to preserve the state for later restore().

onDrag(ev)

Move the artist. Calls move() to update the state, or restore() if the mouse leaves the window.

onHilite(ev)

Hilite the artist reporting the event, indicating that it is ready to receive a click.

onKey(ev)

Respond to keyboard events. Arrow keys move the widget. Escape restores it to the position before the last click.

Calls move() to update the state. Calls restore() on escape.

onLeave(ev)

Restore the artist to the original colour when the cursor leaves.

onRelease(ev)
restore()

Restore the roughness for this layer.

save(ev)

Remember the roughness for this layer and the next so that we can restore on Esc.

set_cursor(x, y)
set_params(params)

Receive a dictionary and reset the slicer with values contained in the values of the dictionary.

Parameters:params – a dictionary containing name of slicer parameters and values the user assigned to the slicer.
thaw_axes()
update()

Respond to changes in the model by recalculating the profiles and resetting the widgets.

Table Of Contents

Previous topic

binder

Next topic

boxSlicer

This Page