invariant

sans.perspectives.invariant.invariant

class sans.perspectives.invariant.invariant.Plugin(standalone=False)

This class defines the interface for invariant Plugin class that can be used by the gui_manager.

copy_data(item, dy=None)

receive a data 1D and the list of errors on dy and create a new data1D data

get_context_menu(graph=None)

This method is optional.

When the context menu of a plot is rendered, the get_context_menu method will be called to give you a chance to add a menu item to the context menu.

A ref to a Graph object is passed so that you can investigate the plot content and decide whether you need to add items to the context menu.

This method returns a list of menu items. Each item is itself a list defining the text to appear in the menu, a tool-tip help text, and a call-back method.

Parameters:

• graph – the Graph object to which we attach the context menu

Returns:

a list of menu items with call-back function

get_panels(parent)

Create and return the list of wx.Panels for your plug-in. Define the plug-in perspective.

Panels should inherit from DefaultPanel defined below, or should present the same interface. They must define “window_caption” and “window_name”.

Parameters:

• parent – parent window

Returns:

list of panels

get_perspective()

Get the list of panel names for this perspective

get_tools()

Returns a set of menu entries for tools

help(evt)

Show a general help dialog.

on_perspective(event)

Call back function for the perspective menu item. We notify the parent window that the perspective has changed.

Parameters:

• event – menu event

plot_data(scale, background)

replot the current data if the user enters a new scale or background

plot_theory(data=None, name=None)

Receive a data set and post a NewPlotEvent to parent.

Parameters:

• data – extrapolated data to be plotted
• name – Data’s name to use for the legend

populate_menu(id, parent)

Create and return the list of application menu items for the plug-in.

Parameters:

• id – deprecated. Un-used.
• parent – parent window

Returns:

plug-in menu

post_init()

Post initialization call back to close the loose ends

set_default_perspective()

Call back method that True to notify the parent that the current plug-in can be set as default perspective. when returning False, the plug-in is not candidate for an automatic default perspective setting