sas.qtgui.Plotting package

Submodules

sas.qtgui.Plotting.AddText module

sas.qtgui.Plotting.Arrow3D module

Module that draws multiple arrows in 3D coordinates

class sas.qtgui.Plotting.Arrow3D.Arrow3D(base, xs, ys, zs, colors, *args, **kwargs)[source]

Bases: matplotlib.patches.FancyArrowPatch

Draw 3D arrow

draw(renderer, rasterized=True)[source]

Drawing actually happens here

on_left_down(event)[source]

Mouse left-down event

on_left_up(event)[source]

Mouse left up event

sas.qtgui.Plotting.Binder module

Extension to MPL to support the binding of artists to key/mouse events.

class sas.qtgui.Plotting.Binder.BindArtist(figure)[source]

Bases: object

alt = False
clear(h1, h2, ...)[source]

Remove connections for artists h1, h2, …

Use clearall() to reset all connections.

clearall()[source]

Clear connections to all artists.

Use clear(h1,h2,…) to reset specific artists.

control = False
dclick_threshhold = 0.25
disconnect()[source]

In case we need to disconnect from the canvas…

events = ['enter', 'leave', 'motion', 'click', 'dclick', 'drag', 'release', 'scroll', 'key', 'keyup']
meta = False
shift = False
trigger(actor, action, ev)[source]

Trigger a particular event for the artist. Fallback to axes, to figure, and to ‘all’ if the event is not processed.

class sas.qtgui.Plotting.Binder.Selection(artist=None, prop={})[source]

Bases: object

Store and compare selections.

artist = None
prop = {}

sas.qtgui.Plotting.BoxSum module

sas.qtgui.Plotting.ColorMap module

sas.qtgui.Plotting.ConvertUnits module

Convert units to strings that can be displayed This is a cleaned up version of unitConverter.py

sas.qtgui.Plotting.ConvertUnits.convertUnit(power, unit)[source]

Convert units to strings that can be displayed

sas.qtgui.Plotting.DataTransform module

sas.qtgui.Plotting.DataTransform.errFromX2(x, y=None, dx=None, dy=None)[source]

calculate error of sqrt(x)

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errFromX4(x, y=None, dx=None, dy=None)[source]

calculate error of x^1/4

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errOneOverSqrtX(x, y=None, dx=None, dy=None)[source]

Calculate error on 1/sqrt(x)

sas.qtgui.Plotting.DataTransform.errOneOverX(x, y=None, dx=None, dy=None)[source]

calculate error on 1/x

sas.qtgui.Plotting.DataTransform.errToLog10X(x, y=None, dx=None, dy=None)[source]

calculate error of Log(x)

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errToLogX(x, y=None, dx=None, dy=None)[source]

calculate error of Log(x)

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errToLogXY(x, y, dx=None, dy=None)[source]

calculate error of Log(xy)

sas.qtgui.Plotting.DataTransform.errToLogYX2(y, x, dy=None, dx=None)[source]

calculate error of Log(yx**2)

sas.qtgui.Plotting.DataTransform.errToLogYX4(y, x, dy=None, dx=None)[source]

error for ln(y*x^(4))

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.errToX(x, y=None, dx=None, dy=None)[source]

calculate error of x**2

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errToX2(x, y=None, dx=None, dy=None)[source]

calculate error of x**2

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errToX4(x, y=None, dx=None, dy=None)[source]

calculate error of x**4

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errToX_pos(x, y=None, dx=None, dy=None)[source]

calculate error of x**2

Parameters:
  • x – float value
  • dx – float value
sas.qtgui.Plotting.DataTransform.errToYX2(y, x, dy=None, dx=None)[source]
sas.qtgui.Plotting.DataTransform.errToYX4(y, x, dy=None, dx=None)[source]

error for (y*x^(4))

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.fromX2(x, y=None)[source]

This function is used to load value on Plottable.View Calculate square root of x

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.fromX4(x, y=None)[source]

This function is used to load value on Plottable.View Calculate square root of x

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.toLogX(x, y=None)[source]

