lavue-org / lavue

Lightweight Live Viewer

LaVue - Live Image Viewer

Authors: Christoph Rosemann <christoph.rosemann at desy.de>, Jan Kotański <jan.kotanski at desy.de>, André Rothkirch <andre.rothkirch at desy.de>

Introduction

This is a simple implementation of a live viewer front end. It is supposed to show a live image view from xray-detectors at PETRA3 @ desy.de, e.g. Pilatus, Lambda, Eiger, PerkinElmer, PCO, LimaCCD, and others.

Installation

LaVue requires the following python packages: qt5/qt4 pyqtgraph numpy zmq scipy

It is also recommended to install: pytango hidra pil fabio requests h5py pni nxstools

From sources

Download the latest LaVue version from https://github.com/lavue-org/lavue

Extract sources and run

$ python setup.py install

The setup.py script may need: setuptools sphinx numpy pytest python packages as well as qtbase5-dev-tools or libqt4-dev-bin.

Debian packages

Debian bullseye, buster or Ubuntu lunar, jammy, focal packages can be found in the HDRI repository.

To install the debian packages, add the PGP repository key

$ sudo su
$ curl -s http://repos.pni-hdri.de/debian_repo.pub.gpg  | gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/debian-hdri-repo.gpg --import
$ chmod 644 /etc/apt/trusted.gpg.d/debian-hdri-repo.gpg

and then download the corresponding source list, e.g.

$ cd /etc/apt/sources.list.d

and

$ wget http://repos.pni-hdri.de/bullseye-pni-hdri.list

or

$ wget http://repos.pni-hdri.de/buster-pni-hdri.list

or

$ wget http://repos.pni-hdri.de/jammy-pni-hdri.list

or

$ wget http://repos.pni-hdri.de/focal-pni-hdri.list

respectively.

Finally,

$ apt-get update
$ apt-get install python3-lavue
$ apt-get install lavue-controller

or

$ apt-get install lavue-controller3

for python 3 version (for older debian/ubuntu releases).

From pip

To install it from pip you need to install pyqt5 in advance, e.g.

$ python3 -m venv myvenv
$ . myvenv/bin/activate

$ pip install PyQtWebKit

or

$ pip install pyqt5

or

$ pip install PyQt5==5.14

and then

$ pip install lavue

Moreover it is also good to install the following python packages:

$ pip install fabio
$ pip install pillow
$ pip install pyFAI
$ pip install lavuefilters
$ pip install pytango

Start the Viewer

To start LaVue

$ lavue

or

$ lavue3

for python 3 version (for older debian/ubuntu releases).

Start the Viewer in the expert mode

Changing LaVue settings is available in the expert mode, i.e.

$ lavue -m expert

under an additional button: Configuration.

Launching options

To get all possible command-line parameters

$ lavue -h

Further reading

More information can be found at: LaVue

Conflunce page: https://confluence.desy.de/display/FSEC/LaVue+-+Live+Image+Viewer

LavueController Tango Server API: https://lavue-org.github.io/lavue/stable/doc_html

lavue's Issues

zmq and http source stored in the configuration

Request from users:

2. When using zmq, tango-attributes, or the http source it's a bit
   annoying that you always have to put in these usually long and cryptic
   addresses manually. It would be nice if one could store some favorites
   somewhere, or predefine them in config like it's done with the hidra
   sources. However, I think manual input should still be possible to stay
   flexible.

rois values in LavueController server

We get requests to ad rois values to LavueController server

add support for taurus

We get requests to make lavue widgets reusable in taurus

extend a width of cuts

We got request to extend width of the cuts, i.e. make it set-able.

get metadata information from cbf

We get request to fetch detector metadata from cbf headers.

accumulate 1d plots on 2d plot: line cuts

It was split from #53: request to add to line cut tool a possibility to accumulate plots on 2d image

add automatic scaling levels with percents

Our users request to select scaling levels automatically with respect of % of the maximum pick height.

accumulate 1d plots on 2d plot: 1d plot

It was split from #53 , i.e. request to add to 1d-plot tool possibility to accumulate plots on 2d image

add support for reading SPE files

LCX detector creates SPE file. There is a need to support it.

Moved from syncope#38

Pass transpose and flips parameters to LavueController

It would be good to have possibility to read flips and transpose parameters from LavueController server

accumulate 1d plots on 2d plot: polar integration (in q-space)

It was split from #53: request to add to angle/q tool a possibility to accumulate plots on 2d image

dynamic help for comboboxes

It would be nice to ad dynamic help gor image sources and image tools comboboxes with description of current item

Save custom color gradient

We have been using LaVue for EIGER2 data at the Australian synchrotron, since the new Dectris API broke the live-view functionality of ALBULA due to a change in the monitor interface: we use a gradient to mimic ALBULA's default high-contrast scale which we were used to for EIGER, plus a blue clipping indicator: {0.0: white, 0.15: black, 0.4: red, 0.7: yellow, 0.99: white, 1.0: blue}

It's great that you can define a custom color gradient in the widget, it would also be nice to be able to save one or more user-defined gradients, or alternatively specify a custom gradient from a command line JSON.

add intensity values in large zoom

I would be nice to have intensity values displayed in a large zoom mode

support linecuts with qspace

it was a question to support linecuts with qspace

