mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-22 11:50:03 +02:00
release notes
This commit is contained in:
parent
a42ef3b591
commit
843edfbf06
699
RELEASE.txt
699
RELEASE.txt
@ -14,139 +14,46 @@ This document describes the differences between v7.0.0.rc1 and v6.1.2
|
||||
5. Download, Documentation & Support
|
||||
|
||||
|
||||
Breaking API Resolved Issues
|
||||
============================
|
||||
|
||||
|
||||
1. New or Changed Features
|
||||
==========================
|
||||
|
||||
Client
|
||||
------
|
||||
|
||||
. Versioning
|
||||
The client, receiver and detector servers now have semantic Versioning
|
||||
along with the date and are managed with the Version class.
|
||||
|
||||
--version argument to the executable gives the complete versioning with date.
|
||||
|
||||
Using the client to get versions gives only the semantic version. An older
|
||||
server will still give date. Hence, the return type is a string.
|
||||
|
||||
Compatibility checks at hostname or rx_hostname command will only be for
|
||||
backwards compatibility (ie. it only checks for the major version number).
|
||||
If its an old server, then its expected to have the exact same date (as
|
||||
before)
|
||||
|
||||
Setting intitialchecks to 0 also bypasses the receiver compatibility check.
|
||||
|
||||
|
||||
. Detector Specific fields
|
||||
bunchid ->detSpec1
|
||||
reserved->detSpec2
|
||||
debug->detSpec3
|
||||
roundRnumber->detSpec4
|
||||
|
||||
Further details about each detector specific field can be found at:
|
||||
https://slsdetectorgroup.github.io/devdoc/udpdetspec.html
|
||||
|
||||
|
||||
. [Eiger] Number of UDP interfaces
|
||||
Command line: numinterfaces, API: getNumberofUDPInterfaces
|
||||
This command now reflects the actual number of udp interfaces for Eiger,
|
||||
which is 2.
|
||||
|
||||
. [Moench] Patsetbit and patsetmask
|
||||
Command line: patsetbit API: getPatternBitMask/ setPatternBitMask
|
||||
Command line: patmask API: getPatternMask/ setPatternMask
|
||||
|
||||
Exchanging the help and masks for patsetbit and patsetmask in the detector
|
||||
server, especially in loading settings.
|
||||
|
||||
|
||||
. [Eiger] Datastream only for 10GbE
|
||||
Command line: datastream, API: getDataStream/ setDataStream
|
||||
|
||||
This command to enable/ disable data stream from left or right port
|
||||
is now allowed only for 10GbE. Previously, it incorrectly allowed to do so.
|
||||
|
||||
|
||||
. Non-blocking start
|
||||
Allow non-blocking start at modular level again.
|
||||
|
||||
|
||||
. [Gotthard][Gotthard2] Num modules
|
||||
Only 2 modules allowed maximum in a detector shared memory.
|
||||
|
||||
. CopyDetectorServer
|
||||
|
||||
Python
|
||||
-------
|
||||
|
||||
. Python sub-microsecond resolution
|
||||
Reading back sub-microsecond exposure times from the Python API fixed by
|
||||
addig Python datetime supports only micro seconds as lowest unit.
|
||||
|
||||
This is fixed by introducing a new C++ type (DurationWrapper), which
|
||||
holds number of nanoseconds as a uint64_t (only in python bindings) and
|
||||
custom typecaster to convert to and from std::chrono::nanoseconds.
|
||||
|
||||
A get using API now returns in DurationWrapper, instead of datetime.
|
||||
Refer exptime help for examples.
|
||||
|
||||
|
||||
Detector Server
|
||||
---------------
|
||||
|
||||
. Deprecated CopyDetectorServer
|
||||
Command line: copydetectorserver, API: copydetectorserver
|
||||
Removed. Use updatedetectorserver
|
||||
|
||||
Simulator
|
||||
---------
|
||||
|
||||
. [Eiger] Only one executable
|
||||
Only one executable for an Eiger virtual server. Master and top mode
|
||||
can be provided via command line or config file to the detector server,
|
||||
as well as via the client. See in Other New Features for more details.
|
||||
|
||||
One can start a module using:
|
||||
eigerDetectorServer_virtual # reads default config file (top master)
|
||||
eigerDetectorServer_virtual -i #ignores the config file (bottom slave)
|
||||
|
||||
|
||||
Receiver
|
||||
--------
|
||||
|
||||
. Arping for 10GbE
|
||||
Command line: rx_arping API: getRxArping/ setRxArping
|
||||
Starts a thread in the receiver to arping the interface it is listening
|
||||
to in 10GbE mode every 60 s.
|
||||
Changes NUM_RX_THREAD_IDS (sls_detector_defs.h) from 8 to 9.
|
||||
|
||||
. File write
|
||||
File write is disabled by default.
|
||||
|
||||
. Missing packets
|
||||
Command line: rx_missingpackets, API: getNumMissingPackets
|
||||
This now returns a signed 64 bit instead of unsigned. The negative polarity
|
||||
depicts extra packets instead of missing packets and also takes care of
|
||||
disabled ports.
|
||||
|
||||
. Frames caught and frame index
|
||||
Command line rx_framescaught, rx_frameindex, API: getFramesCaught/ getRxCurrentFrameIndex
|
||||
They now return a vector for each port when there are 2 udp interfaces
|
||||
in the receiver.
|
||||
|
||||
. Geometry metadata
|
||||
Added geometry (number of modules in each direction) to metadata in file.
|
||||
|
||||
. HDF5 and Binary writer version
|
||||
Changed from 6.3 to 6.4
|
||||
|
||||
|
||||
. Master file format to json
|
||||
The format has been changed from ASCII to json.
|
||||
|
||||
. Master file created at end of acquisition
|
||||
The file is now written at the end of acquisition. So if any metadata
|
||||
is changed during an acquisition, it will reflect the last value.
|
||||
|
||||
|
||||
Callback
|
||||
--------
|
||||
|
||||
. Datatype of Metadata [registerCallBackRawDataReady, registerCallBackRawDataModifyReady]
|
||||
Datatype changed from char* to sls_receiver_header*.
|
||||
|
||||
|
||||
. Datatype of Size [registerCallBackRawDataReady, registerCallBackRawDataModifyReady]
|
||||
Datatype changed from uint32_t to size_t
|
||||
|
||||
. Datatype of file name and file path [registerCallBackStartAcquisition]
|
||||
Datatype changed from string to const string reference.
|
||||
|
||||
. Incorrect image size [registerCallBackStartAcquisition]
|
||||
Fixed. It used to give +120 bytes.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Other New or Changed Features
|
||||
==========================
|
||||
|
||||
Client
|
||||
------
|
||||
|
||||
. [Moench][Ctb] Starting frame number
|
||||
Command line: nextframenumber, API: getNextFrameNumber/ setNextFrameNumber
|
||||
Added and default set up on detector server start up.
|
||||
@ -154,18 +61,22 @@ Breaking API Resolved Issues
|
||||
. [Eiger] Vtr
|
||||
Allow Vtrim to be interpolated for settings.
|
||||
|
||||
. Namespace sls
|
||||
All files in slsSupportLib and tests have now been moved to sls namespace
|
||||
including macros. Using the LOG, for example, will require the sls qualifier.
|
||||
|
||||
. [Eiger][Gotthard][Gotthard2][Mythen3] Master
|
||||
|
||||
. [Eiger][Gotthard][Gotthard2][Mythen3][Jungfrau] Master
|
||||
|
||||
Setting up from client:
|
||||
[Eiger][Gotthard2][Jungfrau]
|
||||
Command line: master, API: getMaster/ setMaster
|
||||
All of them can get master mode from the client.
|
||||
|
||||
Only Eiger can set a half module to master or slave from the client.
|
||||
The others can set this only in a virtual server.
|
||||
|
||||
Setting up on the detector or virtual server:-
|
||||
[Eiger][Gotthard2][Mythen3][Gotthard]
|
||||
Setting up on the detector or virtual server:
|
||||
[Eiger][Gotthard2 Virtual][Mythen3 Virtual][Gotthard Virtual]
|
||||
Using command line 'master' or 'm' with argument (slave=0, master=1)
|
||||
[Eiger][Gotthard]
|
||||
[Eiger][Gotthard2][Gotthard]
|
||||
Using config file with 'master' with argument (slave=0, master=1)
|
||||
|
||||
. [Eiger] Top
|
||||
@ -188,16 +99,235 @@ Breaking API Resolved Issues
|
||||
getPumpProbe/ setPumpProbe, getAnalogPulsing/ setAnalogPulsing,
|
||||
getDigitalPulsing/ setDigitalPulsing
|
||||
|
||||
Added these commands. Enabling interpolation will also enable all counters.
|
||||
Added these commands.
|
||||
|
||||
Enabling interpolation will also enable all counters and disable vth3.
|
||||
Disabling sets to previous counter mask and previous vth values.
|
||||
|
||||
In pump probe mode, only vth2 enabled. Disabling sets vth2 to prevevious
|
||||
value.
|
||||
|
||||
Setting counter mask will check interpolation and pump probe mode
|
||||
requirements, else sets vthx dacs according to counter mask.
|
||||
|
||||
Direct overwrite of any dac (including vthx) allowed using dac command
|
||||
(as before).
|
||||
|
||||
|
||||
. [Mythen3][Eiger] Save settings file
|
||||
Command line: trimbits (sls_detector_get), API: saveTrimbits
|
||||
Added
|
||||
|
||||
. [Mythen3] Threshold
|
||||
When settings trimbits or threshold, counter mask is set and hence,
|
||||
vthx dacs are set accordingly.
|
||||
|
||||
setAllThresholdEnergy takes 3 values for each counter and if one of them
|
||||
is -1, the trimbits and setings for that counter is picked up from the
|
||||
detector.
|
||||
|
||||
. Udp Source IP
|
||||
Command line: udp_srcip(2), API: getSourceUDPIP(2)/ setSourceUDPIP(2)
|
||||
One can also set this to 'auto' for 1 GbE data. It will set to IP of
|
||||
rx_hostname (as in udp_dstip)
|
||||
|
||||
|
||||
. Storage cells in running receiver
|
||||
Allowing the possibility to set this when receiver in running state.
|
||||
|
||||
. [Gotthard2] Adapt to new HDI version
|
||||
HDI module ID written to FPGA register
|
||||
|
||||
. [Gotthard2] Parallel readout added
|
||||
Command line: parallel, API: getParallelMode/ setParallelMode
|
||||
Default for Gotthard2 is parallel. Non parallel mode only works in
|
||||
continuous mode.
|
||||
|
||||
. [Jungfrau] Software trigger added
|
||||
Command line: trigger, API: sendSoftwareTrigger
|
||||
Send software trigger instead of harware trigger.
|
||||
|
||||
. [Eiger][Jungfrau] Blocking trigger
|
||||
Commandline: blockingtrigger, API: sendSoftwareTrigger with argument true
|
||||
Sends software trigger signal to detector and blocks until the frames
|
||||
are sent out for that trigger.
|
||||
|
||||
. [Jungfrau] Sync
|
||||
Command line: sync, API: getSynchronization/ setSynchronization
|
||||
Enables or disables synchronization between modules
|
||||
|
||||
. [Moench][Ctb][Mythen3] Deprecated commands
|
||||
Patloopx, patnloopx, patwaitx, patwaittimex
|
||||
Please use instead patloop, patnloop, patwait and patwaittime commands
|
||||
with the level as an argument.
|
||||
|
||||
Old commands work with warning, but the server expects the new ones
|
||||
such as a default pattern file to be loaded at startup for Moench.
|
||||
|
||||
Renamed patternParameters struct member from 'loop' to 'startloop' and
|
||||
'stoploop'.
|
||||
|
||||
|
||||
. [Moench][Ctb] Pattern levels
|
||||
Changed from 3 to 6.
|
||||
|
||||
. [Mythen3][Moench][Ctb] Default patwait and patloop addresses
|
||||
Set default wait and loop addresses to 0x1fff (max value) for all levels
|
||||
before loading pattern. Please use the pattern command instead of parameters.
|
||||
This ensures defaults are set up and is faster.
|
||||
|
||||
. [Mythen3] Bad channels
|
||||
Command line: badchannels, API: getBadChannels/ setBadChannels
|
||||
Set bad channels from file with a list of channels, which will be masked
|
||||
out. Also does trimming. A detector level command will require the channel
|
||||
numbers accordingly. The file also extended to include commas, colons range)
|
||||
and removes duplicates.
|
||||
|
||||
. Incrementing default receiver tcp port
|
||||
Automatically incrementing the default receiver tcp port for every module
|
||||
when creating shared memory.
|
||||
|
||||
. [Gotthard2][Mythen3] Temperature readout
|
||||
Command line: temp_fpga, API: getTemperature with TEMPERATURE_FPGA enum
|
||||
Added
|
||||
|
||||
. [Gotthard2][Mythen3] Round robin added
|
||||
Command line: udp_dstlist, API: getDestinationUDPList/ setDestinationUDPList
|
||||
Command line: udp_numdst, API: getNumberofUDPDestinations
|
||||
One can set up to 32 (64 for Mythen3) entries in the destination list.
|
||||
|
||||
. [Jungfrau] Module Id
|
||||
Command line: moduleid, API: getModuleId
|
||||
16 bit value (ideally unique) that is streamed out in the udp header of
|
||||
the detector. The on-board detector server picks it up from a file
|
||||
(if it exists) called detid_jungfrau.txt.
|
||||
|
||||
. [Jungfrau][[Gotthard2][Myhten3][Gotthard][Ctb][Moench] Hardware version
|
||||
Command line: hardwareversion, API: getHardwareVersion
|
||||
Gets the board or hardware version.
|
||||
For example, Jungfrau returns 1.0 or 2.0.
|
||||
It is also printed at on-board detector server start up.
|
||||
Also printed before starting FPGA programming.
|
||||
|
||||
|
||||
. [Eiger][Jugfrau][Mythen3] Transmission Delay
|
||||
Command line: tx_delay, API: getTransmissionDelay/ setTransmissionDelay
|
||||
Sets transmission delay for all modules in the detector using the step
|
||||
size provided. Sets up for every module:
|
||||
[Eiger] txdelay_left to (2 * mod_index * n_delay)
|
||||
[Eiger] txdelay_right to ((2 * mod_index + 1) * n_delay)
|
||||
[Eiger] txdelay_frame to (2 *num_modules * n_delay)
|
||||
[Jungfrau][Mythen3] txdelay_frame to (num_modules * n_delay)
|
||||
|
||||
. [Eiger][Jugfrau][Mythen3] Deprecated specific transmission delay commands
|
||||
txndelay_frame -> txdelay_frame
|
||||
txndelay_left -> txdelay_left
|
||||
txndelay_right -> txdelay_right
|
||||
|
||||
. Catch updated to latest 2.x version due to build failure in fedora
|
||||
|
||||
. [Moench][Ctb] ADC Vpp
|
||||
Command line: adcvpp, API: getADCVpp/ setADCVpp
|
||||
Moved from SetDAC function into into its own. One can use mV values or
|
||||
option numbers as before.
|
||||
|
||||
. [Mythen3] Clock Divider 4 and 5
|
||||
Cannot be set anymore. Only read back.
|
||||
|
||||
|
||||
. Deprecated CopyDetectorServer
|
||||
Command line: copydetectorserver, API: copydetectorserver
|
||||
Removed. Use updatedetectorserver
|
||||
|
||||
. [Jungfrau][Moench][Ctb] Additional programming checks
|
||||
Also checks if the drive to write to is a special file or a normal
|
||||
file. If its a normal file, it throws asking to redo the command with a
|
||||
'--please-delete' argument to delete the normal file and create the device
|
||||
drive and restart FPGA programming.
|
||||
|
||||
More readable error message insetad of "programfpga not implemented for
|
||||
this detector'. This happens when 'hostname' command fails due to
|
||||
server-firmware/client compatibility and the detector type becomes
|
||||
'GENERIC'. Fixed to suggest if 'hostname' executed properly.
|
||||
|
||||
|
||||
|
||||
. Arping for 10GbE
|
||||
Command line: rx_arping API: getRxArping/ setRxArping
|
||||
Starts a thread in the receiver to arping the interface it is listening
|
||||
to in 10GbE mode every 60 s.
|
||||
Changes NUM_RX_THREAD_IDS (sls_detector_defs.h) from 8 to 9.
|
||||
|
||||
|
||||
. Receiver Region of Interest
|
||||
Command line: rx_roi, API: getRxROI/ setRxROI
|
||||
Command line: rx_clearroi, API: clearRxROI
|
||||
One can set an ROI in the receiver to write to file. 1D detectors can set
|
||||
xmin and xmax, whereas the 2D can also set ymin and ymax. -1 values signify
|
||||
no ROI.
|
||||
|
||||
This is not at network level and can only be used to reduce size of file.
|
||||
Virtual HDF5 files not created when this is enabled and also no link in
|
||||
master file. No file created if module not in ROI.
|
||||
|
||||
There can only be one ROI per detector. Therefore, can be set only at
|
||||
detector level, but can be retrieved at module level as well.
|
||||
|
||||
The GUI still shows the entire image, but has a yellow border around the
|
||||
ROI. Status bar displays a message when Rx ROI enabled.
|
||||
|
||||
|
||||
. Missing packets
|
||||
Command line: rx_missingpackets, API: getNumMissingPackets
|
||||
This now returns a signed 64 bit instead of unsigned. The negative polarity
|
||||
depicts extra packets instead of missing packets and also takes care of
|
||||
disabled ports.
|
||||
|
||||
. Frames caught and frame index
|
||||
Command line rx_framescaught, rx_frameindex, API: getFramesCaught/ getRxCurrentFrameIndex
|
||||
They now return a vector for each port when there are 2 udp interfaces
|
||||
in the receiver.
|
||||
|
||||
|
||||
Python
|
||||
------
|
||||
|
||||
. Defines in sls_detector_defs
|
||||
sls_detetor_defs parsed and #defines extracted into defines.py
|
||||
For exmaple, one can use slsdet.LOCALHOST_IP
|
||||
|
||||
|
||||
. Pybind11 (v2.10.0)
|
||||
Pybind11 is removed as a submodule and instead built into package to
|
||||
simplify for users. Now, there is no more need to clone with the '--recursive'
|
||||
argument or to update submodule when switching to this package version
|
||||
and above.
|
||||
|
||||
. Conda packages
|
||||
Removed conda packages for python 3.6 and 3.7. Added for python 3.11.
|
||||
|
||||
|
||||
|
||||
Compilation
|
||||
-----------
|
||||
|
||||
. Option to provide a custom location to look for ZeroMQ, if not found
|
||||
. Custom location to find ZeroMQ
|
||||
Option to provide a custom location to look for ZeroMQ, if not found
|
||||
using FindZeroMQ.cmake
|
||||
-DZeroMQ_HINT=/usr/lib64 to use the system installed zmq
|
||||
|
||||
For example, to use the system installed zmq:
|
||||
Using cmake: -DZeroMQ_HINT=/usr/lib64
|
||||
Using cmk.sh script: -q /usr/lib64
|
||||
|
||||
|
||||
. Support external build
|
||||
Assuming already installed version of the slsDetectorPacakge exists,
|
||||
external build of python bindings, gui, ctbgui and moench has been added.
|
||||
|
||||
. Install python extension
|
||||
Option to copy the python extension (slsdet folder and _slsdet-..so)
|
||||
to CMAKE_INSTALL_PREFIX/python using
|
||||
-DSLS_INSTALL_PYTHONEXT
|
||||
|
||||
|
||||
Detector Server
|
||||
@ -211,16 +341,7 @@ Breaking API Resolved Issues
|
||||
They have precedence over config files. The config files can also be
|
||||
ignored by an argument from the command line, '--ignore-config' or '-i'.
|
||||
|
||||
. [Jungfrau][Moench][Ctb] Additional programming checks
|
||||
Also checks if the drive to write to is a special file or a normal
|
||||
file. If its a normal file, it throws asking to redo the command with a
|
||||
'--please-delete' argument to delete the normal file and create the device
|
||||
drive and restart FPGA programming.
|
||||
|
||||
More readable error message insetad of "programfpga not implemented for
|
||||
this detector'. This happens when 'hostname' command fails due to
|
||||
server-firmware/client compatibility and the detector type becomes
|
||||
'GENERIC'. Fixed to suggest if 'hostname' executed properly.
|
||||
|
||||
. [Jungfrau][Moench][Ctb] Additional server update process
|
||||
Removes old server binary or target of linked file when updating
|
||||
@ -231,6 +352,30 @@ Breaking API Resolved Issues
|
||||
Raise error if server name to be copied is the same as final soft link name.
|
||||
|
||||
|
||||
. [Mythen3] DAC check for settings
|
||||
Verify DAC values for each setting has been temporarily switched off
|
||||
|
||||
. [Mythen3] DAC min and max values
|
||||
Vtrim minimum of 600 has been removed.
|
||||
The threshold dacs minimum is 200 and maximum is 2400.
|
||||
The other DACs minimum is 0 and maximum is 2800.
|
||||
When out of range, will not throw, just a warning.
|
||||
|
||||
. [Mythen3] Vicin Dac changed to 800
|
||||
|
||||
|
||||
. [Gotthard2] Clock Divider defaults
|
||||
When chancing burst mode, clock dividers (2, 3 and 4) set to their
|
||||
defaults according to burst mode.
|
||||
|
||||
. [Moench][Ctb] 1 GbE Non blocking acquisition
|
||||
Previously non blocking acquisition in 1 GbE would not send data.
|
||||
This feature added now.
|
||||
|
||||
|
||||
. [Jungfrau][Moench][Ctb] PLL reset at server start up
|
||||
PLL reset now at server start up.
|
||||
|
||||
|
||||
Simulator
|
||||
---------
|
||||
@ -244,9 +389,14 @@ Breaking API Resolved Issues
|
||||
rx_hostname localhost
|
||||
udp_dstip auto
|
||||
|
||||
. [Eiger]
|
||||
|
||||
. [Eiger] Only one executable
|
||||
Only one executable for an Eiger virtual server. Master and top mode
|
||||
can be provided via command line or config file to the detector server,
|
||||
as well as via the client. See in Other New Features for more details.
|
||||
|
||||
One can start a module using:
|
||||
eigerDetectorServer_virtual # reads default config file (top master)
|
||||
eigerDetectorServer_virtual -i #ignores the config file (bottom slave)
|
||||
|
||||
Callback
|
||||
--------
|
||||
@ -257,10 +407,26 @@ Breaking API Resolved Issues
|
||||
|
||||
Requires firmware update to reverse channels of slaves.
|
||||
|
||||
. Datatype of Metadata [registerCallBackRawDataReady, registerCallBackRawDataModifyReady]
|
||||
Datatype changed from char* to sls_receiver_header.
|
||||
|
||||
. Datatype of Size [registerCallBackRawDataReady, registerCallBackRawDataModifyReady]
|
||||
Datatype changed from uint32_t to size_t
|
||||
|
||||
. Datatype of file name and file path [registerCallBackStartAcquisition]
|
||||
Datatype changed from string to const string reference.
|
||||
|
||||
. Incorrect image size [registerCallBackStartAcquisition]
|
||||
Fixed. It used to give +120 bytes.
|
||||
|
||||
Receiver
|
||||
--------
|
||||
|
||||
|
||||
. File write
|
||||
File write is disabled by default.
|
||||
|
||||
|
||||
. [Gotthard2] 25um image reconstruction in virtual HDF5
|
||||
Virtual HDF5 reconstructs complete image by interleaving first module
|
||||
(master) with second module (slave). First channel of master is first
|
||||
@ -268,9 +434,54 @@ Breaking API Resolved Issues
|
||||
|
||||
Requires firmware update to reverse channels of slaves.
|
||||
|
||||
. File name prefix
|
||||
Slash '/' not allowed.
|
||||
|
||||
. Memory size
|
||||
Increased an internal fifo header by 8 bytes to align memory allocated for
|
||||
to receive images.
|
||||
|
||||
. Geometry metadata
|
||||
Added geometry (number of modules in each direction) to metadata in file.
|
||||
|
||||
. HDF5 and Binary writer version
|
||||
Changed from 6.3 to 6.4
|
||||
|
||||
|
||||
2. Other Resolved Issues
|
||||
. Master file format to json
|
||||
The format has been changed from ASCII to json.
|
||||
|
||||
. Master file created at end of acquisition
|
||||
The file is now written at the end of acquisition. So if any metadata
|
||||
is changed during an acquisition, it will reflect the last value.
|
||||
|
||||
. Namespace sls
|
||||
All the receiver source files have also been added to namespace sls.
|
||||
|
||||
. HDF5 Dataset name
|
||||
Changed to just "data" to simplify for user
|
||||
|
||||
Gui
|
||||
---
|
||||
|
||||
. [Jungfrau][Eiger] Gap pixels
|
||||
Enabled by default in the gui.
|
||||
|
||||
. High voltage moved from Developer tab to Settings tab.
|
||||
|
||||
. Gain plot zooming
|
||||
Zooming disabled. Instead, it automatically zooms in when you zoom in
|
||||
the main plot or if min and max of x and y axis set up in plot tab.
|
||||
|
||||
|
||||
. Qt5 and in-built compressed Qwt 6.1.5
|
||||
Ported from Qt4 to Qt5.
|
||||
Compressed Qwt 6.1.5 added into the package in libs. It is unpacked and built
|
||||
as a static library.This allows us to remove qwt as an external dependency
|
||||
and reduces the risk of picking up the wrong version.
|
||||
|
||||
|
||||
2. Resolved Issues
|
||||
==================
|
||||
|
||||
|
||||
@ -295,6 +506,42 @@ Breaking API Resolved Issues
|
||||
. [Mythen3] Incorrect gain caps when setting threshold energy
|
||||
Gain caps overwritten with settings enum. Fixed.
|
||||
|
||||
. [Mythen3] Non blocking start acquisition
|
||||
Non-blocking start acquisition was sent out twice to the master. Fixed.
|
||||
|
||||
. Free and config command fail
|
||||
Free and config command checked mismatch of size of shared memory before
|
||||
freeing or loading new config. Fixed.
|
||||
|
||||
. sls_detector_help or sls_detector_get -h
|
||||
Should not create Detector object. Fixed.
|
||||
|
||||
|
||||
. [Moench] Patsetbit and patsetmask
|
||||
Command line: patsetbit API: getPatternBitMask/ setPatternBitMask
|
||||
Command line: patmask API: getPatternMask/ setPatternMask
|
||||
|
||||
Exchanging the help and masks for patsetbit and patsetmask in the detector
|
||||
server, especially in loading settings.
|
||||
|
||||
|
||||
. [Eiger] Datastream only for 10GbE
|
||||
Command line: datastream, API: getDataStream/ setDataStream
|
||||
|
||||
This command to enable/ disable data stream from left or right port
|
||||
is now allowed only for 10GbE. Previously, it incorrectly allowed to do so.
|
||||
|
||||
|
||||
. Non-blocking start
|
||||
Allow non-blocking start at modular level again.
|
||||
|
||||
|
||||
. [Gotthard][Gotthard2] Num modules
|
||||
Only 2 modules allowed maximum in a detector shared memory.
|
||||
|
||||
|
||||
|
||||
|
||||
Detecor Server
|
||||
--------------
|
||||
|
||||
@ -314,17 +561,57 @@ Breaking API Resolved Issues
|
||||
. Stop server startup errors
|
||||
Stop servers now also check for errors at startup (including version
|
||||
compatibility) and like the control server, it will translate to the
|
||||
client when connecting to the first time (hostname command).
|
||||
client when connecting for the first time (hostname command).
|
||||
|
||||
. [Mythen3][Gotthard2] System clock change effects
|
||||
When changing the system clock (clkdiv 2), time settings should also be
|
||||
affected (exptime, period etc.). Fixed.
|
||||
|
||||
[Gotthard2] System frequency should be same irrespective of timing source.
|
||||
Fixed.
|
||||
|
||||
. [Jungfrau][Eiger] Clear UDP destination
|
||||
Command line: udp_cleardst, API: clearUDPDestinations
|
||||
Clearing udp destination also clears it in the FPGA now.
|
||||
|
||||
|
||||
. [Jungfrau] Temporary fix for stop in 6.1.1
|
||||
Temporary fix introduced in 6.1.1 for not being able to start after a
|
||||
stop command has been issued is removed. Reset core right after also has
|
||||
been removed. It has been fixed in firmware instead.
|
||||
|
||||
. [Ctb] Allow all clock dividers for PLL
|
||||
Fixed. For example, 133 MHz would not really be set previously. Fixed by
|
||||
changing totaldiv from float to an integer.
|
||||
|
||||
. [Eiger][Jungfrau] Row column
|
||||
[Jungfrau] Fixed row column indexing for multi module 2 interfaces
|
||||
|
||||
|
||||
[Eiger] The row indicies were switched across the Y axis for the callback
|
||||
only for Eiger. This is now changed and kept similar to the other detectors.
|
||||
The row indices would be in the order of the half modules in the hostname
|
||||
command. Therefore, to keep the image from callback, invert the hostname
|
||||
order in the config file.
|
||||
|
||||
Simulator
|
||||
---------
|
||||
|
||||
. [Mythen3] Packet size
|
||||
Fixed packet size calculation. Previously, sending only header with no data.
|
||||
|
||||
|
||||
|
||||
Receiver
|
||||
--------
|
||||
|
||||
. refactored and fixed minor issues
|
||||
. Refactored and fixed minor issues
|
||||
Including memory structure and udp sockets.
|
||||
Fixed progress also in discard partial packaets mode and deactivated ports.
|
||||
Fixed 200% progress.
|
||||
|
||||
|
||||
Completely padded images now have detector type or version in metadata.
|
||||
Fixed getting stuck at stop receiver when using zmq
|
||||
Fixed clang compiler warnings
|
||||
|
||||
. [Eiger] Datastream command order
|
||||
The order of commands to set datastream from client mattered previously.
|
||||
@ -340,77 +627,51 @@ Breaking API Resolved Issues
|
||||
calculated incorrect image size expected due to inconsistent copy of
|
||||
detector parameters. Fixed
|
||||
|
||||
. Storage cells in receiver
|
||||
Previously not updated in receiver. Fixed.
|
||||
|
||||
. Virtual HDF5 Parameter datasets
|
||||
Corner case bug when frames caught is not a multiple of frames per file.
|
||||
Not found in virtual image datasets. Fixed.
|
||||
|
||||
. Stuck when using zmq
|
||||
More often in 6.1.1, gets stuck at stop receiver.
|
||||
|
||||
. Udp destination MAC
|
||||
If it has been set before, changing udp_dstip will not update udp_dstmac.
|
||||
Fixed to always set it in detector even if it had a value before.
|
||||
Udp_dstmac can still be used to overwrite again. This is useful when
|
||||
using a router for example.
|
||||
|
||||
|
||||
Gui
|
||||
---
|
||||
|
||||
. [Mythen3] Inconsistent timing mode
|
||||
Timing mode of the slaves should be discarded before squashing. Fixed.
|
||||
|
||||
. [Mythen3][Gotthard2] Crashes
|
||||
Additional locking Added
|
||||
|
||||
|
||||
Python
|
||||
-------
|
||||
|
||||
. Python sub-microsecond resolution
|
||||
Reading back sub-microsecond exposure times from the Python API fixed by
|
||||
addig Python datetime supports only micro seconds as lowest unit.
|
||||
|
||||
This is fixed by introducing a new C++ type (DurationWrapper), which
|
||||
holds number of nanoseconds as a uint64_t (only in python bindings) and
|
||||
custom typecaster to convert to and from std::chrono::nanoseconds.
|
||||
|
||||
A get using API now returns in DurationWrapper, instead of datetime.
|
||||
Refer exptime help for examples.
|
||||
|
||||
|
||||
|
||||
- adding LTO to test and disable them for Debug builds?
|
||||
- support external build of python lib
|
||||
|
||||
|
||||
- rx_roi
|
||||
- fixed row column indexing (mainly for multi module Jungfrau 2 interfaces )
|
||||
- eiger gui row indices not flipped anymore (fix in config)
|
||||
- m3 (settings dac check disabled temporarily?)
|
||||
- m3 virtual server sends the right pacets now
|
||||
- gap pixels in gui enabled by default
|
||||
- rxr src files and classes (detectordata, ZmqSocket, helpDacs) added to sls namespace, and macros (namely from logger (logINFO etc)), slsDetectorGui (make_unique in implemtnation requires sls nemspace (points to std otherwise) but not deectorImpl.cpp)
|
||||
- blackfin programing made seamless (nCE fixed which helps)
|
||||
-save settings file for m3 and eiger
|
||||
- m3 threshold changes
|
||||
- g2 and m3 clkdiv 2 (system clock) change should affect time settings (g2: exptime, period, delayaftertrigger, burstperiod, m3: exptime, gatedelay, gateperiod, period, delayaftertrigger)
|
||||
- g2 system frequency is the same irrespective of timing source
|
||||
- (apparently) rxr doesnt get stuck anymore from 6.1.1
|
||||
- rxr mem size changed (fifo header size from 8 to 16) due to sls rxr header = 112.. 112+ 16=128 (reduces packet losss especially for g2)
|
||||
-udp_srcip and udp_Srcip2: can set to auto (for virtual or 1g data networks)
|
||||
- set dataset name for all hdf5 files to "data" only
|
||||
- number of storage cells is not updated in teh receiver. done. and also allowing it to be modified in running status
|
||||
- refactored memory structure in receiver and listener code (maybe resolves stuck issue, need to check)
|
||||
- callback modified to have rx header and not rx header pointer
|
||||
- adapted for g2 hdi v2.0. able to set master from server command line, server config file, and client.
|
||||
- rx udp socket refactored (maybe resolves getting stuck?)remove check for eiger header and isntead checks for malformed packets for every detector
|
||||
- jungfrau sw trigger , blocking trigger
|
||||
-help should not create a new object
|
||||
- jungfrau master
|
||||
- g2 parallel command
|
||||
- jungfrau sync
|
||||
- m3 bad channels (badchannel file also for g2 extended to include commas and colons, remove duplicates)
|
||||
- m3 fix for gain caps to invert where needed when loading from trimbit file (fix for feature might have been added only in developer branch)
|
||||
- pat loop and wait address default
|
||||
- ctb and moench Fw fixed (to work with pattern commdand) )addreess length
|
||||
- setting rx_hostname (or udp_dstip with rx_hostname not none) will always set udp_dstmac. solves problem of chaing udp_dstip and udp_dstmac stays the same
|
||||
- jungfrau reset core and usleep removed (fix for 6.1.1 is now fixed in firmware)
|
||||
- m3 clock update, m3 clk 4 and 5 cannot be set
|
||||
- g2 change clkdivs 2 3 4 to defaults for burst and cw mode.
|
||||
- ctb and moench: allowing 1g non blocking acquire to send data
|
||||
- m3 and g2 rr
|
||||
- m3 and g2 temp
|
||||
- gain plot zooming fixed (disabled, acc. to main plot)
|
||||
- ctb, moench, jungfrau (pll reset at start fixed, before no defines)
|
||||
- pybind built into package, no need to update submodule when previous release had different pybind version
|
||||
- adcvpp moved from dac.. and api added (ctb, moench)
|
||||
- qt4->qt5
|
||||
- in built qt5 6.1.5 because rhel7 is not upto date with qt5, removed findqwt.cmake
|
||||
- made a fix in qwt lib (qwt_plot_layout.h) to work with 5.15 and lower versions
|
||||
- qt5 forms fixed, qt4 many hard coding forms switched to forms including qtabwidget, scrolls etc, fonts moved to forms
|
||||
- docking option enabled by default, removed option to disable docking feature from "Mode"
|
||||
- added qVersionResolve utility functions to handle compatibility before and after qt5.12
|
||||
- qtplots (ian's code) takes in gain mode enable to set some settings within the class, with proper gain plot ticks
|
||||
- ensure gain plots have no zooming of z axis in 2d and y axis in 1d
|
||||
- fixed some error messages in server side that were empty for fail in funcs (mostly minor as if this error, major issues)
|
||||
- eiger (removed feb reset in stop acquisition as it caused processing bit to randomly not go high (leads to infinite loop waiting for it to go high). This is anyway done at prepare acquisition and set trimbits.
|
||||
- left AND right registers monitored for processing bit done
|
||||
- febProcessinginprogress returns STATUS_IDLE and not IDLE
|
||||
- In feb stop acquisition, if processing bit is running forever, checks for 1 s, then if acq done bit is high, returns ok, else throws
|
||||
- feb stop acquisition returns 1 if success and fucntion in list calling it compares properly instead of STATUS_IDLE (no effect, but incorrect logic)
|
||||
- chipsignals to trimquad should only monitor right fpga (not both as it will throw)
|
||||
- fixed error messages of readregister inconsistent values
|
||||
- setmodule and read frame was returning fail without setting error messages (leading to broken tcp connection due to no error message) )
|
||||
- gui nios temperature added
|
||||
- detector header change (bunchid, reserved, debug, roundRnumber) ->detSpec1 - 4
|
||||
-ctb and moench (allowing all clkdivs (totaldiv was a float instead of int))
|
||||
- txndelay_ ->txdelay_ (also for python), txdelay = delay for all with step
|
||||
- hardwareversion
|
||||
- jungfrau connected moduleid to detid_jungfrau.txt on board
|
||||
|
||||
- dac names for ctb?
|
||||
- support external build of python lib,
|
||||
|
||||
|
||||
|
||||
|
@ -1242,7 +1242,7 @@ class CmdProxy {
|
||||
"\n\tOn-board detector server software version");
|
||||
|
||||
GET_COMMAND(hardwareversion, getHardwareVersion,
|
||||
"\n\tJungfrau][Gotthard2][Myhten3][Gotthard][Ctb][Moench] "
|
||||
"\n\t[Jungfrau][Gotthard2][Myhten3][Gotthard][Ctb][Moench] "
|
||||
"Hardware version of detector.");
|
||||
|
||||
GET_COMMAND(
|
||||
|
Loading…
x
Reference in New Issue
Block a user