lavuelib package¶
Submodules¶
lavuelib.axesDialog module¶
detector axis widget
lavuelib.bkgSubtractionWidget module¶
background subtraction widget
-
class
lavuelib.bkgSubtractionWidget.
BkgSubtractionWidget
(parent=None, settings=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Define bkg image and subtract from displayed image.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings
-
applyStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply state change signal
-
bkgFileSelected
¶ (
pyqtgraph.QtCore.pyqtSignal
) bkg file selected signal
-
bkgScalingFactor
()[source]¶ provides background scaling factor
Returns: background scaling factor Return type: float
-
bkgScalingFactorChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) bkg scaling factor change signal
-
checkBkgSubtraction
(state)[source]¶ unchecks apply CheckBox if state is 1 and it is checked and reset the display
Parameters: state ( int
) – checkbox state
-
setBkgScalingFactor
(scale)[source]¶ sets the background scaling factor
Parameters: scale ( float
orstr
) – background scaling factor
-
useCurrentImageAsBkg
¶ (
pyqtgraph.QtCore.pyqtSignal
) use current image signal
- parent (
lavuelib.channelGroupBox module¶
level widget
-
class
lavuelib.channelGroupBox.
ChannelGroupBox
(parent=None, settings=None, expertmode=False)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Set minimum and maximum displayed values and its color.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings - expertmode (
bool
) – expert mode flag
-
changeView
(showlevels=None)[source]¶ shows or hides the histogram widget
Parameters: showlevels ( bool
) – if levels should be shown
-
channelChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) color channel changed signal
-
channelLabels
()[source]¶ provides channel labels
Returns: list of channel labels Return type: list
<str
>
-
rgbChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) rgb color channel changed signal
-
setChannelItemText
(iid, text)[source]¶ sets channel item text
Parameters: - iid (
str
) – label id - iid – label text
- iid (
-
setDefaultColorChannel
(channel)[source]¶ sets default color channel
Parameters: channel ( int
orint
) – default color channel(s)
-
setNumberOfChannels
(number)[source]¶ sets maximum number of color channel
Parameters: number ( int
) – number of color channel
-
showGradient
(status=True)[source]¶ resets color channel
Parameters: status ( bool
) – show gradient flag
- parent (
lavuelib.commandThread module¶
command thread
-
class
lavuelib.commandThread.
CommandThread
(instance, commands, parent)[source]¶ Bases:
lavuelib.omniQThread.OmniQThread
thread which executes a list of commands
thread contructor
Parameters: -
finished
¶ (
pyqtgraph.QtCore.pyqtSignal
) finished signal
-
-
lavuelib.commandThread.
logger
= <Logger lavuelib.commandThread (WARNING)>¶ (
logging.Logger
) logger object
lavuelib.configDialog module¶
configuration widget
-
class
lavuelib.configDialog.
ConfigDialog
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QDialog
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.configDialog.
TableWidgetDragCheckBoxes
(parent)[source]¶ Bases:
PyQt5.QtWidgets.QTableWidget
TableWidget with drag and drop checkboxes
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
lavuelib.controllerClient module¶
tango lavue controller client
-
class
lavuelib.controllerClient.
ControllerClient
(device)[source]¶ Bases:
PyQt5.QtCore.QObject
lavue controller client
constructor
Parameters: device ( str
) – tango device name-
beamCenterXChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) beam Center X changed signal
-
beamCenterYChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) beam Center Y changed signal
-
detectorDistanceChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) detector distance changed signal
-
detectorROIsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) detector ROIs changed signal
-
energyChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) energy changed signal
-
lavueStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) lavueState changed signal
-
pixelSizeXChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) pixel Size X changed signal
-
pixelSizeYChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) pixel Size Y changed signal
-
lavuelib.dataFetchThread module¶
data fetch thread
-
class
lavuelib.dataFetchThread.
DataFetchThread
(datasource, alist, tid=0)[source]¶ Bases:
lavuelib.omniQThread.OmniQThread
constructor
Parameters: - datasource (
lavuelib.imageSource.BaseSource
) – image source - alist (
ExchangeList
) – exchange object
-
isFetching
()[source]¶ is datasource source connected
Returns: if datasource source connected Return type: bool
-
newDataNameFetched
¶ (
pyqtgraph.QtCore.pyqtSignal
) new data name signal
-
setDataSource
(datasource)[source]¶ sets datasource :param datasource: datasource object :type datasource:
lavuelib.imageSource.BaseSource
- datasource (
-
class
lavuelib.dataFetchThread.
ExchangeList
[source]¶ Bases:
object
subclass for data caching
constructor
-
addData
(name, data, metadata='')[source]¶ write data into exchange object
Parameters: - name (
str
) – image name - data (
numpy.ndarray
) – image data - metadata (
str
) – json dictionary with image metadata
- name (
-
lavuelib.diffRangeDialog module¶
detector range widget
lavuelib.displayExtensions module¶
image display widget
-
class
lavuelib.displayExtensions.
BaseMarkExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
base mark extension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.displayExtensions.
CenterExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.displayExtensions.
CutExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
cutCoords
()[source]¶ provides cuts coordinates
Returns: cuts coordinates Return type: list
< [float
,float
,float
,float
] >
-
cutCoordsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) cut coordinate changed signal
-
cutData
(cid=None)[source]¶ provides the current cut data
Parameters: cid ( int
) – cut idReturns: current cut data Return type: numpy.ndarray
-
-
class
lavuelib.displayExtensions.
DisplayExtension
(parent=None)[source]¶ Bases:
PyQt5.QtCore.QObject
display extension for ImageDisplayWidget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
setRefreshTime
(refreshtime)[source]¶ sets refresh time
Parameters: refreshtime ( float
) – refresh time in seconds
-
-
class
lavuelib.displayExtensions.
HandleWithSignals
(pos, center, parent)[source]¶ Bases:
pyqtgraph.graphicsItems.ROI.Handle
handle with signals
constructor
Parameters: - pos ([float, float]) – position of handle
- center ([float, float]) – center of handle
- parent (
pyqtgraph.graphicsItems.ROI.ROI
) – roi object
-
hovered
¶ (
pyqtgraph.QtCore.pyqtSignal
) hover event emitted
-
class
lavuelib.displayExtensions.
LockerExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.displayExtensions.
MarkExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.BaseMarkExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.displayExtensions.
MaximaExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.displayExtensions.
MeshExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
roiCoords
()[source]¶ provides rois coordinates
Returns: rois coordinates Return type: list
< [float
,float
,float
,float
] >
-
roiCoordsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi coordinate changed signal
-
-
class
lavuelib.displayExtensions.
ROIExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
calcROIsum
()[source]¶ calculates the current roi sum
Returns: sum roi value, roi id Return type: (float, int)
-
calcROIsums
()[source]¶ calculates all roi sums
Returns: sum roi value, roi id Return type: :obj:list < float >
-
roiCoords
()[source]¶ provides rois coordinates
Returns: rois coordinates Return type: list
< [float
,float
,float
,float
] >
-
roiCoordsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi coordinate changed signal
-
setColors
(colors=None)[source]¶ sets colors
Parameters: colors ( str
) – json list of roi colorsReturns: change status Return type: bool
-
-
class
lavuelib.displayExtensions.
RegionItem
(points=None, pen='w', **args)[source]¶ Bases:
pyqtgraph.graphicsItems.IsocurveItem.IsocurveItem
constructor
Parameters:
-
class
lavuelib.displayExtensions.
RegionsExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
isRegionEnabled
()[source]¶ provides flag regions enabled
Returns: region enabled flag Return type: bool
-
regionPoints
()[source]¶ provides region coordinates
Returns: region coordinates Return type: list
<list
<list
< (float
,float
) > > >
-
regionPointsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) region points changed signal
-
setColors
(colors=None)[source]¶ sets colors
Parameters: colors ( str
) – json list of roi colorsReturns: change status Return type: bool
-
-
class
lavuelib.displayExtensions.
SimpleLineROI
(pos1, pos2, width=1e-05, **args)[source]¶ Bases:
pyqtgraph.graphicsItems.ROI.LineROI
simple line roi
constructor
Parameters:
-
class
lavuelib.displayExtensions.
TrackingExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.BaseMarkExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
-
class
lavuelib.displayExtensions.
VHBoundsExtension
(parent=None)[source]¶ Bases:
lavuelib.displayExtensions.DisplayExtension
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
show
(parameters)[source]¶ set subwidget properties
Parameters: parameters ( lavuelib.toolWidget.ToolParameters
) – tool parameters
-
lavuelib.edDictDialog module¶
editable list dialog
-
class
lavuelib.edDictDialog.
EdDictDialog
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QDialog
editable list dialog
constructor
Parameters: parent ( QtCore.QObject
) – parent object
-
lavuelib.edDictDialog.
logger
= <Logger lavue (WARNING)>¶ (
logging.Logger
) logger object
lavuelib.edListDialog module¶
editable list dialog
-
class
lavuelib.edListDialog.
EdListDialog
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QDialog
editable list dialog
constructor
Parameters: parent ( QtCore.QObject
) – parent object
-
lavuelib.edListDialog.
logger
= <Logger lavue (WARNING)>¶ (
logging.Logger
) logger object
lavuelib.filewriter module¶
Provides abstraction for file writer
-
class
lavuelib.filewriter.
FTAttribute
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
virtual file tree attribute
constructor
Parameters:
-
class
lavuelib.filewriter.
FTAttributeManager
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
file tree attribute
constructor
Parameters:
-
class
lavuelib.filewriter.
FTDataFilter
(h5object=None, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
file tree data filter
constructor
Parameters:
-
class
lavuelib.filewriter.
FTDeflate
(h5object=None, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTDataFilter
constructor
Parameters:
-
class
lavuelib.filewriter.
FTField
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
file writer field
constructor
Parameters: -
attributes
¶ return the attribute manager
Returns: attribute manager Return type: FTAttributeManager
-
-
class
lavuelib.filewriter.
FTFile
(h5object, filename)[source]¶ Bases:
lavuelib.filewriter.FTObject
file tree file
constructor
Parameters: -
default_field
()[source]¶ field pointed by default attributes
Returns: field pointed by default attributes Return type: FTField
-
-
class
lavuelib.filewriter.
FTGroup
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
file tree group
constructor
Parameters: -
attributes
¶ return the attribute manager
Returns: attribute manager Return type: FTAttributeManager
-
create_field
(name, type_code, shape=None, chunk=None, dfilter=None)[source]¶ open a file tree element
Parameters: Returns: file tree field
Return type:
-
create_group
(n, nxclass='')[source]¶ open a file tree element
Parameters: Returns: file tree group
Return type:
-
create_virtual_field
(name, layout, fillvalue=None)[source]¶ creates a virtual filed tres element
Parameters:
-
exists
(name)[source]¶ if child exists
Parameters: name ( str
) – child nameReturns: existing flag Return type: bool
-
open
(name)[source]¶ open a file tree element
Parameters: name ( str
) – element nameReturns: file tree object Return type: FTObject
-
-
class
lavuelib.filewriter.
FTHyperslab
(offset=None, block=None, count=None, stride=None)[source]¶ Bases:
object
hyperslab class
constructor
Parameters:
-
class
lavuelib.filewriter.
FTLink
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
file tree link
constructor
Parameters:
-
class
lavuelib.filewriter.
FTObject
(h5object, tparent=None)[source]¶ Bases:
object
virtual file tree object
constructor
Parameters:
-
class
lavuelib.filewriter.
FTTargetFieldView
(h5object=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
target field view for VDS
constructor
Parameters: h5object ( any
) – h5 object
-
class
lavuelib.filewriter.
FTVirtualFieldLayout
(h5object=None)[source]¶ Bases:
lavuelib.filewriter.FTObject
virtual field layout
constructor
Parameters: h5object ( any
) – h5 object-
add
(key, source, sourcekey=None)[source]¶ add target field to layout
Parameters: - key (
tuple
) – slide or selection - source (
FTTargetFieldView
) – target field - sourcekey (
tuple
) – slide or selection
- key (
-
-
lavuelib.filewriter.
create_file
(filename, overwrite=False, **pars)[source]¶ create a new file
Parameters: Returns: file object
Return type:
-
lavuelib.filewriter.
data_filter
(parent=None)[source]¶ create deflate filter
Parameters: parent ( FTObject
) – parent objectReturns: deflate filter object Return type: FTDeflate
-
lavuelib.filewriter.
deflate_filter
(parent=None)¶ create deflate filter
Parameters: parent ( FTObject
) – parent objectReturns: deflate filter object Return type: FTDeflate
-
lavuelib.filewriter.
first
(array)[source]¶ get first element if the only
Parameters: array ( any
) – numpy arrayReturns: first element of the array
-
lavuelib.filewriter.
get_links
(parent)[source]¶ get links
Parameters: parent ( FTObject
) – parent objectReturns: list of link objects Return type: obj: list < FTLink
>
-
lavuelib.filewriter.
link
(target, parent, name)[source]¶ create link
Parameters: Returns: link object
Return type:
-
lavuelib.filewriter.
load_file
(membuffer, filename=None, readonly=False, **pars)[source]¶ load a file from memory byte buffer
Parameters: Returns: file objects
Return type: H5PYFile
orH5CppFile
-
lavuelib.filewriter.
open_file
(filename, readonly=False, **pars)[source]¶ open the new file
Parameters: Returns: file object
Return type:
-
lavuelib.filewriter.
setwriter
(wr)[source]¶ sets writer
Parameters: wr ( H5PYWriter
orH5CppWriter
) – writer module
-
lavuelib.filewriter.
target_field_view
(filename, fieldpath, shape, dtype=None, maxshape=None, parent=None)[source]¶ create target field view for VDS
Parameters: Returns: target field object
Return type:
-
lavuelib.filewriter.
unlimited
(parent=None)[source]¶ return dataspace UNLIMITED variable for the current writer module
Parameters: parent ( FTObject
) – parent objectReturns: dataspace UNLIMITED variable Return type: h5cpp.dataspace.UNLIMITED
orh5py.UNLIMITED
-
lavuelib.filewriter.
virtual_field_layout
(shape, dtype, maxshape=None, parent=None)[source]¶ creates a virtual field layout for a VDS file
Parameters: Returns: virtual layout
Return type:
-
lavuelib.filewriter.
writerlock
= <unlocked _thread.lock object>¶ (
threading.Lock
) writer module
lavuelib.filters module¶
set of image sources
-
class
lavuelib.filters.
BaseFilter
(configuration=None)[source]¶ Bases:
object
filter base class
constructor
Parameters: name – image name
-
class
lavuelib.filters.
FilterList
(configlist=None)[source]¶ Bases:
list
Filter list
constructor
Parameters: configlist (: list
< [str
,str
] >) – list with filter configuration
lavuelib.filtersGroupBox module¶
filter widget
-
class
lavuelib.filtersGroupBox.
FiltersGroupBox
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Select how an image should be transformed.
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
changeView
(showfilters=None)[source]¶ show or hide widgets
Parameters: showfilters ( bool
) – filter widget shown
-
filtersChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) filter changed signal
-
lavuelib.geometryDialog module¶
detector geometry widget
lavuelib.gradientDialog module¶
gradient dialog
lavuelib.h5cppwriter¶
Provides h5cpp file writer
-
class
lavuelib.h5cppwriter.
H5CppAttribute
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTAttribute
file tree attribute
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppAttributeManager
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTAttributeManager
file tree attribute
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppDataFilter
(h5object=None, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTDataFilter
file tree deflate
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppDeflate
(h5object=None, tparent=None)[source]¶ Bases:
lavuelib.h5cppwriter.H5CppDataFilter
deflate filter
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppField
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTField
file tree file
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
-
attributes
¶ return the attribute manager
Returns: attribute manager Return type: H5CppAttributeManager
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppFile
(h5object, filename)[source]¶ Bases:
lavuelib.filewriter.FTFile
file tree file
constructor
Parameters: -
root
()[source]¶ root object
Returns: parent object Return type: H5CppGroup
-
-
class
lavuelib.h5cppwriter.
H5CppGroup
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTGroup
file tree group
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – tree parent
-
class
H5CppGroupIter
(group)[source]¶ Bases:
object
constructor
Parameters: group – group object -
next
()¶ the next attribute
Returns: attribute object Return type: FTAtribute
-
-
attributes
¶ return the attribute manager
Returns: attribute manager Return type: H5CppAttributeManager
-
create_field
(name, type_code, shape=None, chunk=None, dfilter=None)[source]¶ open a file tree element
Parameters: Returns: file tree field
Return type:
-
create_group
(n, nxclass=None)[source]¶ open a file tree element
Parameters: Returns: file tree group
Return type:
-
create_virtual_field
(name, layout, fillvalue=0)[source]¶ creates a virtual filed tres element
Parameters:
-
exists
(name)[source]¶ if child exists
Parameters: name ( str
) – child nameReturns: existing flag Return type: bool
-
open
(name)[source]¶ open a file tree element
Parameters: name ( str
) – element nameReturns: file tree object Return type: FTObject
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppLink
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTLink
file tree link
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5cppwriter.
H5CppTargetFieldView
(filename, fieldpath, shape, dtype=None, maxshape=None)[source]¶ Bases:
lavuelib.filewriter.FTTargetFieldView
target field for VDS
constructor
Parameters:
-
class
lavuelib.h5cppwriter.
H5CppVirtualFieldLayout
(h5object, shape, dtype=None, maxshape=None)[source]¶ Bases:
lavuelib.filewriter.FTVirtualFieldLayout
virtual field layout
constructor
Parameters:
-
lavuelib.h5cppwriter.
create_file
(filename, overwrite=False, libver=None, swmr=None)[source]¶ create a new file
Parameters: Returns: file object
Return type:
-
lavuelib.h5cppwriter.
data_filter
()[source]¶ create deflate filter
Returns: deflate filter object Return type: H5CppDataFilter
-
lavuelib.h5cppwriter.
deflate_filter
()¶ create deflate filter
Returns: deflate filter object Return type: H5CppDataFilter
-
lavuelib.h5cppwriter.
get_links
(parent)[source]¶ get links
Parameters: parent ( FTObject
) – parent objectReturns: list of link objects Returns: link object Return type: obj: list < H5CppLink
>
-
lavuelib.h5cppwriter.
is_image_file_supported
()[source]¶ provides if loading of image files are supported
Retruns: if loading of image files are supported Return type: bool
-
lavuelib.h5cppwriter.
is_unlimited_vds_supported
()[source]¶ provides if unlimited vds are supported
Retruns: if unlimited vds are supported Return type: bool
-
lavuelib.h5cppwriter.
is_vds_supported
()[source]¶ provides if vds are supported
Retruns: if vds are supported Return type: bool
-
lavuelib.h5cppwriter.
link
(target, parent, name)[source]¶ create link
Parameters: Returns: link object
Return type:
-
lavuelib.h5cppwriter.
load_file
(membuffer, filename=None, readonly=False, **pars)[source]¶ load a file from memory byte buffer
Parameters: Returns: file object
Return type: H5PYFile
-
lavuelib.h5cppwriter.
nptype
(dtype)[source]¶ converts to numpy types
Parameters: dtype ( str
) – h5 writer type typeReturns: nupy type Return type: str
-
lavuelib.h5cppwriter.
open_file
(filename, readonly=False, libver=None, swmr=False)[source]¶ open the new file
Parameters: Returns: file object
Return type:
-
lavuelib.h5cppwriter.
target_field_view
(filename, fieldpath, shape, dtype=None, maxshape=None)[source]¶ create target field view for VDS
Parameters: Returns: target field view object
Return type:
-
lavuelib.h5cppwriter.
unlimited
(parent=None)[source]¶ return dataspace UNLIMITED variable for the current writer module
Parameters: parent ( FTObject
) – parent objectReturns: dataspace UNLIMITED variable Return type: h5cpp.dataspace.UNLIMITED
lavuelib.h5pywriter¶
Provides h5py file writer
-
class
lavuelib.h5pywriter.
H5PYAttribute
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTAttribute
file tree attribute
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5pywriter.
H5PYAttributeManager
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTAttributeManager
file tree attribute
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
-
class
H5PYAttrIter
(manager)[source]¶ Bases:
object
constructor
Parameters: manager ( H5PYAttributeManager
) – attribute manager-
next
()¶ the next attribute
Returns: attribute object Return type: FTAtribute
-
- h5object (
-
class
lavuelib.h5pywriter.
H5PYDataFilter
(h5object=None, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTDataFilter
file tree data filter
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5pywriter.
H5PYDeflate
(h5object=None, tparent=None)[source]¶ Bases:
lavuelib.h5pywriter.H5PYDataFilter
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5pywriter.
H5PYField
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTField
file writer field
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
-
attributes
¶ return the attribute manager
Returns: attribute manager Return type: H5PYAttributeManager
- h5object (
-
class
lavuelib.h5pywriter.
H5PYFile
(h5object, filename)[source]¶ Bases:
lavuelib.filewriter.FTFile
file tree file
constructor
Parameters:
-
class
lavuelib.h5pywriter.
H5PYGroup
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTGroup
file tree group
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
-
class
H5PYGroupIter
(group)[source]¶ Bases:
object
constructor
Parameters: group – group object -
next
()¶ the next attribute
Returns: attribute object Return type: FTAtribute
-
-
attributes
¶ return the attribute manager
Returns: attribute manager Return type: H5PYAttributeManager
-
create_field
(name, type_code, shape=None, chunk=None, dfilter=None)[source]¶ creates a field tree element
Parameters: Returns: file tree field
Return type:
-
create_group
(n, nxclass='')[source]¶ open a file tree element
Parameters: Returns: file tree group
Return type:
-
create_virtual_field
(name, layout, fillvalue=None)[source]¶ creates a virtual filed tres element
Parameters:
-
exists
(name)[source]¶ if child exists
Parameters: name ( str
) – child nameReturns: existing flag Return type: bool
-
open
(name)[source]¶ open a file tree element
Parameters: name ( str
) – element nameReturns: file tree object Return type: FTObject
- h5object (
-
class
lavuelib.h5pywriter.
H5PYLink
(h5object, tparent=None)[source]¶ Bases:
lavuelib.filewriter.FTLink
file tree link
constructor
Parameters: - h5object (
any
) – h5 object - tparent (
FTObject
) – treee parent
- h5object (
-
class
lavuelib.h5pywriter.
H5PYTargetFieldView
(h5object, shape)[source]¶ Bases:
lavuelib.filewriter.FTTargetFieldView
target field view for VDS
constructor
Parameters:
-
class
lavuelib.h5pywriter.
H5PYVirtualFieldLayout
(h5object, shape)[source]¶ Bases:
lavuelib.filewriter.FTVirtualFieldLayout
virtual field layout
constructor
Parameters:
-
lavuelib.h5pywriter.
create_file
(filename, overwrite=False, **pars)[source]¶ create a new file
Parameters: Returns: file object
Return type:
-
lavuelib.h5pywriter.
data_filter
()[source]¶ create deflate filter
Returns: deflate filter object Return type: H5PYDataFilter
-
lavuelib.h5pywriter.
deflate_filter
()¶ create deflate filter
Returns: deflate filter object Return type: H5PYDataFilter
-
lavuelib.h5pywriter.
get_links
(parent)[source]¶ get links
Parameters: parent ( FTObject
) – parent objectReturns: list of link objects Returns: link object Return type: obj: list < H5PYLink
>
-
lavuelib.h5pywriter.
is_image_file_supported
()[source]¶ provides if loading of image files are supported
Retruns: if loading of image files are supported Return type: bool
-
lavuelib.h5pywriter.
is_mbs_supported
()[source]¶ provides if MultiBlockSlice are supported
Retruns: if MultiBlockSlice are supported Return type: bool
-
lavuelib.h5pywriter.
is_strings_as_bytes
()[source]¶ provides if string read to bytes
Retruns: if string read to bytes Return type: bool
-
lavuelib.h5pywriter.
is_unlimited_vds_supported
()[source]¶ provides if unlimited vds are supported
Retruns: if unlimited vds are supported Return type: bool
-
lavuelib.h5pywriter.
is_vds_supported
()[source]¶ provides if VDS are supported
Retruns: if VDS are supported Return type: bool
-
lavuelib.h5pywriter.
link
(target, parent, name)[source]¶ create link
Parameters: Returns: link object
Return type:
-
lavuelib.h5pywriter.
load_file
(membuffer, filename=None, readonly=False, **pars)[source]¶ load a file from memory byte buffer
Parameters: Returns: file object
Return type:
-
lavuelib.h5pywriter.
nptype
(dtype)[source]¶ converts to numpy types
Parameters: dtype ( str
) – h5 writer type typeReturns: nupy type Return type: str
-
lavuelib.h5pywriter.
open_file
(filename, readonly=False, **pars)[source]¶ open the new file
Parameters: Returns: file object
Return type:
-
lavuelib.h5pywriter.
target_field_view
(filename, fieldpath, shape, dtype=None, maxshape=None)[source]¶ create target field view for VDS
Parameters: Returns: target field view object
Return type: FTTargetFieldView
-
lavuelib.h5pywriter.
unlimited
(parent=None)[source]¶ return dataspace UNLIMITED variable for the current writer module
Parameters: parent ( FTObject
) – parent objectReturns: dataspace UNLIMITED variable Return type: h5py.h5s.UNLIMITED
lavuelib.helpForm¶
help widget
lavuelib.hidraServerList module¶
A list of possible hidra servers. Take your pick.
lavuelib.highValueMaskWidget module¶
mask widget
-
class
lavuelib.highValueMaskWidget.
HighValueMaskWidget
(parent=None, settings=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Define and apply masking of the displayed image.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings
-
applyStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply state change signal
-
mask
()[source]¶ provides the image mask high value
Returns: high pixel value for masking Return type: str
-
maskHighValueChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) mask high value changed signal
- parent (
lavuelib.histogramWidget module¶
Horizontal HistogramWidget
-
class
lavuelib.histogramWidget.
HistogramHLUTWidget
(parent=None, bins=None, step=None, *args, **kargs)[source]¶ Bases:
pyqtgraph.widgets.GraphicsView.GraphicsView
Horizontal HistogramWidget
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - bins (
str
) – bins edges algorithm for histogram, default: ‘auto’ - step (
str
orint
) – data step for calculation of histogram levels, default: ‘auto’ - args (
list
<any
>) – HistogramHLUTItem parameters list - kargs (
dict
<str
,any
>) – HistogramHLUTItem parameter dictionary
-
item
= None¶ (
HistogramHLUTItem
) histogram item
-
setAutoFactor
(factor)[source]¶ sets auto level factor
Parameters: factor ( float
) – auto level factor of maximal peak
-
setBins
(bins)[source]¶ sets bins edges algorithm for histogram
Parameters: channel ( str
) – bins edges algorithm for histogram
- parent (
lavuelib.imageDisplayWidget module¶
image display widget
-
class
lavuelib.imageDisplayWidget.
ImageDisplayWidget
(parent=None)[source]¶ Bases:
pyqtgraph.widgets.GraphicsLayoutWidget.GraphicsLayoutWidget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
addExtensions
(extlist)[source]¶ provides viewbox :param extlist: extension list :type extlist:
list
<DisplayExtension
>
-
aspectLockedToggled
¶ (
pyqtgraph.QtCore.pyqtSignal
) aspect locked toggled signal
-
currentData
()[source]¶ provides the data
Returns: current data Return type: numpy.ndarray
-
currentIntensity
()[source]¶ provides intensity for current mouse position
Returns: (x position, y position, pixel intensity, x position, y position) Return type: (float, float, float, float, float)
-
descaledxy
(x, y, useraxes=True)[source]¶ provides scaled x,y positions
Parameters: Returns: scaled x,y position
Return type:
-
emitAspectLockedToggled
(status)[source]¶ emits aspectLockedToggled
Parameters: status ( bool
) – aspectLockedToggled status
-
extension
(name)[source]¶ provides viewbox :param name: extension name :type name:
str
:rtype:DisplayExtension
:returns: display extension
-
gradientColors
()[source]¶ gets gradientcolors on/off
Returns: True for on and False for off Return type: bool
-
image
(iid=0)[source]¶ provides imageItem object
Parameters: iid ( int
) – image idReturns: image object Return type: pyqtgraph.imageItem.ImageItem
-
mouseImageDoubleClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) mouse double clicked
-
mouseImagePositionChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) mouse position changed signal
-
mouseImageSingleClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) mouse single clicked
-
mouse_click
(event)[source]¶ updates image widget after mouse click
Parameters: event ( pyqtgraph.QtCore.QEvent
) – mouse click event
-
mouse_position
(event=None)[source]¶ updates image widget after mouse position change
Parameters: event ( pyqtgraph.QtCore.QEvent
) – mouse move event
-
rangeWindowEnabled
()[source]¶ provide info if range window enabled
Returns: range window enabled Return type: bool
-
rangeWindowScale
()[source]¶ provide info about range window sclae
Returns: range window scale Return type: float
-
rawData
()[source]¶ provides the raw data
Returns: current raw data Return type: numpy.ndarray
-
scale
(useraxes=True, noNone=False)[source]¶ provides scale and position of the axes
Parameters: Return type: Returns: [posx, posy, scalex, scaley]
-
scaledxy
(x, y, useraxes=True)[source]¶ provides scaled x,y positions
Parameters: Returns: scaled x,y position
Return type:
-
setAspectLocked
(flag)[source]¶ sets aspectLocked
Parameters: status ( bool
) – state to setReturns: old state Return type: bool
-
setAutoDownSample
(autodownsample)[source]¶ sets auto levels
Parameters: autolevels ( bool
) – auto down sample enabled
-
setAutoLevels
(autolevels)[source]¶ sets auto levels
Parameters: autolevels ( bool
) – auto levels enabled
-
setDisplayChannelLevels
(levels=None)[source]¶ sets maximum intensity levels
Parameters: levels ( list
< (:obj`float`:, :obj`float`:)>) – channel intensity levels
-
setDisplayMaxLevel
(level=None)[source]¶ sets maximum intensity level
Parameters: level ( float
) – maximum intensity
-
setDisplayMinLevel
(level=None)[source]¶ sets minimum intensity level
Parameters: level ( float
) – minimum intensity
-
setDoBFSubtraction
(state)[source]¶ sets do brightfield subtraction flag
Parameters: status ( bool
) – do brightfield subtraction flag
-
setDoBkgSubtraction
(state)[source]¶ sets do background subtraction flag
Parameters: status ( bool
) – do background subtraction flag
-
setDoubleClickLock
(status=True)[source]¶ sets double click lock :param status: status flag :type status:
bool
-
setGradientColors
(status=True)[source]¶ sets gradientcolors on/off
Parameters: status ( bool
) – True for on and False for off
-
setLevelMode
(levelmode=True)[source]¶ sets levelmode
Parameters: levelmode ( str
) – level mode, i.e. mono or rgba
-
setScalingType
(scalingtype)[source]¶ sets intensity scaling types
Parameters: scalingtype ( str
) – intensity scaling type
-
setStatsWOScaling
(status)[source]¶ sets statistics without scaling flag
Parameters: status ( bool
) – statistics without scaling flagReturns: change status Return type: bool
-
setSubWidgets
(parameters)[source]¶ set subwidget properties
Parameters: parameters ( lavuelib.toolWidget.ToolParameters
) – tool parameters
-
setTransformations
(transpose, leftrightflip, updownflip, orgtranspose)[source]¶ sets coordinate transformations
Parameters:
-
setViewRange
(rangelist)[source]¶ set view range values
Parameters: rangelist ( str
) – xmin,ymin,xsize,ysize
-
setrgb
(status=True)[source]¶ sets RGB on/off
Parameters: status ( bool
) – True for on and False for off
-
transformations
()[source]¶ povides coordinates transformations
Returns: transpose, leftrightflip, updownflip flags, original transpose Return type: ( bool
,bool
,bool
)
-
updateImage
(img=None, rawimg=None)[source]¶ updates the image to display
Parameters: - img (
numpy.ndarray
) – 2d image array - rawimg (
numpy.ndarray
) – 2d raw image array
- img (
-
updateMetaData
(axisscales=None, axislabels=None, rescale=False)[source]¶ update Metadata informations
Parameters:
-
updateTicks
(record)[source]¶ update Ticks values
Parameters: record ( dict`<:obj:`str
, any>) – dict record with the tick parameters: “position” : [x, y] “scale” : [sx, sy] “xtext” : xlabel “ytext” : ylabel “xunits” : xunits “yunits” : yunits
-
viewbox
()[source]¶ provides viewbox :rtype:
pyqtgraph.ViewBox
:returns: viewbox
-
-
class
lavuelib.imageDisplayWidget.
IntensityParameters
[source]¶ Bases:
object
intensity parameters
constructor
-
class
lavuelib.imageDisplayWidget.
SafeImageItem
(*args, **kargs)[source]¶ Bases:
pyqtgraph.graphicsItems.ImageItem.ImageItem
Image item which caught exceptions in paint
constructor
Parameters:
lavuelib.imageField¶
configuration widget
lavuelib.imageFileHandler module¶
this a simple file handler that loads image files and delivers just the actual array
-
class
lavuelib.imageFileHandler.
CBFLoader
[source]¶ Bases:
object
CBF loader
-
classmethod
load
(flbuffer)[source]¶ loads CBF file image data into numpy array
Parameters: flbuffer ( numpy.ndarray
) – numpy array with CBF file image dataReturns: image data Return type: numpy.ndarray
-
classmethod
-
class
lavuelib.imageFileHandler.
ImageFileHandler
(fname)[source]¶ Bases:
object
Simple file handler class. Reads image from file and returns the numpy array.
constructor
Parameters: fname ( str
) – file name-
getImage
()[source]¶ provides the image data
Returns: image data Return type: numpy.ndarray
-
-
class
lavuelib.imageFileHandler.
NexusFieldHandler
(fname=None, writer=None)[source]¶ Bases:
object
Nexus file handler class. Reads image from file and returns the numpy array.
constructor
Parameters: -
findImageFields
()[source]¶ provides a dictionary with of all image fields
Returns: dictionary of the field names and the field objects Return type: dict
<str
,dict
<str
,any
>>
-
frombuffer
(membuffer, fname=None, writer=None)[source]¶ constructor
Parameters: - membuffer (
bytes
orio.BytesIO
) – memory buffer - fname (
str
) – file name - writer (
str
) – h5 writer module: “h5py” or “h5py”
- membuffer (
-
classmethod
getFrameCount
(node, growing=0, refresh=True)[source]¶ provides the last frame number
Parameters: - node (
lavuelib.filewriter.FTField
) – nexus field node - growing (
int
) – growing dimension - refresh (
bool
) – refresh image node
Returns: a number of frames
Return type: - node (
-
classmethod
getImage
(node, frame=-1, growing=0, refresh=True)[source]¶ parses the field and add it into the description list
Parameters: - node (
lavuelib.filewriter.FTField
) – nexus field node - frame (
int
) – frame to take, the last one is -1 - growing (
int
) – growing dimension - refresh (
bool
) – refresh image node
Returns: get the image
Return type: - node (
-
classmethod
getMetaData
(node, mdata=None, maxrec=4)[source]¶ provides the image metadata
Returns: JSON dictionary with image metadata Return type: str
-
getNode
(field=None)[source]¶ get node :param field: field path :type field:
str
:returns: nexus field node :rtype:lavuelib.filewriter.FTField
-
-
class
lavuelib.imageFileHandler.
TIFLoader
[source]¶ Bases:
object
TIF loader
-
classmethod
load
(flbuffer)[source]¶ loads TIF file image data into numpy array
Parameters: flbuffer ( numpy.ndarray
) – numpy array with TIF file image dataReturns: image data Return type: numpy.ndarray
-
classmethod
lavuelib.imageNexusExporter module¶
image Nexus exporter
-
class
lavuelib.imageNexusExporter.
ImageNexusExporter
(item)[source]¶ Bases:
pyqtgraph.exporters.Exporter.Exporter
NeXus Raw Image Exporter
constructor
Parameters: - item – image item
- item –
class: pyqtgraph.PlotItem or pyqtgraph.GraphicsScene
-
Name
= 'NeXus Raw Image'¶
-
allowCopy
= False¶
-
export
(fileName=None)[source]¶ export data image to NeXus file
Parameters: fileName – output file name Rtype fileName: str
-
parameters
()[source]¶ Returns: exporter parameters Return type: pyqtgraph.parametertree.Parameter
-
params
= None¶ (
pyqtgraph.parametertree.Parameter
) exporter parameters
-
windows
= []¶
lavuelib.imageSource module¶
set of image sources
-
class
lavuelib.imageSource.
ASAPOSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
asapo image source
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
BaseSource
(timeout=None)[source]¶ Bases:
object
source base class
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
DATAARRAYdecoder
[source]¶ Bases:
object
DATA ARRAY LIMA decoder
constructor
Brief: It clears the local variables -
decode
()[source]¶ provides the decoded data
Returns: the decoded data if data was loaded Return type: numpy.ndarray
-
-
class
lavuelib.imageSource.
DOOCSPropSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as IMAGE DOOCS property
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
EpicsPVSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as Epics Process variable
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
FixTestSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as Tango attributes describing an image file name and its directory
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
HTTPSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as HTTP request response
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
HiDRASource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
hidra image source
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
NXSFileSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as Tango attributes describing an image file name and its directory
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
lavuelib.imageSource.
PYTG_BUG_213
= False¶ (
bool
) PyTango bug #213 flag related to EncodedAttributes in python3
-
class
lavuelib.imageSource.
TangoAttrSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as IMAGE Tango attribute
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
TangoEventsCB
(client, name, mutex)[source]¶ Bases:
object
tango attribute callback class
constructor
Parameters:
-
class
lavuelib.imageSource.
TangoEventsSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as IMAGE Tango attribute
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
TangoFileSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as Tango attributes describing an image file name and its directory
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
TangoReadyEventsCB
(client, name, mutex)[source]¶ Bases:
object
tango attribute callback class
constructor
Parameters:
-
class
lavuelib.imageSource.
TinePropSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as Tine Property
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
class
lavuelib.imageSource.
VDEOdecoder
[source]¶ Bases:
object
VIDEO IMAGE LIMA decoder
constructor
Brief: It clears the local variables -
decode
()[source]¶ provides the decoded data
Returns: the decoded data if data was loaded Return type: numpy.ndarray
-
-
class
lavuelib.imageSource.
ZMQSource
(timeout=None)[source]¶ Bases:
lavuelib.imageSource.BaseSource
image source as ZMQ stream
constructor
Parameters: timeout ( int
) – timeout for setting connection in ms-
getData
()[source]¶ provides image name, image data and metadata
Returns: image name, image data, json dictionary with metadata Return type: ( str
,numpy.ndarray
,str
)
-
-
lavuelib.imageSource.
currenttime
()[source]¶ provides current time in iso format
Returns: current time in iso format Return type: str
lavuelib.imageWidget module¶
image widget
-
class
lavuelib.imageWidget.
ImageWidget
(parent=None, tooltypes=None, settings=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
The part of the GUI that incorporates the image view.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - tooltypes (
list
<str
>) – tool class names - settings (
lavuelib.settings.Settings
) – lavue configuration settings
-
applyROIs
(rlabel, roispin)[source]¶ saves ROIs in sardana and add them to the measurement group
Parameters:
-
applyTipsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply tips changed signal
-
aspectLockedToggled
¶ (
pyqtgraph.QtCore.pyqtSignal
) aspect locked toggled signal
-
bottomplotShowMenu
(freeze=False, clear=False)[source]¶ shows freeze or/and clean action in the menu
Parameters: - freeze (
bool
) – freeze show status - freeze – clean show status
- freeze (
-
bottomplotStretch
(stretch=1)[source]¶ stretches the bottom plot
Parameters: stretch ( int
) – stretch factor
-
calcROIsum
()[source]¶ calculates the current roi sum
Returns: sum roi value, roi id Return type: ( str
,int
)
-
calcROIsums
()[source]¶ calculates all roi sums
Returns: sum roi value, roi id Return type: list
< float >
-
clearBottomPlotClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) clear clicked signal
-
colorsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) colors changed signal
-
currentData
()[source]¶ provides the data
Returns: current data Return type: numpy.ndarray
-
currentIntensity
()[source]¶ provides intensity for current mouse position
Returns: x position, y position, pixel intensity Return type: (float, float, float)
-
currentToolChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) current tool changed signal
-
cutCoords
()[source]¶ provides cuts coordinates
Returns: cuts coordinates Return type: list
< [float
,float
,float
,float
] >
-
cutCoordsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) cut coordinate changed signal
-
cutData
(cid=None)[source]¶ provides the current cut data
Parameters: cid ( int
) – cut idReturns: current cut data Return type: numpy.ndarray
-
cutNumberChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) cut number changed signal
-
emitAspectLockedToggled
(status)[source]¶ emits aspectLockedToggled
Parameters: status ( bool
) – current state
-
fetchROIs
(rlabel)[source]¶ loads ROIs from sardana
Parameters: rlabel ( str
) – rois aliases separated by space
-
freezeBottomPlotClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) freeze clicked signal
-
geometryChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) geometry changed
-
getDoor
()[source]¶ runs macro
Parameters: command ( list
<str
>) – command listReturns: macro runned Return type: bool
-
getElementNames
(listattr, typefilter=None)[source]¶ provides experimental Channels
Parameters: Returns: names from given pool listattr
Return type:
-
gradientColors
()[source]¶ gets gradientcolors on/off
Returns: True for on and False for off Return type: bool
-
image
(iid=0)[source]¶ provides imageItem object
Parameters: iid ( int
) – image idReturns: image object Return type: pyqtgraph.ImageItem
-
imagePlotted
¶ (
pyqtgraph.QtCore.pyqtSignal
) image plotted signal
-
maskIndices
()[source]¶ provides mask image indices
Returns: mask image indices Return type: numpy.ndarray
-
maskValueIndices
()[source]¶ provides mask image value indices
Returns: mask image indices Return type: numpy.ndarray
-
meshCoords
()[source]¶ provides rois coordinates
Returns: rois coordinates Return type: list
< [float
,float
,float
,float
] >
-
meshCoordsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) mesh coordinate changed signal
-
mouseImageDoubleClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) mouse double clicked
-
mouseImagePositionChanged
¶
-
mouseImageSingleClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) mouse single clicked
-
onedbarbottomplot
()[source]¶ creates 1d bottom bar plot
Returns: 1d bottom bar plot Return type: pyqtgraph.BarGraphItem
-
onedbarrightplot
()[source]¶ creates 1d right bar plot
Returns: 1d right bar plot Return type: pyqtgraph.BarGraphItem
-
onedbottomplot
(clear=False, name=None)[source]¶ creates 1d bottom plot
Parameters: clear ( bool
) – clear flagReturns: 1d bottom plot Return type: pyqtgraph.PlotDataItem
-
onedrightplot
(clear=False)[source]¶ creates 1d right plot
Parameters: clear ( bool
) – clear flagReturns: 1d right plot Return type: pyqtgraph.PlotDataItem
-
onedshowlegend
(show=True)[source]¶ shows/hides 1d bottom plot legend
Parameters: status ( bool
) – show flagReturns: 1d bottom plot Return type: pyqtgraph.PlotDataItem
-
plot
(array, rawarray=None, imagename=None)[source]¶ plots the image
Parameters: - array (
numpy.ndarray
) – 2d image array - rawarray (
numpy.ndarray
) – 2d raw image array - imagename (
str
) – image name
- array (
-
rangeWindowEnabled
()[source]¶ provide info if range window enabled
Returns: range window enabled Return type: bool
-
rangeWindowScale
()[source]¶ provide info range window scale
Returns: range window scale Return type: float
-
rawData
()[source]¶ provides the raw data
Returns: current raw data Return type: numpy.ndarray
-
removebottomplot
(plot)[source]¶ removes bottom plot
Parameters: plot ( pyqtgraph.PlotItem
) – right plot item
-
removerightplot
(plot)[source]¶ removes right plot
Parameters: plot ( pyqtgraph.PlotItem
) – right plot item
-
replotImage
¶ (
pyqtgraph.QtCore.pyqtSignal
) replot image signal
-
roiAliasesChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi aliases changed signal
-
roiCoords
()[source]¶ provides rois coordinates
Returns: rois coordinates Return type: list
< [float
,float
,float
,float
] >
-
roiCoordsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi coordinate changed signal
-
roiLineEditChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi Line Edit changed signal
-
roiNumberChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi number changed signal
-
roiValueChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi value changed signal
-
roilabels
= None¶ (obj`str`) roi labels
-
runMacro
(command)[source]¶ runs macro
Parameters: command ( list
<str
>) – command listReturns: macro runned Return type: bool
-
sardanaEnabled
¶ (
pyqtgraph.QtCore.pyqtSignal
) sardana enabled signal
-
scale
(useraxes=True, noNone=False)[source]¶ provides scale and position of the axes
Parameters: Return type: Returns: [posx, posy, scalex, scaley]
-
scaledxy
(x, y, useraxes=True)[source]¶ provides scaled x,y positions
Parameters: Returns: scaled x,y position
Return type:
-
scalesChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) scales changed signal
-
setAspectLocked
(status)[source]¶ sets aspectLocked
Parameters: status ( bool
) – state to setReturns: old state Return type: bool
-
setAutoDownSample
(autodownsample)[source]¶ sets auto down sample
Parameters: autolevels ( bool
) – auto down sample enabled
-
setAutoLevels
(autolevels)[source]¶ sets auto levels
Parameters: autolevels (:obj:'int`) – 2: auto levels enabled 1: with autofactor
-
setChannelLevels
(levels=None)[source]¶ sets minimum intensity levels
Parameters: levels ( list
< (:obj`float`:, :obj`float`:)>) – channel intensity levels
-
setDisplayedText
(text=None)[source]¶ sets displayed info text and recalculates the current roi sum
Parameters: text ( str
) – text to display
-
setDoBFSubtraction
(state)[source]¶ sets do brightfield subtraction flag
Parameters: status ( bool
) – do brightfield subtraction flag
-
setDoBkgSubtraction
(state)[source]¶ sets do background subtraction flag
Parameters: status ( bool
) – do background subtraction flag
-
setDoubleClickLock
(status=True)[source]¶ sets double click lock
Parameters: status ( bool
) – status flag
-
setExtensionsRefreshTime
(refreshtime)[source]¶ set display extension refresh time
Parameters: refreshtime ( float
) – refresh time in seconds
-
setGradientColors
(status=True)[source]¶ sets gradientcolors on/off
Parameters: status ( bool
) – True for on and False for off
-
setLevelMode
(levelmode=True)[source]¶ sets levelmode
Parameters: levelmode ( str
) – level mode, i.e. mono or rgba
-
setMaskValueIndices
(maskindices)[source]¶ sets mask image indices
Params maskindices: mask image value indices
-
setMaxLevel
(level=None)[source]¶ sets maximum intensity level
Parameters: level ( float
) – maximum intensity
-
setMinLevel
(level=None)[source]¶ sets minimum intensity level
Parameters: level ( float
) – minimum intensity
-
setSardanaUtils
(sardana)[source]¶ sets sardana utils
Parameters: sardana ( lavuelib.sardanaUtils.SardanaUtils
) – sardana utils
-
setScalingType
(scalingtype)[source]¶ sets intensity scaling types
Parameters: scalingtype ( str
) – intensity scaling type
-
setStatsWOScaling
(status)[source]¶ sets statistics without scaling flag
Parameters: status ( bool
) – statistics without scaling flagReturns: change status Return type: bool
-
setTangoClient
(tangoclient)[source]¶ sets tango client
Parameters: tangoclient ( lavuelib.controllerClient.ControllerClient
) – attribute name
-
setToolConfiguration
(config)[source]¶ sets tool configuration from JSON dictionary
Parameters: config ( str
) – JSON dictionary with tool configuration
-
setTransformations
(transpose, leftrightflip, updownflip, orgtranspose, orgleftrightflip, orgupdownflip)[source]¶ sets coordinate transformations
Parameters: - transpose (
bool
) – transpose coordinates flag - leftrightflip (
bool
) – left-right flip coordinates flag - updownflip (
bool
) – up-down flip coordinates flag - orgtranspose (
bool
) – selected transpose coordinates flag - orgleftrightflip (
bool
) – selected left-right flip coordinates flag - orgupdownflip (
bool
) – selected up-down flip coordinates flag
- transpose (
-
setViewRange
(rangelist)[source]¶ set view range values
Parameters: rangelist ( str
) – xmin,ymin,xsize,ysize
-
setrgb
(status=True)[source]¶ sets RGB on/off
Parameters: status ( bool
) – True for on and False for off
-
settings
()[source]¶ provides settings
Returns: setting object Return type: lavuelib.settings.Settings
-
toolConfiguration
()[source]¶ provides tool configuration
Returns: JSON dictionary with tool configuration Return type: str
-
toolConfigurationChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) tool configuration changed signal
-
transformations
()[source]¶ povides coordinates transformations
Returns: transpose, leftrightflip, updownflip flags, original transpose Return type: ( bool
,bool
,bool
,bool
)
-
updateDetectorDistance
(distance)[source]¶ updates the detector distance
Parameters: distance ( float
) – detector distance
-
updateDetectorROIs
(rois)[source]¶ updates the detector ROIs
Parameters: distance ( str
) – json dictionary with detector ROIs
-
updateDisplayedTextTip
(text)[source]¶ sets displayed info text tup
Parameters: text ( str
) – tip text to display
-
updateImage
(array=None, rawarray=None)[source]¶ update the image
Parameters: - array (
numpy.ndarray
) – 2d image array - rawarray (
numpy.ndarray
) – 2d raw image array
- array (
-
updateMetaData
(axisscales=None, axislabels=None, rescale=False)[source]¶ update Metadata informations
Parameters:
-
updatePositionTrackingMark
(xdata, ydata, scaled=False)[source]¶ updates the position tracking mark
Parameters:
-
updateTicks
(record)[source]¶ update Ticks values
Parameters: record ( dict`<:obj:`str
, any>) – dict record with the tick parameters: “position” : [x, y] “scale” : [sx, sy] “xtext” : xlabel “ytext” : ylabel “xunits” : xunits “yunits” : yunits
- parent (
lavuelib.intervalsDialog module¶
interval device widget
lavuelib.levelsGroupBox module¶
level widget
-
class
lavuelib.levelsGroupBox.
LevelsGroupBox
(parent=None, settings=None, expertmode=False)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Set minimum and maximum displayed values and its color.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings - expertmode (
bool
) – expert mode flag
-
autoFactor
()[source]¶ provides factor for automatic levels
Returns: factor for automatic levels Return type: str
-
autoLevelsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) automatic levels changed signal
-
changeView
(showhistogram=None, showlevels=None, showadd=None)[source]¶ shows or hides the histogram widget
Parameters:
-
channelLevels
()[source]¶ provides levels from configuration string
Returns: channel levels Return type: str
-
channelLevelsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) channel levels changed signal
-
gradientChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) gradient changed signal
-
gradientColors
()[source]¶ gets gradientcolors on/off
Returns: True for on and False for off Return type: bool
-
isAutoLevel
()[source]¶ returns if automatics levels are enabled
Returns: if automatics levels are enabled Return type: bool
-
levels
()[source]¶ provides levels from configuration string
Returns: configuration string: lowlim,uplim or lowlim,uplim;c1l,c1u;c2l,c2u;c3l,c3u Return type: str
-
levelsChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) levels changed signal
-
maxLevelChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) maximum level changed signal
-
minLevelChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) minimum level changed signal
-
setAutoFactor
(factor)[source]¶ sets factor for automatic levels
Parameters: factor ( str
) – factor for automatic levels
-
setAutoLevels
(auto)[source]¶ enables or disables automatic levels
Parameters: auto ( bool
orint
) – if automatics levels to be set
-
setBins
(index)[source]¶ sets bins edges algorithm for histogram
Parameters: index ( int
) – bins edges algorithm index for histogram
-
setGradient
(name, iid=None)[source]¶ sets gradient
:param name gradient name :type name:
str
:param iid: image id :type iid:int
-
setGradientColors
(status=True)[source]¶ sets gradientcolors on/off
Parameters: status ( bool
) – True for on and False for off
-
setImageItem
(image, iid=0)[source]¶ sets histogram image
Parameters: - image (
pyqtgraph.graphicsItems.ImageItem.ImageItem
) – histogram image - iid (
int
) – image id
- image (
-
setLevels
(cnflevels)[source]¶ set levels from configuration string
Parameters: cnflevels ( str
) – configuration string: lowlim,uplim or lowlim,uplim;lowred,upred;lowgreen,upgreen;lowblue,upblue
-
setRGBChannels
(rgbchannels)[source]¶ rgb channel indexes
Parameters: rgbchannels ( tuple
<int
>) – rgb channel indexes
-
setScalingLabel
(scalingtype)[source]¶ sets scaling label
Parameters: scalingtype ( str
) – scaling type, i.e. log, linear, sqrt
-
setrgb
(status=True)[source]¶ sets RGB on/off
Parameters: status ( bool
) – True for on and False for off
-
showChannels
(status=True)[source]¶ show/hide channel widget
Parameters: status ( bool
) – show channel flag
-
showGradient
(status=True)[source]¶ show/hide gradient widget
Parameters: status ( bool
) – show gradient flag
-
showHistograms
(status=True)[source]¶ show/hide gradient widget
Parameters: status ( bool
) – show gradient flag
-
storeSettingsRequested
¶ (
pyqtgraph.QtCore.pyqtSignal
) store settings requested
-
updateAutoLevels
(lowlim, uplim, channels=None)[source]¶ set min/max level spinboxes and histogram from the parameters
Parameters:
-
updateHistoImage
(autoLevel=None)[source]¶ executes imageChanged of histogram with the givel autoLevel
Parameters: autoLevel ( bool
) – if automatics levels to be set
- parent (
lavuelib.liveViewer module¶
live viewer settings
-
class
lavuelib.liveViewer.
LiveViewer
(options, parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QDialog
The master class for the dialog, contains all other widget and handles communication.
constructor
Parameters: - options (
argparse.Namespace
) – commandline options - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
closeEvent
(event)[source]¶ stores the setting before finishing the application
Parameters: event ( pyqtgraph.QtCore.QEvent
:) – close event
-
keyPressEvent
(event)[source]¶ skips escape key action
Parameters: event ( pyqtgraph.QtCore.QEvent
:) – close event
- options (
-
class
lavuelib.liveViewer.
MainWindow
(options, parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QMainWindow
constructor
Parameters: - options (
argparse.Namespace
) – commandline options - parent (
pyqtgraph.QtCore.QObject
) – parent object
- options (
-
class
lavuelib.liveViewer.
PartialData
(name, rawdata, metadata, x, y, tr)[source]¶ Bases:
object
partial data
constructor
Parameters: -
data
()[source]¶ provides transformed data
Returns: transformed data Return type: numpy.ndarray
-
dtype
()[source]¶ provides data type
Returns: numpy data type Return type: numpy.dtype
-
intmaxvalue
()[source]¶ provides data type maximal value
Returns: integer data type maximal value Return type: int
-
tolist
()[source]¶ converts partial data to a list
Returns: a list: [name, rawdata, metadata, x, y, sx, sy, tr] Return type: [ str
,numpy.ndarray', :obj:`str
,int
,int
,int
,int
,str
]
-
tpose
= {'flr': False, 'fup': False, 'none': False, 'r180': False, 'r180t': True, 'r270': True, 'r90': True, 't': True}¶
-
lavuelib.maskWidget module¶
mask widget
-
class
lavuelib.maskWidget.
MaskWidget
(parent=None, settings=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Define and apply masking of the displayed image.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings
-
applyStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply state change signal
-
maskFileSelected
¶ (
pyqtgraph.QtCore.pyqtSignal
) mask file selected signal
- parent (
lavuelib.memoExportDialog¶
image display widget
-
lavuelib.memoExportDialog.
GraphicsScene_showExportDialog
(self)[source]¶ dynamic replacement of GraphicsScene.showExportDialog
-
class
lavuelib.memoExportDialog.
MemoExportDialog
(scene)[source]¶ Bases:
pyqtgraph.GraphicsScene.exportDialog.ExportDialog
ExportDialog with bookkeeping parameters
-
class
lavuelib.memoExportDialog.
MemoPlotWidget
(parent=None, background='default', **kargs)[source]¶ Bases:
pyqtgraph.widgets.PlotWidget.PlotWidget
Plot Widget with improved Export Dialog
-
clearClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) clear clicked signal
-
freezeClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) freeze clicked signal
-
lavuelib.memoryBufferGroupBox¶
Memory Buffer widget
-
class
lavuelib.memoryBufferGroupBox.
MemoryBufferGroupBox
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QGroupBox
Set circular memory buffer for images
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
bufferSizeChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) state updated signal
-
changeView
(show=False)[source]¶ shows or hides the histogram widget
Parameters: show ( bool
) – if histogram should be shown
-
process
(image, imagename)[source]¶ append image to the buffer and returns image buffer and metadata
Parameters: - image (
numpy.ndarray
) – numpy array with an image - imagename (
str
) – image name
Returns: numpy array with an image
Return type: (
numpy.ndarray
, :obj`dict`<str
,str
>) or None- image (
-
setBufferSize
(buffersize)[source]¶ sets buffer size
Parameters: buffersize ( int
orstr
) – maximal number of images in the buffer
-
lavuelib.messageBox module¶
error message box
-
class
lavuelib.messageBox.
MessageBox
(parent)[source]¶ Bases:
PyQt5.QtCore.QObject
error message box
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
classmethod
getText
(default, error=None)[source]¶ provides error message text fro sys.exc_info()
Parameters: Returns: exception message
Return type:
-
classmethod
lavuelib.motorWatchThread module¶
motor watch thread
-
class
lavuelib.motorWatchThread.
AttributeWatchThread
(aproxies, refreshtime=None)[source]¶ Bases:
lavuelib.omniQThread.OmniQThread
constructor
Parameters: - refreshtime (
tango.DeviceProxy
) – refresh time - aproxies (
list
<tango.DeviceProxy
>) – attribute proxies
-
attrValuesSignal
¶ (
pyqtgraph.QtCore.pyqtSignal
) signal with attribute values
-
isWatching
()[source]¶ is datasource source connected
Returns: if datasource source connected Return type: bool
-
watchingFinished
¶ (
pyqtgraph.QtCore.pyqtSignal
) watching finished
- refreshtime (
-
class
lavuelib.motorWatchThread.
MotorWatchThread
(motor1, motor2, server=None)[source]¶ Bases:
lavuelib.omniQThread.OmniQThread
constructor
Parameters: - motor1 (
tango.DeviceProxy
) – first motor device proxy - motor2 (
tango.DeviceProxy
) – second motor device proxy - mserver (
tango.DeviceProxy
) – door server device proxy
-
isWatching
()[source]¶ is datasource source connected
Returns: if datasource source connected Return type: bool
-
motorStatusSignal
¶ (
pyqtgraph.QtCore.pyqtSignal
) signal with motor status
-
watchingFinished
¶ (
pyqtgraph.QtCore.pyqtSignal
) watching finished
- motor1 (
lavuelib.normalizationWidget module¶
normalization widget
-
class
lavuelib.normalizationWidget.
NormalizationWidget
(parent=None, settings=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Define bkg image and subtract from displayed image.
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings
-
applyBFStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply state change signal
-
bfFileSelected
¶
-
bfScalingFactor
()[source]¶ provides bright field scaling factor
Returns: bright field scaling factor Return type: float
-
bfScalingFactorChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) BF scaling factor change signal
-
checkBFSubtraction
(state)[source]¶ unchecks apply CheckBox if state is 1 and it is checked and reset the display
Parameters: state ( int
) – checkbox state
-
setBFScalingFactor
(scale)[source]¶ sets the bright field scaling factor
Parameters: scale ( float
orstr
) – bright field scaling factor
-
useCurrentImageAsBF
¶ (
pyqtgraph.QtCore.pyqtSignal
) use current image signal
- parent (
lavuelib.omniQThread module¶
omni qt thread
lavuelib.preparationGroupBox module¶
preparationbox widget
-
class
lavuelib.preparationGroupBox.
PreparationGroupBox
(parent=None, settings=None)[source]¶ Bases:
PyQt5.QtWidgets.QGroupBox
colection of image preperation widgets
constructor
Parameters: - parent (
pyqtgraph.QtCore.QObject
) – parent object - settings (
lavuelib.settings.Settings
) – lavue configuration settings
-
changeView
(showmask=None, showsub=None, showtrans=None, showhighvaluemask=None, showsubsf=None, shownorm=None, shownormsf=None)[source]¶ show or hide widgets in the preparation colection
Parameters: - showmask (
bool
) – mask widget shown - showsub (
bool
) – subtraction widget shown - showtrans (
bool
) – transformation widget shown - showhighvaluemask (
bool
) – mask widget shown - showsubsf (
bool
) – subtraction scaling widget shown - shownorm (
bool
) – normalization widget shown - shownormsf (
bool
) – normalization scaling widget shown
- showmask (
-
highValueMaskWidget
= None¶ (
lavuelib.maskWidget.Maskwidget
) mask widget
-
maskWidget
= None¶ (
lavuelib.maskWidget.Maskwidget
) mask widget
- parent (
lavuelib.qtuic module¶
uic support
-
class
lavuelib.qtuic.
QWebView
(parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QWidget
-
back
(self)¶
-
changeEvent
(self, QEvent)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
createWindow
(self, QWebPage.WebWindowType) → QWebView¶
-
dragEnterEvent
(self, QDragEnterEvent)¶
-
dragLeaveEvent
(self, QDragLeaveEvent)¶
-
dragMoveEvent
(self, QDragMoveEvent)¶
-
dropEvent
(self, QDropEvent)¶
-
event
(self, QEvent) → bool¶
-
findText
(self, str, options: QWebPage.FindFlags = 0) → bool¶
-
focusInEvent
(self, QFocusEvent)¶
-
focusNextPrevChild
(self, bool) → bool¶
-
focusOutEvent
(self, QFocusEvent)¶
-
forward
(self)¶
-
hasSelection
(self) → bool¶
-
history
(self) → QWebHistory¶
-
icon
(self) → QIcon¶
-
iconChanged
¶ iconChanged(self) [signal]
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
inputMethodQuery
(self, Qt.InputMethodQuery) → Any¶
-
isModified
(self) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
keyReleaseEvent
(self, QKeyEvent)¶
-
linkClicked
¶ linkClicked(self, QUrl) [signal]
-
load
(self, QUrl)¶ load(self, QNetworkRequest, operation: QNetworkAccessManager.Operation = QNetworkAccessManager.GetOperation, body: Union[QByteArray, bytes, bytearray] = QByteArray())
-
loadFinished
¶ loadFinished(self, bool) [signal]
-
loadProgress
¶ loadProgress(self, int) [signal]
-
loadStarted
¶ loadStarted(self) [signal]
-
mouseDoubleClickEvent
(self, QMouseEvent)¶
-
mouseMoveEvent
(self, QMouseEvent)¶
-
mousePressEvent
(self, QMouseEvent)¶
-
mouseReleaseEvent
(self, QMouseEvent)¶
-
page
(self) → QWebPage¶
-
pageAction
(self, QWebPage.WebAction) → QAction¶
-
paintEvent
(self, QPaintEvent)¶
-
print
(self, QPrinter)¶
-
print_
(self, QPrinter)¶
-
reload
(self)¶
-
renderHints
(self) → QPainter.RenderHints¶
-
resizeEvent
(self, QResizeEvent)¶
-
selectedHtml
(self) → str¶
-
selectedText
(self) → str¶
-
selectionChanged
¶ selectionChanged(self) [signal]
-
setContent
(self, Union[QByteArray, bytes, bytearray], mimeType: str = '', baseUrl: QUrl = QUrl())¶
-
setHtml
(self, str, baseUrl: QUrl = QUrl())¶
-
setPage
(self, QWebPage)¶
-
setRenderHint
(self, QPainter.RenderHint, enabled: bool = True)¶
-
setRenderHints
(self, QPainter.RenderHints)¶
-
setUrl
(self, QUrl)¶
-
setZoomFactor
(self, float)¶
-
settings
(self) → QWebSettings¶
-
sizeHint
(self) → QSize¶
-
statusBarMessage
¶ statusBarMessage(self, str) [signal]
-
stop
(self)¶
-
title
(self) → str¶
-
titleChanged
¶ titleChanged(self, str) [signal]
-
triggerPageAction
(self, QWebPage.WebAction, checked: bool = False)¶
-
url
(self) → QUrl¶
-
urlChanged
¶ urlChanged(self, QUrl) [signal]
-
wheelEvent
(self, QWheelEvent)¶
-
zoomFactor
(self) → float¶
-
lavuelib.rangeDialog module¶
detector range widget
lavuelib.rangeWindowGroupBox module¶
range window widget
-
class
lavuelib.rangeWindowGroupBox.
RangeWindowGroupBox
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Select how an image should be transformed.
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
changeView
(showrangeWindow=None)[source]¶ show or hide widgets
Parameters: showrangeWindow ( bool
) – widget shown
-
factorChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) factor changed signal
-
function
()[source]¶ provides the reduction function name, i.e. max, min, mean, sum
Returns: function name Return type: str
-
functionChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) function changed signal
-
rangeWindow
()[source]¶ provides the range window
Returns: x1, y1, x2, y2 of range window bounds Return type: list
<int
>
-
rangeWindowChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) range window changed signal
-
setFactor
(factor)[source]¶ provides the current resize factor
Parameters: factor ( int
) – resize factor
-
lavuelib.release module¶
release version
lavuelib.sardanaUtils module¶
sardana utils
-
class
lavuelib.sardanaUtils.
SardanaUtils
[source]¶ Bases:
object
sardanamacro server
constructor
-
getDeviceName
(cname, db=None)[source]¶ finds device of give class
Parameters: - cname (
str
) – device class name - db (
tango.Database
) – tango database
Returns: device name if exists
Return type: - cname (
-
getElementNames
(door, listattr, typefilter=None)[source]¶ provides experimental Channels
Parameters: Returns: names from given pool listattr
Return type:
-
getError
(door)[source]¶ stores Scan Environment Data
Parameters: door ( str
) – door deviceReturns: error or warning Return type: str
-
getMacroServer
(door)[source]¶ door macro server device name
Parameters: door ( str
) – door device nameReturns: macroserver device proxy Return type: tango.DeviceProxy
-
classmethod
getProxies
(names)[source]¶ provides proxies of given device names
Parameters: names ( list
<str
>) – given device namesReturns: list of device DeviceProxies Return type: list
<tango.DeviceProxy
>
-
getScanEnv
(door, params=None)[source]¶ fetches Scan Environment Data
Parameters: door ( str
) – door deviceReturns: JSON String with important variables Return type: str
-
classmethod
openProxy
(device, counter=100)[source]¶ opens device proxy of the given device
Parameters: device ( str
) – device nameReturns: DeviceProxy of device Return type: tango.DeviceProxy
-
classmethod
pickleloads
(bytestr)[source]¶ loads pickle byte string :param bytestr: byte string to convert :type bytesstr:
bytes
:returns: loaded bytestring :rtype:any
-
runMacro
(door, command, wait=True)[source]¶ stores Scan Environment Data
Parameters: Returns: result, error or warning
Return type:
-
-
lavuelib.sardanaUtils.
debugmethod
(method)[source]¶ debug wrapper for methods :param method: any class method :type method:
any
:returns: wrapped class method :rtype:any
-
class
lavuelib.sardanaUtils.
numpyEncoder
(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶ Bases:
json.encoder.JSONEncoder
numpy json encoder with list
Constructor for JSONEncoder, with sensible defaults.
If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.
If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.
If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.
If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.
If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.
If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.
If specified, separators should be an (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘) if indent is
None
and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a
TypeError
.
lavuelib.scalingGroupBox module¶
scalingGroupBox
-
class
lavuelib.scalingGroupBox.
ScalingGroupBox
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QGroupBox
Select how the image intensity is supposed to be scaled.
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
changeView
(showscale=False)[source]¶ shows or hides the histogram widget
Parameters: showhistogram ( bool
) – if histogram should be shown
-
scalingChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) scaling changed signal
-
setScaling
(scaling)[source]¶ sets scaling from string
Parameters: scaling – scaling name, i.e. linear, log or sqrt
-
simpleScalingChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) simple scaling changed signal
-
lavuelib.settings module¶
live viewer image display base it on a qt dialog
-
class
lavuelib.settings.
Settings
[source]¶ Bases:
object
lavue configuration settings
constructor
-
aimutex
= None¶ (
pyqtgraph.QtCore.QMutex
) ai mutex
-
customGradients
()[source]¶ sets source display parameters
Returns: custom gradients Return type: dict
<str
, any>
-
distance2m
(distance)[source]¶ converts distance to m units
Parameters: distance ( float
or (float
,str
)) – distance as value in m or tuple with unitsReturns: distance in m Return type: float
-
distance2mm
(distance)[source]¶ converts distance to mm units
Parameters: distance ( float
or (float
,str
)) – distance as value in m or tuple with unitsReturns: distance in mm Return type: float
-
distance2pixels
(distance, psize)[source]¶ converts distance to pixels
Parameters: Returns: distance in pixels
Return type:
-
distance2um
(distance)[source]¶ converts distance to um units
Parameters: distance ( float
or (float
,str
)) – distance as value in m or tuple with unitsReturns: distance in um Return type: float
-
energy2m
(energy)[source]¶ converts energy to m
Parameters: energy ( float
or (float
,str
)) – energy as value in eV or tuple with unitsReturns: length in m Return type: float
-
length2ev
(length)[source]¶ converts length to energy in eV
Parameters: length ( float
or (float
,str
)) – length as value in A or tuple with unitsReturns: energy in eV Return type: float
-
load
(settings)[source]¶ load settings
Parameters: settings ( pyqtgraph.QtCore.QSettings
) – QSettings objectReturns: error messages list Return type: list
< (str
,str
) >
-
pixelsize2um
(psize)[source]¶ converts pixel size to um units
Parameters: psize ( float
or (float
,str
,float
,str
)) – pixelsize as value in m or tuple with unitsReturns: pixelsize in um Return type: ( float
,float
)
-
seccontext
= None¶ (
zmq.Context
) zmq context
-
secsocket
= None¶ (
zmq.Socket
) zmq security stream socket
-
setCustomGradients
(gradients)[source]¶ sets custom gradients
Parameters: gradients ( dict
<str
, any>) – custom gradients
-
sourceDisplay
(source)[source]¶ gets source display parameters
Parameters: source ( str
) – source nameReturns: display parameter dictionary Return type: dict
<str
, any>
-
store
(settings)[source]¶ Stores settings in QSettings object
Parameters: settings ( pyqtgraph.QtCore.QSettings
) – QSettings object
-
updateMetaData
(**kargs)[source]¶ update physical parameters
Parameters: kargs ( dict
<str
,any
>) – physical parameter dictionary
-
lavuelib.sourceTabWidget module¶
image source selection
-
class
lavuelib.sourceTabWidget.
SourceForm
(parent=None, sourceid=0, usersourcenames=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
source form
constructor
Parameters: -
addCommonWidgets
(sln)[source]¶ add common widgets after given row in the grid layout
Parameters: sln ( int
) – given row in the grid layout
-
addIconClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) add Icon Clicked signal
-
addWidgets
(st, expertmode)[source]¶ add widgets
Parameters: - st (
sourceWidget.SourceBaseWidget
) – source type class - expertmode (
bool
) – expert mode
- st (
(
pyqtgraph.QtCore.pyqtSignal
) push button enabled signal
-
configuration
()[source]¶ provides configuration for the current image source
Returns: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
connectSuccess
(port=None)[source]¶ set connection status on and display connection status
Parameters: port – zmq port
-
currentDataSource
()[source]¶ current data source
Returns: current datasource class name Return type: str
-
currentDataSourceAlias
()[source]¶ current data source name
Returns: current datasource class name alias Return type: str
-
currentDataSourceName
()[source]¶ current data source name
Returns: current datasource class name Return type: str
-
emitButtonEnabled
(status)[source]¶ emit buttonEnabled
Parameters: trans ( bool
) – enabled status of button
-
emitTranslationChanged
(trans)[source]¶ emit translationChanged
Parameters: trans ( str
) – x,y translation, e.g. 50,45
-
gridLayout
()[source]¶ provide grid layout
Returns: grid layout Return type: PyQt5.QtWidgets.QGridLayout
-
isConnected
()[source]¶ is datasource source connected
Returns: if datasource source connected Return type: bool
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
-
pushButtonClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) push button clicked signal
-
pushButtonEnabled
()[source]¶ provide status of push button
Returns: if push button enabled Return type: bool
-
removeIconClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) remove Icon Clicked signal
-
setSourceComboBoxByName
(name)[source]¶ set source by changing combobox by name
Parameters: name ( str
) – combobox name
-
setTranslation
(trans)[source]¶ stores translation of the given source
Param: x,y tranlation, e.g. 2345,354 Type: str
-
showItem
(trans)[source]¶ show items of the widget
Parameters: trans ( bool
) – translation item show status
-
sourceChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source state signal
-
sourceLabelChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source label name signal
-
sourceStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source state signal
-
translationChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) translation changed signal
-
updateMetaData
(**kargs)[source]¶ update source input parameters
Parameters: kargs ( dict
<str
,any
>) – source widget input parameter dictionary
-
-
class
lavuelib.sourceTabWidget.
SourceTabWidget
(parent=None, sourcetypes=None, expertmode=False, nrsources=1)[source]¶ Bases:
PyQt5.QtWidgets.QTabWidget
image source selection
constructor
Parameters: -
addIconClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) add Icon Clicked
-
addTab
(widget, title)[source]¶ add tab widget
Parameters: - widget (
pyqtgraph.QtWidgets.QWidget
) – tab widget - title (
str
) – tab title
- widget (
-
configuration
()[source]¶ provides configuration for the current image source
Returns: configuration string Rtype configuration: str
-
connectSuccess
(port=None)[source]¶ set connection status on and display connection status
Parameters: port – zmq port
-
currentDataSourceAlias
()[source]¶ current data source name alias
Returns: current datasource class name alias Return type: str
-
currentDataSourceNames
()[source]¶ current data source name
Returns: current datasource class name Return type: str
-
currentDataSources
()[source]¶ current data source
Returns: current datasource class name Return type: str
-
isChecked
(sid)[source]¶ check if tab is active
Parameters: sid ( int
) – source idReturns: check state Return type: int
-
isConnected
()[source]¶ is datasource source connected
Returns: if datasource source connected Return type: bool
-
removeIconClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) remove Icon Clicked
-
setNumberOfSources
(nrsources)[source]¶ set a number of image sources
Parameters: nrsources ( int
) – a number of image sources
-
setTranslation
(trans, sid)[source]¶ stores translation of the given source
Param: x,y tranlation, e.g. 2345,354 Type: str
Parameters: sid ( int
) – source id
-
showItem
(trans)[source]¶ show items of the widget
Parameters: trans ( bool
) – translation item show status
-
sourceChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source state signal
-
sourceConnected
¶ (
pyqtgraph.QtCore.pyqtSignal
) source connected signal
-
sourceDisconnected
¶ (
pyqtgraph.QtCore.pyqtSignal
) source disconnected signal
-
sourceLabelChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source label name signal
-
sourceStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source state signal
-
translationChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) translation changed signal
-
updateMetaData
(**kargs)[source]¶ update source input parameters
Parameters: kargs ( dict
<str
,any
>) – source widget input parameter dictionary
-
lavuelib.sourceWidget module¶
image source selection
-
class
lavuelib.sourceWidget.
SourceBaseWidget
(sourceid=0, parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
general source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
addIconClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) add Icon Clicked
(
pyqtgraph.QtCore.pyqtSignal
) push button enabled signal
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventObjectFilter
(event, combobox, varname, atdict, atlist)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
-
removeIconClicked
¶ (
pyqtgraph.QtCore.pyqtSignal
) remove Icon Clicked
-
sourceLabelChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source label name signal
-
sourceStateChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) source state signal
- sourceid (
-
class
lavuelib.sourceWidget.
HidraSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
HTTPSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
TangoAttrSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
TangoEventsSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
TangoFileSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
-
updateMetaData
(tangofileattrs=None, tangodirattrs=None, dirtrans=None, nxsopen=None, nxslast=None, **kargs)[source]¶ update source input parameters
Parameters: - tangofileattrs (
str
) – json dictionary with (label, file tango attribute) items - tangodirattrs (
str
) – json dictionary with (label, dir tango attribute) items - dirtrans (
str
) – json dictionary with directory and file name translation - nxsopen (
bool
) – nexus file source keeps the file open - nxslast (
bool
) – nexus file source starts from the last image - kargs (
dict
<str
,any
>) – source widget input parameter dictionary
- tangofileattrs (
- sourceid (
-
class
lavuelib.sourceWidget.
DOOCSPropSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
ZMQSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
-
updateMetaData
(zmqtopics=None, autozmqtopics=None, datasources=None, disconnect=True, zmqservers=None, **kargs)[source]¶ update source input parameters
Parameters: - zmqtopics (
list
<str
> >) – zmq source topics - autozmqtopics (
bool
) – automatic zmq topics enabled - datasources (
list
<str
> >) – automatic zmq source topics - disconnect (
bool
) – disconnect on update - zmqservers (
str
) – json dictionary with (label, zmq servers) items - kargs (
dict
<str
,any
>) – source widget input parameter dictionary
- zmqtopics (
- sourceid (
-
class
lavuelib.sourceWidget.
NXSFileSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
TinePropSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns: configuration string Return type: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
EpicsPVSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
eventFilter
(obj, event)[source]¶ event filter
Parameters: - obj – qt object
- event – qt event
Returns: status flag
Return type:
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
- sourceid (
-
class
lavuelib.sourceWidget.
ASAPOSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
-
configuration
()[source]¶ provides configuration for the current image source
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current image source
Parameters: configuration ( str
) – configuration string
-
label
()[source]¶ return a label of the current detector
Returns: label of the current detector Return type: str
-
updateMetaData
(asaposerver=None, asapotoken=None, asapobeamtime=None, asapodatasources=None, asapostreams=None, asaposourcepath=None, disconnect=True, **kargs)[source]¶ update source input parameters
:param asaposervers asapo servers, i.e. host:port :type asaposervers:
str
:param asapotoken: asapo token :type asapotoken:str
:param asapobeamtime: beamtime id :type asapobeamtime:str
:param asapodatasources: asapo datasource names :type asapodatasources:list
<str
> > :param asapostreams: asapo stream names :type asapostreams:list
<str
> > :param asaposourcepath: source path :type asaposourcepath:str
:param disconnect: disconnect on update :type disconnect:bool
:param kargs: source widget input parameter dictionary :type kargs:dict
<str
,any
>
- sourceid (
-
class
lavuelib.sourceWidget.
TestSourceWidget
(sourceid=0, parent=None)[source]¶ Bases:
lavuelib.sourceWidget.SourceBaseWidget
test source widget
constructor
Parameters: - sourceid (
int
) – source id - parent (
pyqtgraph.QtCore.QObject
) – parent object
- sourceid (
-
lavuelib.sourceWidget.
swproperties
= [{'alias': 'hidra', 'name': 'Hidra', 'widget': 'HidraSourceWidget', 'requires': ('HIDRA',)}, {'alias': 'http', 'name': 'HTTP response', 'widget': 'HTTPSourceWidget', 'requires': ('REQUESTS',)}, {'alias': 'tangoattr', 'name': 'Tango Attribute', 'widget': 'TangoAttrSourceWidget', 'requires': ('TANGO',)}, {'alias': 'tangoevents', 'name': 'Tango Events', 'widget': 'TangoEventsSourceWidget', 'requires': ('TANGO',)}, {'alias': 'tangofile', 'name': 'Tango File', 'widget': 'TangoFileSourceWidget', 'requires': ('TANGO',)}, {'alias': 'doocsprop', 'name': 'DOOCS Property', 'widget': 'DOOCSPropSourceWidget', 'requires': ('PYDOOCS',)}, {'alias': 'zmq', 'name': 'ZMQ Stream', 'widget': 'ZMQSourceWidget', 'requires': ()}, {'alias': 'nxsfile', 'name': 'NeXus File', 'widget': 'NXSFileSourceWidget', 'requires': ()}, {'alias': 'tineprop', 'name': 'Tine Property', 'widget': 'TinePropSourceWidget', 'requires': ('PYTINE',)}, {'alias': 'epicspv', 'name': 'Epics PV', 'widget': 'EpicsPVSourceWidget', 'requires': ('PYEPICS',)}, {'alias': 'asapo', 'name': 'ASAPO', 'widget': 'ASAPOSourceWidget', 'requires': ('ASAPO',)}, {'alias': 'test', 'name': 'Test', 'widget': 'TestSourceWidget', 'requires': ()}]¶
lavuelib.statisticsGroupBox module¶
statistics widget
-
class
lavuelib.statisticsGroupBox.
StatisticsGroupBox
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QGroupBox
Display some general image statistics.
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object
lavuelib.takeMotorsDialog module¶
motor device widget
-
class
lavuelib.takeMotorsDialog.
TakeMotorsDialog
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QDialog
detector geometry widget class
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
motortips
= None¶ (
list`<:obj:`str
>) motortips list
-
xmotordevice
= None¶ (
tango.DeviceProxy
) x motor device
-
ymotordevice
= None¶ (
tango.DeviceProxy
) y motor device
-
lavuelib.toolWidget module¶
image widget
-
class
lavuelib.toolWidget.
IntensityToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
intensity tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
-
class
lavuelib.toolWidget.
ROIToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
roi tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
applyROIPressed
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply ROI pressed signal
-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
fetchROIPressed
¶ (
pyqtgraph.QtCore.pyqtSignal
) fetch ROI pressed signal
-
roiInfoChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi info Changed signal
-
signal2slot
= None¶ (
list
< [pyqtgraph.QtCore.pyqtSignal
,str
] >) list of [signal, slot] object to connect
-
updateROIButton
(enabled)[source]¶ enables/disables ROI buttons
Parameters: enable ( bool
) – buttons enabled
-
-
class
lavuelib.toolWidget.
LineCutToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
line-cut tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
-
class
lavuelib.toolWidget.
AngleQToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
angle/q tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
beforeplot
(array, rawarray)[source]¶ command before plot
Parameters: - array (
numpy.ndarray
) – 2d image array - rawarray (
numpy.ndarray
) – 2d raw image array
Returns: 2d image array and raw image
Return type: - array (
-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
-
class
lavuelib.toolWidget.
MotorsToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
motors tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
-
class
lavuelib.toolWidget.
MeshToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
mesh tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
roiInfoChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi info Changed signal
-
-
class
lavuelib.toolWidget.
OneDToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
1d plot tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
beforeplot
(array, rawarray)[source]¶ command before plot
Parameters: - array (
numpy.ndarray
) – 2d image array - rawarray (
numpy.ndarray
) – 2d raw image array
Returns: 2d image array and raw image
Return type: - array (
-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
-
class
lavuelib.toolWidget.
ProjectionToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
Projections tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
-
class
lavuelib.toolWidget.
MaximaToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
maxima tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
beforeplot
(array, rawarray)[source]¶ command before plot
Parameters: - array (
numpy.ndarray
) – 2d image array - rawarray (
numpy.ndarray
) – 2d raw image array
Returns: 2d image array and raw image
Return type: - array (
-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
-
class
lavuelib.toolWidget.
ParametersToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
motors tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
convert
= {'bool': <bound method Converters.toBool of <class 'lavuelib.toolWidget.Converters'>>, 'float': <class 'float'>, 'float16': <class 'float'>, 'float32': <class 'float'>, 'float64': <class 'float'>, 'int': <class 'int'>, 'int16': <class 'int'>, 'int32': <class 'int'>, 'int64': <class 'int'>, 'int8': <class 'int'>, 'str': <class 'str'>, 'string': <class 'str'>, 'uint': <class 'int'>, 'uint16': <class 'int'>, 'uint32': <class 'int'>, 'uint64': <class 'int'>, 'uint8': <class 'int'>}¶ (
dict
<str
,type
ortypes.MethodType
>) map of type : converting function
-
-
class
lavuelib.toolWidget.
DiffractogramToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
diffractogram tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
beforeplot
(array, rawarray)[source]¶ command before plot
Parameters: - array (
numpy.ndarray
) – 2d image array - rawarray (
numpy.ndarray
) – 2d raw image array
Returns: 2d image array and raw image
Return type: - array (
-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
runProgress
(commands, onclose='_closeReset', text='Updating diffractogram ranges ...')[source]¶ starts progress thread with the given commands
Parameters:
-
setColors
(colors=None, force=False)[source]¶ sets colors
Parameters: colors ( str
) – json list of roi colorsReturns: change status Return type: bool
-
-
class
lavuelib.toolWidget.
QROIProjToolWidget
(parent=None)[source]¶ Bases:
lavuelib.toolWidget.ToolBaseWidget
angle/q +roi + projections tool widget
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
applyROIPressed
¶ (
pyqtgraph.QtCore.pyqtSignal
) apply ROI pressed signal
-
configuration
()[source]¶ provides configuration for the current tool
Returns configuration: configuration string Rtype configuration: str
-
configure
(configuration)[source]¶ set configuration for the current tool
Parameters: configuration ( str
) – configuration string
-
fetchROIPressed
¶ (
pyqtgraph.QtCore.pyqtSignal
) fetch ROI pressed signal
-
roiInfoChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) roi info Changed signal
-
signal2slot
= None¶ (
list
< [pyqtgraph.QtCore.pyqtSignal
,str
] >) list of [signal, slot] object to connect
-
updateROIButton
(enabled)[source]¶ enables/disables ROI buttons
Parameters: enable ( bool
) – buttons enabled
-
-
lavuelib.toolWidget.
twproperties
= [{'alias': 'intensity', 'name': 'Intensity', 'widget': 'IntensityToolWidget', 'requires': ()}, {'alias': 'roi', 'name': 'ROI', 'widget': 'ROIToolWidget', 'requires': ()}, {'alias': 'linecut', 'name': 'LineCut', 'widget': 'LineCutToolWidget', 'requires': ()}, {'alias': 'angle/q', 'name': 'Angle/Q', 'widget': 'AngleQToolWidget', 'requires': ()}, {'alias': 'movemotors', 'name': 'MoveMotors', 'widget': 'MotorsToolWidget', 'requires': ('TANGO',)}, {'alias': 'meshscan', 'name': 'MeshScan', 'widget': 'MeshToolWidget', 'requires': ('TANGO',)}, {'alias': '1d-plot', 'name': '1d-Plot', 'widget': 'OneDToolWidget', 'requires': ()}, {'alias': 'projections', 'name': 'Projections', 'widget': 'ProjectionToolWidget', 'requires': ()}, {'alias': 'maxima', 'name': 'Maxima', 'widget': 'MaximaToolWidget', 'requires': ()}, {'alias': 'parameters', 'name': 'Parameters', 'widget': 'ParametersToolWidget', 'requires': ('TANGO',)}, {'alias': 'diffractogram', 'name': 'Diffractogram', 'widget': 'DiffractogramToolWidget', 'requires': ('PYFAI',)}, {'alias': 'q+roi+proj', 'name': 'Q+ROI+Proj', 'widget': 'QROIProjToolWidget', 'requires': ()}]¶
lavuelib.transformationsWidget module¶
transformation widget
-
class
lavuelib.transformationsWidget.
TransformationsWidget
(parent=None)[source]¶ Bases:
PyQt5.QtWidgets.QWidget
Select how an image should be transformed.
constructor
Parameters: parent ( pyqtgraph.QtCore.QObject
) – parent object-
setEnable
(flag)[source]¶ disables or enables the combobox
Parameters: flag ( bool
) – combobox to be enabled
-
setKeepCoordsLabel
(flag, transpose=False)[source]¶ sets keep original coordinates label according to flag
Parameters: flag ( bool
) – keep original coordinates flag
-
setTransformation
(tname)[source]¶ sets transformation from the string
Parameters: tname ( str
) – transfromation name
-
transformationChanged
¶ (
pyqtgraph.QtCore.pyqtSignal
) transformation changed signal
-
Module contents¶
Live Viewer widgets