set lavue configuration from the spock

User request:

1. It would be great if one could change some of the settings in lavue
   (e.g. region of interest, central pixel, energy, etc.) through some remote
   interface. The idea behind that is that I would like to change these
   things from spock, because at least in our setup at the beamline spock we
   have define most of the in spock anyway and then it would be very
   convenient if the information could be transferred automatically to lavue.
   I discussed a bit with Jan Garrevoet about this and he suggested to set up
   a special tango server to pass the information to lavue to avoid that it
   becomes too much interlinked with spock and can still be used
   independently. One thing which would be also a bit tricky is that it
   should also work with multiple instances of lavue (e.g. for monitoring
   several detectors at the same time). I guess each instance of lavue would
   then need its own tango device and one would need to specify, may be with
   a flag during startup, which device is used for this instance.

add help with documentation

it would be good to add help with documentation e.g. in manu bar

tiff loader for eiger4m files does not work

there is a need to improve TIFF loader

the beam centre is not transformed

if you transform the image, the beam centre is not transformed.

add support for python3

It is request from debian stretch to support for python3

mask 0/1 selection

user should have possibility to choose if in the mask file zero or non-zero is a bad pixel.

display original coordinates

The user request:

5. I'm not sure if Jan has already talked to you about this, but we
   recently had a discussion if the beam center should use the "real" image
   coordinates or the transformed coordinates (if image transformations are
   applied). I think we concluded that both options might be required
   depending on the use case. Therefore, it would be nice to have the
   possibility to change this somewhere in the settings and have a message
   somewhere. This is in principle similar to the problem, if the log-scaling
   etc should be applied for the image statistics or not.
   As far as I know the coordinate system problem also applies to the roi
   mode. Maybe one could have the same option there to select either "real"
   image coordinates or transformed coordinates

rois labels on the image

I've got a request to put numbers nearby roi handlers.

cross marking in qspace

Request from uses:

4. It looks like there is a bug with the red cross in the angle/q-value
   mode. When I lock it in the intensity mode and switch to angle/q it
   remains locked, if it wasn't locked it stays not locked and while in
   angle/q mode there is no way to change it. In angle/q mode it would be
   nice to have a cross marking the beam center. I'm not sure if one can just
   use the current red cross for that and just fix its position to the beam
   center in angle/q mode or to have a separate one to make sure that this is
   something different.

add version number in the title

It would be good to show version number in the lavue title

add logging system

i would be good to store logging information in var files.

Moved from: syncope#50

store settings related to particular detectors

Our users request to store settings related to particular detectors

split ImageDisplayWidget

It would be nice to split imageDisplayWidget class into parts. Split parts can be added into the main class as pluggable extensions

polar plots in Angle/q tool

We get a request from a user to add for polar plots in Angle/q tool

make color of ROIs changeable

We get requests from users to make ROI colors changeable.

display plots for many cuts

It was a request to display plots for many cuts

add support for .mar* files

MAR345 and MAR555 create .mar* files. There is a need to support them.

Moved from: syncope#39

add resolution rings

I would be nice to have resoultion rings

msgpack protocol in the ZMQ source

we had request to support a msgpack protocol in the ZMQ source. It could be implemented similarly to CPICKLE and JSON.

Moved from syncope#48

commandline flag to set lavue

Request from users:

3. It would be nice if one could set a command line flag when starting
   lavue to automatically select a certain datasource.

add a combobox to choise preselected tango device

We have request to add a add a combobox to choise preselected tango device in TangoAttribute source

add shortcut button for adding labels of input source parameters

We received request to add shortcut button for adding labels of input source parameters

file index and file name pattern in Tango File Source

It would be good to add support for detectors which provides as in tango attributes:
FileDir, FilePattern and FileIndex (e.g. for SPE)

Moved from: syncope#40

ROIS QSPACE PROJECTIONS in one tool

Request from users:

6. I think we already discussed a bit about combining several of the
   display modes and the conclusion was to have a separate entry for the
   combination that we would like to have: I think what would be most
   interesting for me at the moment is combining angle/q, rois and
   projections

'AngleQToolWidget' object has no attribute '_AngleQToolWidget__energy'

I was just trying lavue with the eiger and using the Angle/Q tool. When selecting angle it updates the cursor position and angle text box but when you switch to q-range it does not update this.

add Tango Events source

we get request to add image sources which get images from Tango Events

allows loading mask and background images from nexus file

It would be nice to have possibility to load mask and background images from nexus/hdf5 files

add widgets to edit qlineedit text with dictionary

It would be convinient to add widgets to edit qlineedit with dictionary

show the most intensive pixels

Our users request ability to show position and intensity of the most intensive pixels

add an error message when in a nexus file there is no image to read

It would be nice to receive an error message when there is no image to read in a nexus/hdf5 file

Improve tango attribute source

We had request to predefine possible tango attributes. It can be done by adding an editable combobox into the source widget.

store parameter for q-space in the config file

We get request to store parameters for the q-space tool in the lavue configuration file

accumulate 1d plots on 2d plot

We have a request to ad to 1d-plot tool possibility to accumulate plots on 2d image

add axis scales and labels for MoveMotor and MeshScan tools

hidra server combobox editable

I would nice to male the hidra server combobox editable that the user can put a server name in the image source widget.