This function is used to load value on Plottable.View calculate log x

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.toLogXY(y, x)[source]

This function is used to load value on Plottable.View calculate log x

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.toLogYX2(y, x)[source]
sas.qtgui.Plotting.DataTransform.toLogYX4(y, x)[source]
sas.qtgui.Plotting.DataTransform.toOneOverSqrtX(y, x=None)[source]
sas.qtgui.Plotting.DataTransform.toOneOverX(x, y=None)[source]
sas.qtgui.Plotting.DataTransform.toX(x, y=None)[source]

This function is used to load value on Plottable.View

Parameters:x – Float value
Returns:x
sas.qtgui.Plotting.DataTransform.toX2(x, y=None)[source]

This function is used to load value on Plottable.View

Calculate x^(2)

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.toX4(x, y=None)[source]

This function is used to load value on Plottable.View

Calculate x^(4)

Parameters:x – float value
sas.qtgui.Plotting.DataTransform.toX_pos(x, y=None)[source]

This function is used to load value on Plottable.View

Parameters:x – Float value
Returns:x
sas.qtgui.Plotting.DataTransform.toYX2(y, x)[source]
sas.qtgui.Plotting.DataTransform.toYX4(y, x)[source]

sas.qtgui.Plotting.Fittings module

This module is used to fit a set of x,y data to a model passed to it. It is used to calculate the slope and intercepts for the linearized fits. Two things should be noted:

First, this fitting module uses the NLLSQ module of SciPy rather than a linear fit. This along with a few other modules could probably be removed if we move to a linear regression approach.

Second, this infrastructure does not allow for resolution smearing of the the models. Hence the results are not that accurate even for pinhole collimation of SANS but may be good for SAXS. It is completely wrong for slit smeared data.

class sas.qtgui.Plotting.Fittings.Parameter(model, name, value=None)[source]

Bases: object

Class to handle model parameters - sets the parameters and their initial value from the model based to it.

set(value)[source]

Set the value of the parameter

sas.qtgui.Plotting.Fittings.calcCommandline(event)[source]
sas.qtgui.Plotting.Fittings.sasfit(model, pars, x, y, err_y, qmin=None, qmax=None)[source]

Fit function

Parameters:
  • model – sas model object
  • pars – list of parameters
  • x – vector of x data
  • y – vector of y data
  • err_y – vector of y errors

sas.qtgui.Plotting.LineModel module

Provide Line function (y= Ax + B). Until July 10, 2016 this function provided (y= A + Bx). This however was contrary to all the other code using it which assumed (y= mx+b) or in this nomenclature (y=Ax + B). This lead to some contortions in the code and worse incorrect calculations until now for at least some of the functions. This seemed the easiest to fix particularly since this function should disappear in a future iteration (see notes in fitDialog)

-PDB July 10, 2016
class sas.qtgui.Plotting.LineModel.LineModel[source]

Bases: object

Class that evaluates a linear model.

\(f(x) = Ax + B\)

List of default parameters: A = 1.0 B = 1.0

getParam(name)[source]

Return parameter value

run(x=0.0)[source]

Evaluate the model

Parameters:x – simple value
Returns:(Line value)

Note

This is the function called by fitDialog to calculate the the y(xmin) and y(xmax), but the only difference between this and runXY is when the if statement is true. I however cannot see what that function is for. It needs to be documented here or removed. -PDB 7/10/16

runXY(x=0.0)[source]

Evaluate the model.

Parameters:x – simple value
Returns:Line value
..note::
This is to be what is called by fitDialog for the actual fit but the only difference between this and run is when the if statement is true. I however cannot see what that function is for. It needs to be documented here or removed. -PDB 7/10/16
setParam(name, value)[source]

Set parameter value

sas.qtgui.Plotting.LinearFit module

sas.qtgui.Plotting.MaskEditor module

sas.qtgui.Plotting.PlotHelper module

Singleton plot helper module All its variables are bound to the module, which can not be instantiated repeatedly so IDs are session-specific.

sas.qtgui.Plotting.PlotHelper.addPlot(plot)[source]

