boxSlicer

sans.guiframe.local_perspectives.plotting.boxSlicer

class sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor(base, axes, color='black', zorder=3)

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

BoxInteractor define a rectangle that return data1D average of Data2D in a rectangle area defined by -x, x ,y, -y

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_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)

Called after a dragging event. Post the slicer new parameters and creates a new Data1D corresponding to the new average

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)

post_data(new_slab=None, nbins=None, direction=None)

post data averaging in Qx or Qy given new_slab type

Parameters:

• new_slab – slicer that determine with direction to average
• nbins – the number of points plotted when averaging
• direction – the direction of averaging

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_layer(n)

Allow adding plot to the same panel

Parameters:n – the number of layer

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.

update_and_post()

Update the slicer and plot the resulting data

class sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX(base, axes, color='black', zorder=3)

Bases: sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor

Average in Qx direction

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_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)

Called after a dragging event. Post the slicer new parameters and creates a new Data1D corresponding to the new average

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)

post_data(new_slab=None, nbins=None, direction=None)

post data averaging in Qx or Qy given new_slab type

Parameters:

• new_slab – slicer that determine with direction to average
• nbins – the number of points plotted when averaging
• direction – the direction of averaging

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_layer(n)

Allow adding plot to the same panel

Parameters:n – the number of layer

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.

update_and_post()

Update the slicer and plot the resulting data

class sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY(base, axes, color='black', zorder=3)

Bases: sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor

Average in Qy direction

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_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)

Called after a dragging event. Post the slicer new parameters and creates a new Data1D corresponding to the new average

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)

post_data(new_slab=None, nbins=None, direction=None)

post data averaging in Qx or Qy given new_slab type

Parameters:

• new_slab – slicer that determine with direction to average
• nbins – the number of points plotted when averaging
• direction – the direction of averaging

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_layer(n)

Allow adding plot to the same panel

Parameters:n – the number of layer

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.

update_and_post()

Update the slicer and plot the resulting data

class sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines(base, axes, color='black', zorder=5, x=0.5, y=0.5)

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

Draw 2 Horizontal lines centered on (0,0) that can move on the x- direction and in opposite direction

clear()

Clear this slicer and its markers

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.

move(x, y, ev)

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

moveend(ev)

Called after a dragging this edge and set self.has_move to False to specify the end of dragging motion

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_layer(n)

Allow adding plot to the same panel

Parameters:n – the number of layer

update(x=None, y=None)

Draw the new roughness on the graph.

Parameters:

• x – x-coordinates to reset current class x
• y – y-coordinates to reset current class y

class sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines(base, axes, color='black', zorder=5, x=0.5, y=0.5)

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

Select an annulus through a 2D plot

clear()

Clear this slicer and its markers

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.

move(x, y, ev)

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

moveend(ev)

Called after a dragging this edge and set self.has_move to False to specify the end of dragging motion

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_layer(n)

Allow adding plot to the same panel

Parameters:n – the number of layer

update(x=None, y=None)

Draw the new roughness on the graph.

Parameters:

• x – x-coordinates to reset current class x
• y – y-coordinates to reset current class y