PyMcaPlugins Package

PyMcaPlugins Package

PyMca5.PyMcaPlugins contains plugins associated to PyMca.

They import either from Plugin1DBase (for instances of classes respecting the Plot1DBase interface) or from StackPluginBase (for instances repecting the StackBase interface)

See PyMca5.PyMcaCore.Plugin1DBase for more information about 1D plugins and PyMca5.PyMcaCore.StackPluginBase for information about stack plugins.

AdvancedAlignmentScanPlugin Module

class PyMca5.PyMcaPlugins.AdvancedAlignmentScanPlugin.AdvancedAlignmentScanPlugin(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

applyShifts()[source]

Generic shift method. The method shifts curves according to the shift stored in self.shiftDict and executes the method stored in self.shiftMethod.

Curves are sorted with respect to their legend, the values of self.shiftDict are sorted with respect to their key.

calculateAndApplyShifts()[source]
calculateShifts()[source]

Generic alignment method, executes the method that is set under self.alignmentMethod.

Choices are: - calculateShiftsFit - calculateShiftsFFT - calculateShiftsMax

Sets self.shiftList and self.shiftDict

calculateShiftsFFT(portion=0.95)[source]
calculateShiftsFit(derivative=False, thr=30)[source]
calculateShiftsFitDerivative()[source]
calculateShiftsMax()[source]
fftShift(shift, x, y)[source]
findPeaks(x, y, thr, derivative)[source]
x,y : ndarrays
Arrays contain curve intformation
thr : float
Threshold in percent of normalized maximum
derivative : bool
The derivative of a curve is being fitted

Finds most prominent feature contained in y and tries to estimate starting parameters for a Gaussian least squares fit (LSF). Recommends values used to fit the Gaussian.

xpeak, ypeak, fwhm : float
Estimated values for x-position, amplitude and width of the Gaussian
fwhmIdx : ndarray
Indices determine the range on which the LSF is performed
getAllCurves(just_legend=False)[source]

Ensures that the x-range of the curves is strictly monotonically increasing. Conserves curves legend and info dictionary.

getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

getOrder()[source]

Returns the legends of the curves in the plot winow in the order they were added.

getXLimits(values, overlap=True)[source]
overlap : bool
True -> returns minimal and maximal x-values
that are that are still lie within the x-ranges of all curves in plot window
False -> returns minimal and maximal x-values of
all curves in plot window

xmin0, xmax0 : float

interpolate(factor=1.0)[source]
factor : float
factor used to oversample existing data, use with caution.

Interpolates all existing curves to an equidistant x-range using the either the active or the first curve do determine the number of data points. Use this method instead of self.getAllCurves() when performin FFT related tasks.

interpCurves : ndarray
Array containing the interpolated curves shown in the plot window. Format: [(x0, y0, legend0, info0), ...]
normalize(y)[source]

Normalizes spectrum to values between zero and one.

setAlignmentMethod(methodName)[source]

Method receives methodName from AlignmentWidget instance and assigns the according alignment method.

setShiftMethod(methodName)[source]

Method receives methodName from AlignmentWidget instance and assigns the according shift method.

showDocs()[source]

Displays QTextBrowser showing the documentation

showShifts()[source]

Creates an instance of Alignment Widget that allows to

  • Calculate, display & save/store shifts
  • Load existing shift data
  • Select different alignment and shift methods
xShift(shift, x, y)[source]
class PyMca5.PyMcaPlugins.AdvancedAlignmentScanPlugin.AlignmentWidget(parent, ddict, llist, plugin)[source]

Bases: PySide.QtGui.QDialog

getAlignmentMethodName()
getDict()
getShiftMethodName()
loadDict()
saveDict()
setDict(llist, ddict)
staticMetaObject = <PySide.QtCore.QMetaObject object>
store()
triggerCalculateShift(methodName=None)
validateInput(row, col)
PyMca5.PyMcaPlugins.AdvancedAlignmentScanPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

AlignmentScanPlugin Module

class PyMca5.PyMcaPlugins.AlignmentScanPlugin.AlignmentScanPlugin(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

fftAlignment()[source]
getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

PyMca5.PyMcaPlugins.AlignmentScanPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

BackgroundScanPlugin Module

BackgroundStackPlugin Module

CalculationThread Module

ConsolePlugin Module

ConsoleStackPlugin Module

ExternalImagesStackPlugin Module

FastXRFLinearFitStackPlugin Module

FitStackPlugin Module

class PyMca5.PyMcaPlugins.FitStackPlugin.FitStackPlugin(stackWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.StackPluginBase.StackPluginBase

applyMethod(name)[source]
fitStack()[source]
getMethodPixmap(name)[source]
getMethodToolTip(name)[source]
getMethods()[source]
selectionMaskUpdated()[source]
stackUpdated()[source]
PyMca5.PyMcaPlugins.FitStackPlugin.getStackPluginInstance(stackWindow, **kw)[source]

ImageAlignmentStackPlugin Module

MathPlugins Module

class PyMca5.PyMcaPlugins.MathPlugins.MathPlugins(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

derivate()[source]
getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

invert()[source]
PyMca5.PyMcaPlugins.MathPlugins.getPlugin1DInstance(plotWindow, **kw)[source]

MedianFilterScanDeglitchPlugin Module

class PyMca5.PyMcaPlugins.MedianFilterScanDeglitchPlugin.MedianFilterScanDeglitchPlugin(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

configureFilter()[source]
getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

medianThresholdFilter(activeOnly, threshold, length)[source]
removeSpikesActive()[source]
removeSpikesAll()[source]
PyMca5.PyMcaPlugins.MedianFilterScanDeglitchPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

MedianFilterScanPlugin Module

class PyMca5.PyMcaPlugins.MedianFilterScanPlugin.MedianFilterScanPlugin(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMedianFilter(width=3)[source]
applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

toggleRandomization()[source]
PyMca5.PyMcaPlugins.MedianFilterScanPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

MedianFilterStackPlugin Module

MotorInfoPlugin Module

class PyMca5.PyMcaPlugins.MotorInfoPlugin.MotorInfo(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]
getMethodPixmap(name)[source]
getMethodToolTip(name)[source]
getMethods(plottype=None)[source]
showMotorInfo()[source]
PyMca5.PyMcaPlugins.MotorInfoPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

MotorInfoWindow Module

class PyMca5.PyMcaPlugins.MotorInfoWindow.MotorInfoComboBox(parent, mlist, nCol)[source]

Bases: PySide.QtGui.QComboBox

currentMotor()
emitLoadColumnSignal()
loadColumnSignal = <PySide.QtCore.Signal object>
staticMetaObject = <PySide.QtCore.QMetaObject object>
updateMotorNamesList(newMotorNamesList)
class PyMca5.PyMcaPlugins.MotorInfoWindow.MotorInfoDialog(parent, legends, motorValues)[source]

Bases: PySide.QtGui.QWidget

keyPressEvent(event)[source]
staticMetaObject = <PySide.QtCore.QMetaObject object>
class PyMca5.PyMcaPlugins.MotorInfoWindow.MotorInfoHeader(parent)[source]

Bases: PySide.QtGui.QHeaderView

addLastSection()
deleteLastSection()
fixComboPositions()
handleSectionResized(index)
showEvent(event)
staticMetaObject = <PySide.QtCore.QMetaObject object>
xOffsetLeft = 5
xOffsetRight = -35
yOffset = -1
class PyMca5.PyMcaPlugins.MotorInfoWindow.MotorInfoTable(parent, numRows, numColumns, legList, motList)[source]

Bases: PySide.QtGui.QTableWidget

addColumn()[source]
delColumn()[source]
fillRow(currentRow)[source]
getAllMotorNames()[source]
loadColumn(ddict)[source]
scrollContentsBy(dx, dy)[source]
setItem(row, column, text='')[source]
staticMetaObject = <PySide.QtCore.QMetaObject object>
updateTable(legList, motList)[source]
PyMca5.PyMcaPlugins.MotorInfoWindow.main()[source]

MultipleScanToMeshPlugin Module

NNMAStackPlugin Module

NormalizationPlugins Module

class PyMca5.PyMcaPlugins.NormalizationPlugins.NormalizationPlugins(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

divideByActiveCurve()[source]
getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

offsetAndArea()[source]
offsetAndCounts()[source]
offsetAndMaximum()[source]
toMaximum()[source]
PyMca5.PyMcaPlugins.NormalizationPlugins.getPlugin1DInstance(plotWindow, **kw)[source]

PCAStackPlugin Module

Plugin1DBase Module

ROIStackPlugin Module

RegularMeshPlugin Module

ReverseStackPlugin Module

class PyMca5.PyMcaPlugins.ReverseStackPlugin.ReverseStackPlugin(stackWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.StackPluginBase.StackPluginBase

applyMethod(name)[source]
getMethodPixmap(name)[source]
getMethodToolTip(name)[source]
getMethods()[source]
reverseColumns(offset=1)[source]
reverseEvenColumns()[source]
reverseEvenRows()[source]
reverseOddColumns()[source]
reverseOddRows()[source]
reverseRows(offset=1)[source]
PyMca5.PyMcaPlugins.ReverseStackPlugin.getStackPluginInstance(stackWindow, **kw)[source]

StackAxesPlugin Module

class PyMca5.PyMcaPlugins.StackAxesPlugin.StackAxesPlugin(stackWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.StackPluginBase.StackPluginBase

applyMethod(name)[source]
getMethodPixmap(name)[source]
getMethodToolTip(name)[source]
getMethods()[source]
replace1DAxisWithASCII()[source]
replace1DAxisWithActiveCurveXValues()[source]
replace1DAxisWithActiveCurveYValues()[source]
PyMca5.PyMcaPlugins.StackAxesPlugin.getStackPluginInstance(stackWindow, **kw)[source]

StackBrowserPlugin Module

StackNormalizationPlugin Module

class PyMca5.PyMcaPlugins.StackNormalizationPlugin.StackNormalizationPlugin(stackWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.StackPluginBase.StackPluginBase

applyMethod(name)[source]
divideByCurve()[source]
getMethodPixmap(name)[source]
getMethodToolTip(name)[source]
getMethods()[source]
logNormalizeByCurve()[source]
PyMca5.PyMcaPlugins.StackNormalizationPlugin.getStackPluginInstance(stackWindow, **kw)[source]

StackPluginBase Module

StackScanWindowPlugin Module

XASScanNormalizationPlugin Module

class PyMca5.PyMcaPlugins.XASScanNormalizationPlugin.XASScanNormalizationPlugin(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

XASNormalize()[source]
applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

configure()[source]
getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

PyMca5.PyMcaPlugins.XASScanNormalizationPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

XASSelfattenuationPlugin Module

class PyMca5.PyMcaPlugins.XASSelfattenuationPlugin.XASSelfattenuationPlugin(plotWindow, **kw)[source]

Bases: PyMca5.PyMcaCore.Plugin1DBase.Plugin1DBase

applyMethod(name)[source]

The plugin is asked to apply the method associated to name.

configure()[source]
correctActive()[source]
correctAll()[source]
getMethodPixmap(name)[source]

Returns the pixmap associated to the particular method name or None.

getMethodToolTip(name)[source]

Returns the help associated to the particular method name or None.

getMethods(plottype=None)[source]

A list with the NAMES associated to the callable methods that are applicable to the specified plot.

Plot type can be “SCAN”, “MCA”, None, ...

PyMca5.PyMcaPlugins.XASSelfattenuationPlugin.getPlugin1DInstance(plotWindow, **kw)[source]

XASStackNormalizationPlugin Module

XMCDPlugin Module