Adds a new plot to the current dictionary of plots

sas.qtgui.Plotting.PlotHelper.clear()[source]

Reset the plot dictionary

sas.qtgui.Plotting.PlotHelper.currentPlots()[source]

Returns a list of IDs for all currently active plots

sas.qtgui.Plotting.PlotHelper.deletePlot(plot_id)[source]

Deletes an existing plot from the dictionary

sas.qtgui.Plotting.PlotHelper.idOfPlot(plot)[source]

Returns the ID of the plot

sas.qtgui.Plotting.PlotHelper.plotById(plot_id)[source]

Returns the plot referenced by the ID

sas.qtgui.Plotting.PlotProperties module

sas.qtgui.Plotting.PlotUtilities module

sas.qtgui.Plotting.PlotUtilities.build_matrix(data, qx_data, qy_data)[source]

Build a matrix for 2d plot from a vector Returns a matrix (image) with ~ square binning Requirement: need 1d array formats of data, qx_data, and qy_data where each one corresponds to z, x, or y axis values

sas.qtgui.Plotting.PlotUtilities.fillupPixels(image=None, weights=None)[source]

Fill z values of the empty cells of 2d image matrix with the average over up-to next nearest neighbor points

Parameters:image – (2d matrix with some zi = None)
Returns:image (2d array )
TODO:Find better way to do for-loop below
sas.qtgui.Plotting.PlotUtilities.getValidColor(color)[source]

Returns a valid matplotlib color

sas.qtgui.Plotting.PlotUtilities.get_bins(qx_data, qy_data)[source]

get bins return x_bins and y_bins: 1d arrays of the index with ~ square binning Requirement: need 1d array formats of qx_data, and qy_data where each one corresponds to x, or y axis values

sas.qtgui.Plotting.PlotUtilities.rescale(lo, hi, step, pt=None, bal=None, scale='linear')[source]

Rescale (lo,hi) by step, returning the new (lo,hi) The scaling is centered on pt, with positive values of step driving lo/hi away from pt and negative values pulling them in. If bal is given instead of point, it is already in [0,1] coordinates.

This is a helper function for step-based zooming.

sas.qtgui.Plotting.Plottables module

Prototype plottable object support.

The main point of this prototype is to provide a clean separation between the style (plotter details: color, grids, widgets, etc.) and substance (application details: which information to plot). Programmers should not be dictating line colours and plotting symbols.

Unlike the problem of style in CSS or Word, where most paragraphs look the same, each line on a graph has to be distinguishable from its neighbours. Our solution is to provide parametric styles, in which a number of different classes of object (e.g., reflectometry data, reflectometry theory) representing multiple graph primitives cycle through a colour palette provided by the underlying plotter.

A full treatment would provide perceptual dimensions of prominence and distinctiveness rather than a simple colour number.

class sas.qtgui.Plotting.Plottables.Chisq(chisq=None)[source]

Bases: sas.qtgui.Plotting.Plottables.Plottable

Chisq plottable plots the chisq

render(plot, **kw)[source]
setChisq(chisq)[source]

Set the chisq value.

class sas.qtgui.Plotting.Plottables.Graph(**kw)[source]

Bases: object

Generic plottables graph structure.

Plot styles are based on color/symbol lists. The user gets to select the list of colors/symbols/sizes to choose from, not the application developer. The programmer only gets to add/remove lines from the plot and move to the next symbol/color.

Another dimension is prominence, which refers to line sizes/point sizes.

Axis transformations allow the user to select the coordinate view which provides clarity to the data. There is no way we can provide every possible transformation for every application generically, so the plottable objects themselves will need to provide the transformations. Here are some examples from reflectometry:

independent: x -> f(x)
   monitor scaling: y -> M*y
   log:  y -> log(y if y > min else min)
   cos:  y -> cos(y*pi/180)
dependent:   x -> f(x,y)
   Q4:      y -> y*x^4
   fresnel: y -> y*fresnel(x)
coordinated: x,y = f(x,y)
   Q:    x -> 2*pi/L (cos(x*pi/180) - cos(y*pi/180))
         y -> 2*pi/L (sin(x*pi/180) + sin(y*pi/180))
reducing: x,y = f(x1,x2,y1,y2)
   spin asymmetry: x -> x1, y -> (y1 - y2)/(y1 + y2)
   vector net: x -> x1, y -> y1*cos(y2*pi/180)

Multiple transformations are possible, such as Q4 spin asymmetry

Axes have further complications in that the units of what are being plotted should correspond to the units on the axes. Plotting multiple types on the same graph should be handled gracefully, e.g., by creating a separate tab for each available axis type, breaking into subplots, showing multiple axes on the same plot, or generating inset plots. Ultimately the decision should be left to the user.

Graph properties such as grids/crosshairs should be under user control, as should the sizes of items such as axis fonts, etc. No direct access will be provided to the application.

Axis limits are mostly under user control. If the user has zoomed or panned then those limits are preserved even if new data is plotted. The exception is when, e.g., scanning through a set of related lines in which the user may want to fix the limits so that user can compare the values directly. Another exception is when creating multiple graphs sharing the same limits, though this case may be important enough that it is handled by the graph widget itself. Axis limits will of course have to understand the effects of axis transformations.

High level plottable objects may be composed of low level primitives. Operations such as legend/hide/show copy/paste, etc. need to operate on these primitives as a group. E.g., allowing the user to have a working canvas where they can drag lines they want to save and annotate them.

Graphs need to be printable. A page layout program for entire plots would be nice.

add(plottable, color=None)[source]

Add a new plottable to the graph

changed()[source]

Detect if any graphed plottables have changed

delete(plottable)[source]

Remove an existing plottable from the graph

get(key)[source]

Get the graph properties

get_plottable(name)[source]

Return the plottable with the given name if it exists. Otherwise return None

get_range()[source]

Return the range of all displayed plottables

isPlotted(plottable)[source]

Return True is the plottable is already on the graph

render(plot)[source]

Redraw the graph

replace(plottable)[source]

Replace an existing plottable from the graph

reset()[source]

Reset the graph.

reset_scale()[source]

Resets the scale transformation data to the underlying data

returnPlottable()[source]

This method returns a dictionary of plottables contained in graph It is just by Plotpanel to interact with the complete list of plottables inside the graph.

set(**kw)[source]

Set the graph properties

title(name)[source]

Graph title

xaxis(name, units)[source]

Properties of the x axis.

yaxis(name, units)[source]

Properties of the y axis.

class sas.qtgui.Plotting.Plottables.Plottable[source]

Bases: object

check_data_PlottableX()[source]

Since no transformation is made for log10(x), check that no negative values is plot in log scale

check_data_PlottableY()[source]

Since no transformation is made for log10(y), check that no negative values is plot in log scale

colors()[source]

Return the number of colors need to render the object

custom_color = None
dx = None
dy = None
get_xaxis()[source]

Return the units and name of x-axis

get_yaxis()[source]

Return the units and name of y- axis

hidden = False
interactive = True
is_empty()[source]

Returns True if there is no data stored in the plottable

classmethod labels(collection)[source]

Construct a set of unique labels for a collection of plottables of the same type.

Returns a map from plottable to name.

markersize = 3
name = None
onFitRange(xmin=None, xmax=None)[source]

It limits View data range to plot from min to max

Parameters:
  • xmin – the minimum value of x to plot.
  • xmax – the maximum value of x to plot
onReset()[source]

Reset x, y, dx, dy view with its parameters

render(plot)[source]

The base class makes sure the correct units are being used for subsequent plottable.

For now it is assumed that the graphs are commensurate, and if you put a Qx object on a Temperature graph then you had better hope that it makes sense.

reset_view()[source]

Reload view with new value to plot

returnValuesOfView()[source]

Return View parameters and it is used by Fit Dialog

setLabel(labelx, labely)[source]

It takes a label of the x and y transformation and set View parameters

Parameters:
  • transx – The label of x transformation is sent by Properties Dialog
  • transy – The label of y transformation is sent Properties Dialog
set_View(x, y)[source]

Load View

set_data(x, y, dx=None, dy=None)[source]
short_name = None
transformView()[source]

It transforms x, y before displaying

transformX(transx, transdx)[source]

Receive pointers to function that transform x and dx and set corresponding View pointers

Parameters:
  • transx – pointer to function that transforms x
  • transdx – pointer to function that transforms dx
transformY(transy, transdy)[source]

Receive pointers to function that transform y and dy and set corresponding View pointers

Parameters:
  • transy – pointer to function that transforms y
  • transdy – pointer to function that transforms dy
x = None
xaxis(name, units)[source]

Set the name and unit of x_axis

Parameters:
  • name – the name of x-axis
  • units – the units of x_axis
y = None
yaxis(name, units)[source]

Set the name and unit of y_axis

Parameters:
  • name – the name of y-axis
  • units – the units of y_axis
class sas.qtgui.Plotting.Plottables.PlottableData1D(x, y, dx=None, dy=None)[source]

Bases: sas.qtgui.Plotting.Plottables.Plottable

Data plottable: scatter plot of x,y with errors in x and y.

changed()[source]
classmethod labels(collection)[source]

Build a label mostly unique within a collection

render(plot, **kw)[source]

Renders the plottable on the graph

class sas.qtgui.Plotting.Plottables.PlottableData2D(image=None, qx_data=None, qy_data=None, err_image=None, xmin=None, xmax=None, ymin=None, ymax=None, zmin=None, zmax=None)[source]

Bases: sas.qtgui.Plotting.Plottables.Plottable

2D data class for image plotting

changed()[source]
classmethod labels(collection)[source]

Build a label mostly unique within a collection

render(plot, **kw)[source]

Renders the plottable on the graph

setValues(datainfo=None)[source]

Use datainfo object to initialize data2D

Parameters:datainfo – object
set_zrange(zmin=None, zmax=None)[source]
xaxis(label, unit)[source]

set x-axis

Parameters:
  • label – x-axis label
  • unit – x-axis unit
yaxis(label, unit)[source]

set y-axis

Parameters:
  • label – y-axis label
  • unit – y-axis unit
zaxis(label, unit)[source]

set z-axis

Parameters:
  • label – z-axis label
  • unit – z-axis unit
class sas.qtgui.Plotting.Plottables.PlottableFit1D(data=None, theory=None)[source]

Bases: sas.qtgui.Plotting.Plottables.Plottable

Fit plottable: composed of a data line plus a theory line. This is treated like a single object from the perspective of the graph, except that it will have two legend entries, one for the data and one for the theory.

The color of the data and theory will be shared.

changed()[source]
render(plot, **kw)[source]
class sas.qtgui.Plotting.Plottables.PlottableTheory1D(x, y, dy=None)[source]

Bases: sas.qtgui.Plotting.Plottables.Plottable

Theory plottable: line plot of x,y with confidence interval y.

class sas.qtgui.Plotting.Plottables.Text(text=None, xpos=0.5, ypos=0.9, name='text')[source]

Bases: sas.qtgui.Plotting.Plottables.Plottable

getText(text)[source]

Get the text string.

render(plot, **kw)[source]
setText(text)[source]

Set the text string.

set_x(x)[source]

Set the x position of the text ACCEPTS: float

set_y(y)[source]

Set the y position of the text ACCEPTS: float

class sas.qtgui.Plotting.Plottables.Transform[source]

Bases: object

Define a transform plugin to the plottable architecture.

Transforms operate on axes. The plottable defines the set of transforms available for it, and the axes on which they operate. These transforms can operate on the x axis only, the y axis only or on the x and y axes together.

This infrastructure is not able to support transformations such as log and polar plots as these require full control over the drawing of axes and grids.

A transform has a number of attributes.

name
user visible name for the transform. This will appear in the context menu for the axis and the transform menu for the graph.
type
operational axis. This determines whether the transform should appear on x,y or z axis context menus, or if it should appear in the context menu for the graph.
inventory
(not implemented) a dictionary of user settable parameter names and their associated types. These should appear as keyword arguments to the transform call. For example, Fresnel reflectivity requires the substrate density: { 'rho': type.Value(10e-6/units.angstrom**2) } Supply reasonable defaults in the callback so that limited plotting clients work even though they cannot set the inventory.
class sas.qtgui.Plotting.Plottables.View(x=None, y=None, dx=None, dy=None)[source]

Bases: object

Representation of the data that might include a transformation

check_data_logX()[source]

Remove negative value in x vector to avoid plotting negative value of Log10

check_data_logY()[source]

Remove negative value in y vector to avoid plotting negative value of Log10

dx = None
dy = None
onFitRangeView(xmin=None, xmax=None)[source]

It limits View data range to plot from min to max

Parameters:
  • xmin – the minimum value of x to plot.
  • xmax – the maximum value of x to plot
onResetView()[source]

Reset x,y,dx and y in their full range and in the initial scale in case their previous range has changed

returnXview()[source]

Return View x,y,dx,dy

setTransformX(funcx, funcdx)[source]

Receive pointers to function that transform x and dx and set corresponding View pointers

Parameters:
  • transx – pointer to function that transforms x
  • transdx – pointer to function that transforms dx
setTransformY(funcy, funcdy)[source]

Receive pointers to function that transform y and dy and set corresponding View pointers

Parameters:
  • transx – pointer to function that transforms y
  • transdx – pointer to function that transforms dy
transform(x=None, y=None, dx=None, dy=None)[source]
Transforms the x,y,dx and dy vectors and stores
the output in View parameters
Parameters:
  • x – array of x values
  • y – array of y values
  • dx – array of errors values on x
  • dy – array of error values on y
x = None
y = None
sas.qtgui.Plotting.Plottables.all(L)[source]
sas.qtgui.Plotting.Plottables.any(L)[source]

sas.qtgui.Plotting.Plotter module

sas.qtgui.Plotting.Plotter2D module

sas.qtgui.Plotting.PlotterBase module

sas.qtgui.Plotting.PlotterData module

Adapters for fitting module

class sas.qtgui.Plotting.PlotterData.Data1D(x=None, y=None, dx=None, dy=None)[source]

Bases: sas.qtgui.Plotting.Plottables.PlottableData1D, sas.sascalc.dataloader.data_info.Data1D

ROLE_DATA = 0
ROLE_DEFAULT = 1
ROLE_DELETABLE = 2
ROLE_RESIDUAL = 3
copy_from_datainfo(data1d)[source]

copy values of Data1D of type DataLaoder.Data_info

class sas.qtgui.Plotting.PlotterData.Data2D(image=None, err_image=None, qx_data=None, qy_data=None, q_data=None, mask=None, dqx_data=None, dqy_data=None, xmin=None, xmax=None, ymin=None, ymax=None, zmin=None, zmax=None)[source]

Bases: sas.qtgui.Plotting.Plottables.PlottableData2D, sas.sascalc.dataloader.data_info.Data2D

copy_from_datainfo(data2d)[source]

copy value of Data2D of type DataLoader.data_info

sas.qtgui.Plotting.PlotterData.check_data_validity(data)[source]

Return True is data is valid enough to compute chisqr, else False

sas.qtgui.Plotting.ScaleProperties module

sas.qtgui.Plotting.SetGraphRange module

sas.qtgui.Plotting.SlicerModel module

class sas.qtgui.Plotting.SlicerModel.SlicerModel[source]

Bases: object

getParams()[source]

pure virtual

model()[source]

getter for the model

setModelFromParams()[source]

Set up the Qt model for data handling between controls

setParams()[source]

pure virtual

setParamsFromModel()[source]

Set up the params dictionary based on the current model content.

setParamsFromModelItem(item)[source]

Set up the params dictionary for the parameter in item.

validate()[source]

pure virtual

sas.qtgui.Plotting.SlicerParameters module

sas.qtgui.Plotting.WindowTitle module

sas.qtgui.Plotting.rangeSlider module

Module contents