diff --git a/manual/docs/html/angularCalibrationHowTo/WARNINGS b/manual/docs/html/angularCalibrationHowTo/WARNINGS
deleted file mode 100644
index 486bcceff..000000000
--- a/manual/docs/html/angularCalibrationHowTo/WARNINGS
+++ /dev/null
@@ -1 +0,0 @@
-No implementation found for style `graphicx'
diff --git a/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.css b/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.css
deleted file mode 100644
index d1824aff4..000000000
--- a/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.css
+++ /dev/null
@@ -1,30 +0,0 @@
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
diff --git a/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html b/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html
deleted file mode 100644
index 856ee5cd2..000000000
--- a/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
-
-
-
-Angular calibration wizard manual
-
-
- Next: Introduction
-
-
-
Angular calibration wizard manual
-
-
-
Anna Bergamaschi
-
August 24, 2017
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/angularCalibrationHowTo/images.pl b/manual/docs/html/angularCalibrationHowTo/images.pl
deleted file mode 100644
index f337e4a06..000000000
--- a/manual/docs/html/angularCalibrationHowTo/images.pl
+++ /dev/null
@@ -1,116 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate images original text with physical files.
-
-
-$key = q/Theta_e;MSF=1.6;AAT/;
-$cached_env_img{$key} = q|Angular calibration wizard manual
-
-
- Next: Introduction
-
-
-
Angular calibration wizard manual
-
-
-
Anna Bergamaschi
-
August 24, 2017
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/angularCalibrationHowTo/internals.pl b/manual/docs/html/angularCalibrationHowTo/internals.pl
deleted file mode 100644
index 89270cacc..000000000
--- a/manual/docs/html/angularCalibrationHowTo/internals.pl
+++ /dev/null
@@ -1,30 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate internals original text with physical files.
-
-
-$key = q/fig:guiangcallog/;
-$ref_files{$key} = "$dir".q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guiposscan/;
-$ref_files{$key} = "$dir".q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:peakfit/;
-$ref_files{$key} = "$dir".q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:angcal/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:setangcal/;
-$ref_files{$key} = "$dir".q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:anglefit/;
-$ref_files{$key} = "$dir".q|node3.html|;
-$noresave{$key} = "$nosave";
-
-1;
-
diff --git a/manual/docs/html/angularCalibrationHowTo/labels.pl b/manual/docs/html/angularCalibrationHowTo/labels.pl
deleted file mode 100644
index 6f62b378a..000000000
--- a/manual/docs/html/angularCalibrationHowTo/labels.pl
+++ /dev/null
@@ -1,61 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate labels original text with physical files.
-
-
-$key = q/fig:guiangcallog/;
-$external_labels{$key} = "$URL/" . q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guiposscan/;
-$external_labels{$key} = "$URL/" . q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:peakfit/;
-$external_labels{$key} = "$URL/" . q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:angcal/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:setangcal/;
-$external_labels{$key} = "$URL/" . q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:anglefit/;
-$external_labels{$key} = "$URL/" . q|node3.html|;
-$noresave{$key} = "$nosave";
-
-1;
-
-
-# LaTeX2HTML 2008 (1.71)
-# labels from external_latex_labels array.
-
-
-$key = q/fig:guiangcallog/;
-$external_latex_labels{$key} = q|1|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guiposscan/;
-$external_latex_labels{$key} = q|2|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:peakfit/;
-$external_latex_labels{$key} = q|4|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:angcal/;
-$external_latex_labels{$key} = q|1|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:setangcal/;
-$external_latex_labels{$key} = q|3|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:anglefit/;
-$external_latex_labels{$key} = q|5|;
-$noresave{$key} = "$nosave";
-
-1;
-
diff --git a/manual/docs/html/angularCalibrationHowTo/node1.html b/manual/docs/html/angularCalibrationHowTo/node1.html
deleted file mode 100644
index a9c547610..000000000
--- a/manual/docs/html/angularCalibrationHowTo/node1.html
+++ /dev/null
@@ -1,186 +0,0 @@
-
-
-
-
-
-Introduction
-
-
-
-
-
-
- Next: Data acquisition
- Up: Angular calibration wizard manual
- Previous: Angular calibration wizard manual
-
-In order to convert from strip number to 2
-For this purpose, a series of patterns of a powder standard with symmetric peaks (e.g. silicon) must acquired while shifting the detector by an angular step of the order of about 2% of the module size. During the measurement, a strong intensity peak (e.g. Si(111)) should pass through the field of view of every module such that it can be used as a reference angular position to perform the calibration of the modules position.
-
-In a first step, the peak is fitted with a Gaussian in order to determine its position
-
-
-
-
-(1)
-
-where the parameters
-The same function of equation 1 , with the parameters obtained from the calibration, is used in order to convert from channel number to 2
-The parallax at the borders of the modules due to the thickness of the silicon sensor is a function of the X-ray energy (higher energy X-rays are absorbed deeper inside the sensor) and is of the order of 0.2 mdeg at 12 keV and 0.5 mdeg at 30 keV.
-
-Patterns acquired at different detector positions are generally merged together in order to fill the gaps between the modules and correct possibly bad functioning channels. In this procedure the data from different positions which are closer than 4 mdeg (the average pixel size) are averaged and the new position is set to the mean of the positions of the original points.
-
-
-The position and width of the peaks results from a fit over several detector channels. Geometrical distortions might disturb this determination mainly because of errors in the angular calibration, fluctuations in the encoder position, variations between channels and parallax effects.
-
-
-
-
-
-
-
- Next: Data acquisition
- Up: Angular calibration wizard manual
- Previous: Angular calibration wizard manual
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/angularCalibrationHowTo/node2.html b/manual/docs/html/angularCalibrationHowTo/node2.html
deleted file mode 100644
index 30cefefe4..000000000
--- a/manual/docs/html/angularCalibrationHowTo/node2.html
+++ /dev/null
@@ -1,217 +0,0 @@
-
-
-
-
-
-Data acquisition
-
-
-
-
-
-
- Next: Data analysis
- Up: Angular calibration wizard manual
- Previous: Introduction
-Subsections
-The angular calibration consists in acquiring a set of diffraction patterns of a well known powder standard (e.g. Silicon) at different encoder positions. In order to facilitate the procedure, the sample should not emit fluorescent light and should present relatively symmetric peaks.
-Do not forget to properly position the beam stopper if the detector is scanned in front of the direct beam.
-
-All the angular calibration procedure should be acquired using a trimmed detector with the threshold set at half of the X-ray energy (Assuming no fluorescent element in the standard). A flat field should also be acquired in order to precisely correct the data, while the X-ray intensity should be kept lower than about 100 kHz per strip in order to avoid the need for rate corrections.
-
-
-A rough angular conversion file starting from a previous calibration or from the geometric characteristics of the mechanics is an advantage. The angular conversion file should contain a line for each module of the detector with its module number
-module 0 center 639.5 +- 0 conversion 6.56E-05 +- 0 offset 0 +- 0
-
-Also the global offset value of the beamline should be approximately known i.e. the angular position of channel 0 of module 0 when the motor is set at 0.
-angular direction should be set to -1.
-
-
-
-
-
-
-For the acquisition ot the data you need to install the slsDetector software package (please refere to separate documentation). The use of the GUI is optional and all operations can be performed also using the text client.
-
-Please make sure that you have edited the
-slsDetectorSoftware/usersFunctions/angleFunction.h
-slsDetectorSoftware/usersFunctions/usersFunctions.cpp
-
-In the following the command to acquire a dataset for the angular calibration with an exposure time of 1 s, and position shift
-
-#setup angular calibration log mode
-> sls_detector_put angcallog 1
-#set exposure time to 1s
-> sls_detector_put exptime 1.
-#setup threshold scan
-> sls_detector_put scan0script position
-#setup the precision for the scan variable in the file name
-> sls_detector_put scan0prec 2
-#set scan range between 20deg and -60deg, step of -0.1deg
-# (at 12.4 keV the Si(111) peak is at approx 19deg
-> sls_detector_put scan0range 20 -60 -0.1
-#acquire the data
-> sls_detector_acquire
-#unset angular calibration log mode
-> sls_detector_put angcallog 0
-
-
-
-With the GUI you can obtain the same results by clicking on the Angular calibration log button in the advanced tab (see figure 1 ) and setting up the motor position scan in the Actions tab (see figure 2 ). The exposure time should also be set in the measurement tab.
-
-
-Additional to the data files, the acquisition will produce a .angcal file containing an header and, for each step of the acquisition, the exect value of the motor position and the file name.
-
-type Mythen
-maxmod 32
-nmod 32
-angconv /scratch/angcal20120422/ang.off
-globaloff 5.088
-fineoff 0.0
-angdir 1
-ffdir /scratch/angcal20120422/
-flatfield flatfield_E12keV_T6keV_0.raw
-badchannels /scratch/cal/bad.chans
-19.99998 angcal_S20.00_0
-19.90001 angcal_S19.90_0
-19.79999 angcal_S19.80_0
-19.70002 angcal_S19.70_0
-......
-
-
-
-
-
-
-Figure 1:
-Acquisition GUI window to enable the angular calibration log.
-
-
-
-
-Figure 2:
-Acquisition GUI window to setup the motor position scan.
-
-
-
-
-
-
-
- Next: Data analysis
- Up: Angular calibration wizard manual
- Previous: Introduction
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/angularCalibrationHowTo/node3.html b/manual/docs/html/angularCalibrationHowTo/node3.html
deleted file mode 100644
index 7b37ceda1..000000000
--- a/manual/docs/html/angularCalibrationHowTo/node3.html
+++ /dev/null
@@ -1,186 +0,0 @@
-
-
-
-
-
-Data analysis
-
-
-
-
-
-
- Next: Setup calibration files
- Up: Angular calibration wizard manual
- Previous: Data acquisition
-Subsections
-The data analysis consists in fitting with a gaussian the selected peak of the powder pattern for each position in order to determine its position is channel number as a function of the encoder position.
-
-
-
-
-
-The software used for the angular calibration data analysis is based on root (see http://root.cern.ch).
-
-To start the data analysis simply launch:
-
-> ./angularCalibrationWizard
-
-
-
-
-
-
-Figure 3:
-Overview of the nagular calibration dataset.
-
-To setup the angular calibration dataset, the .angcal file should be selected (or digited) and the load button should be pressed to confirm. The parameters of the angular calibration are then read to the file and the data loaded for a quick overview (see figure 3 ).
-
-
-
-
-Figure 4:
-Preview of the fitting of the Si(111) peak for one of the detector positions.
-
-For a more detailed view of the data, one can select an angular calibration step from the combo box, select the plot mode (raw data or processed data as a function of channel number, processed angular converted data, flat field data, or again an overview of the whole dataset).
-
-If the bad channel list, angular conversion file or flat field file are changed compared to the acquisition, they can be reloaded by editing the correspondent text entries and pressing enter.
-
-
-In particular, the angular converted data should be checked in order to view the position of the selected peak. In this case, the plot will be zoomed to the angular region slected in the minimum and maximum angle entries. By pressing fit, the fit of the peak in the selected angular range will be shown (see figure 4 ). It is useful to check that it works properly in several positions such that then the sequential fitting on all steps can give good results.
-
-
-To automatically fit all positions simply press Proceed to Modules Calibration and wait until all steps are fitted. This can take sometime, depending on the number of steps.
-
-
-
-
-
-Figure 5:
-Window for fitting the angular calibration parameters of a module.
-
-In the module calibration window (see figure 5 ), you will be able to fit the channel number to encoder position curve to estimate the three angular calibration parameters for each module.
-
-After fitting all modules you can click on the Write Angular Calibration button, select the file name to write to and save the calibration angulat calibration data. Please note that the offset of module 0 will always be 0 and the other values will be rescaled to its value. Therefore the global offset of the steup will always need to be specified for a proper angular conversion unless the home of the encoder will not be redifined.
-
-
-
-
-
-
-
-
- Next: Setup calibration files
- Up: Angular calibration wizard manual
- Previous: Data acquisition
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/angularCalibrationHowTo/node4.html b/manual/docs/html/angularCalibrationHowTo/node4.html
deleted file mode 100644
index b6874747b..000000000
--- a/manual/docs/html/angularCalibrationHowTo/node4.html
+++ /dev/null
@@ -1,68 +0,0 @@
-
-
-
-
-
-Setup calibration files
-
-
-
-
-
-
- Next: About this document ...
- Up: Angular calibration wizard manual
- Previous: Data analysis
-
-To use the generated angular calibration files, using the text client:
-
-sls_detector_put angconv /scratch/ang_new.off
-
-while for the GUI the file name should be specified in the configuration file (works also for the text client).
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/angularCalibrationHowTo/node5.html b/manual/docs/html/angularCalibrationHowTo/node5.html
deleted file mode 100644
index 0b42645db..000000000
--- a/manual/docs/html/angularCalibrationHowTo/node5.html
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-
-
-
-About this document ...
-
-
-
-
- Up: Angular calibration wizard manual
- Previous: Setup calibration files
-Angular calibration wizard manual
-This document was generated using the
-LaTeX 2HTML
-Copyright © 1993, 1994, 1995, 1996,
-Nikos Drakos ,
-Computer Based Learning Unit, University of Leeds.
-Ross Moore ,
-Mathematics Department, Macquarie University, Sydney.
-
-The command line arguments were: latex2html -split 4 angularCalibrationHowTo.tex
-
-The translation was initiated by Thattil Dhanya on 2017-08-24
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/WARNINGS b/manual/docs/html/energyCalibrationHowTo/WARNINGS
deleted file mode 100644
index 486bcceff..000000000
--- a/manual/docs/html/energyCalibrationHowTo/WARNINGS
+++ /dev/null
@@ -1 +0,0 @@
-No implementation found for style `graphicx'
diff --git a/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.css b/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.css
deleted file mode 100644
index d1824aff4..000000000
--- a/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.css
+++ /dev/null
@@ -1,30 +0,0 @@
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
diff --git a/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html b/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html
deleted file mode 100644
index 357ae05dd..000000000
--- a/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
-
-
-
-Energy calibration wizard manual
-
-
- Next: Introduction
-
-
-
Energy calibration wizard manual
-
-
-
Anna Bergamaschi
-
August 24, 2017
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/images.pl b/manual/docs/html/energyCalibrationHowTo/images.pl
deleted file mode 100644
index 4bdbaf914..000000000
--- a/manual/docs/html/energyCalibrationHowTo/images.pl
+++ /dev/null
@@ -1,252 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate images original text with physical files.
-
-
-$key = q/CS=frac{N_S}{N_0};MSF=1.6;AAT/;
-$cached_env_img{$key} = q|Energy calibration wizard manual
-
-
- Next: Introduction
-
-
-
Energy calibration wizard manual
-
-
-
Anna Bergamaschi
-
August 24, 2017
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/internals.pl b/manual/docs/html/energyCalibrationHowTo/internals.pl
deleted file mode 100644
index ce56c1a49..000000000
--- a/manual/docs/html/energyCalibrationHowTo/internals.pl
+++ /dev/null
@@ -1,50 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate internals original text with physical files.
-
-
-$key = q/fig:modulecalibration/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:encal/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guithrscan/;
-$ref_files{$key} = "$dir".q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:thrscanfluo/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:noisescan/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:thrscan/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:calibratemodule/;
-$ref_files{$key} = "$dir".q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guiencallog/;
-$ref_files{$key} = "$dir".q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:addenergy/;
-$ref_files{$key} = "$dir".q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:thrscanexpl/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:expthrscan/;
-$ref_files{$key} = "$dir".q|node1.html|;
-$noresave{$key} = "$nosave";
-
-1;
-
diff --git a/manual/docs/html/energyCalibrationHowTo/labels.pl b/manual/docs/html/energyCalibrationHowTo/labels.pl
deleted file mode 100644
index 16e860747..000000000
--- a/manual/docs/html/energyCalibrationHowTo/labels.pl
+++ /dev/null
@@ -1,101 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate labels original text with physical files.
-
-
-$key = q/fig:modulecalibration/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:encal/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guithrscan/;
-$external_labels{$key} = "$URL/" . q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:thrscanfluo/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:noisescan/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:thrscan/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:calibratemodule/;
-$external_labels{$key} = "$URL/" . q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guiencallog/;
-$external_labels{$key} = "$URL/" . q|node2.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:addenergy/;
-$external_labels{$key} = "$URL/" . q|node3.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:thrscanexpl/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:expthrscan/;
-$external_labels{$key} = "$URL/" . q|node1.html|;
-$noresave{$key} = "$nosave";
-
-1;
-
-
-# LaTeX2HTML 2008 (1.71)
-# labels from external_latex_labels array.
-
-
-$key = q/fig:modulecalibration/;
-$external_latex_labels{$key} = q|4|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:encal/;
-$external_latex_labels{$key} = q|3|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guithrscan/;
-$external_latex_labels{$key} = q|6|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:thrscanfluo/;
-$external_latex_labels{$key} = q|3|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:noisescan/;
-$external_latex_labels{$key} = q|2|;
-$noresave{$key} = "$nosave";
-
-$key = q/eq:thrscan/;
-$external_latex_labels{$key} = q|1|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:calibratemodule/;
-$external_latex_labels{$key} = q|8|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:guiencallog/;
-$external_latex_labels{$key} = q|5|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:addenergy/;
-$external_latex_labels{$key} = q|7|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:thrscanexpl/;
-$external_latex_labels{$key} = q|1|;
-$noresave{$key} = "$nosave";
-
-$key = q/fig:expthrscan/;
-$external_latex_labels{$key} = q|2|;
-$noresave{$key} = "$nosave";
-
-1;
-
diff --git a/manual/docs/html/energyCalibrationHowTo/node1.html b/manual/docs/html/energyCalibrationHowTo/node1.html
deleted file mode 100644
index 42bca70c0..000000000
--- a/manual/docs/html/energyCalibrationHowTo/node1.html
+++ /dev/null
@@ -1,383 +0,0 @@
-
-
-
-
-
-Introduction
-
-
-
-
-
-
- Next: Data acquisition
- Up: Energy calibration wizard manual
- Previous: Energy calibration wizard manual
-
-The choice of the level of the comparator threshold plays a very important role in counting systems since it influences the efficiency of the detector as well as its spatial resolution (for details see the paper Bergamaschi, A. et al. (2010). J. Synchrotron Rad. 17, 653-668).
-
-
-Single-photon-counting detectors are sensitive to single photons and the only limitation on the fluctuations of the number of counts is given by the Poisson-like statistics of the X-ray quanta.
-The digitized signal does not carry any information concerning the energy of the X-rays and all photons with an energy larger than the threshold are counted as one bit. This means that the choice of the correct comparator threshold level is critical in order to obtain good-quality data.
-1 shows the expected number of counts as a function of the threshold energy for
-The intrinsic noise on the electronic signal is defined by the Equivalent Noise Charge (
-Moreover, when a photon is absorbed in the region between two strips of the sensor, the generated charge is partially collected by the two nearest electronic channels. For this reason the physical S-curve is not flat but can be modeled by a decreasing straight line. The number of shared photons
-The number of counts in the physical case is equal to that in the ideal case for a threshold set at half the photon energy. This defines the optimal threshold level
-
-
-
-
-(1)
-
-where
-
-
-
-
-(2)
-
-
-
-The choice of the comparator threshold level
-Furthermore, the threshold uniformity is particularly critical with regards to fluorescent radiation emitted by the sample under investigation. Since the emission of fluorescent light is isotropic, the data quality will be improved by setting the threshold high enough in order to discard the fluorescence background (see figure 3 ).
-
-The comparator threshold is given by a global level which can be set on a module basis and adds to a component which is individually adjustable for each channel. In order to optimize the uniformity of the detector response it is important to properly adjust the threshold for all channels.
-
-
-
-
-
-(3)
-
-This is initially performed by acquiring measurements while scanning the global threshold using different X-ray energies and calculating the median of the counts at each threshold value for each module 4 . The experimental data are then fitted according to equation 1 and for each module a linear relation is found between the X-ray energy and the estimated inflection point, as shown in the inset of figure 4 . The resulting offset
-
-
-
-
-
-
-
-Figure 2:
-Measured threshold scan at 12.5 keV with the three different settings. In the inset the fit of the experimental data with the expected curve as in function 1 is shown in the region of the inflection point.
-
-
-
-Differences in gain and offset are present also between individual channels within a module and therefore the use of threshold equalization techniques (trimming) using the internal 6-bit DAC is needed in order to reduce the threshold dispersion.
-Since both gain and offset have variations between channels, the optimal trimming should be performed as a function of the threshold energy.
-Please not that trimming of the channels of the detector should be performed in advanced and is extremely important for a succeful energy calibration of the detector.
-
-
-All energy calibration procedures should be applied to a trimmed detector and only an improvement of the existing trimbits can be performed afterwards, since it does not significatively affect the energy calibration.
-
-
-
-
-
-Figure 4:
-Median of the number of counts as a function of the threshold for X-rays of 12.5, 17.5 and 25 keV for one of the detector modules using standard settings. The solid line represents the fit of the experimental points with equation 1 . In the inset the linear fit between the X-ray energy and the position of the inflection point of the curves is shown.
-
-
-
-
-
-
-
- Next: Data acquisition
- Up: Energy calibration wizard manual
- Previous: Energy calibration wizard manual
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/node2.html b/manual/docs/html/energyCalibrationHowTo/node2.html
deleted file mode 100644
index 7419c9c10..000000000
--- a/manual/docs/html/energyCalibrationHowTo/node2.html
+++ /dev/null
@@ -1,186 +0,0 @@
-
-
-
-
-
-Data acquisition
-
-
-
-
-
-
- Next: Data analysis
- Up: Energy calibration wizard manual
- Previous: Introduction
-Subsections
-The energy calibration consists in acquiring threshold scans using the detector at at least 2 (better 3) energies. A monochromatic beam is ideal in this procedure, but beam obtained from some fluorescent sample is also good.
-
-With a quick acquisition or threshold scan it is useful to define the range of the scan and the exposure time. It is important to start from a threshold high enough that (almost) all channels of the detector have a negligible number of counts and that the plateau of the S-curve is long enough to correctly estimate the number of photons.
-
-
-
-
-
-
-For the acquisition ot the data you need to install the slsDetector software package (please refere to separate documentation). The use of the GUI is optional and all operations can be performed also using the text client.
-
-In the following the command to acquire a dataset for the energy calibration with an exposure time of 1 s, and threshold scan range between 200 and 850 with a setp of 1 DAC unit.
-
-> sls_detector_put encallog 1 #setup energy calibration
-> sls_detector_put exptime 1. #set exposure time to 1s
-> sls_detector_put scan0script threshold #setup threshold scan
-> sls_detector_put scan0range 200 850 1 #set scan range between 200 and 850, step of 1
-> sls_detector_acquire #acquire the data
-> sls_detector_put encallog 0 #unset energy calibration
-
-
-
-With the GUI you can obtain the same results by clicking on the Energy Calibration log button in the advanced tab (see figure 5 ) and setting up the threshold scan in the Actions tab (see figure 6 ). the exposure time should also be set in the measurement tab.
-
-
-This procedure should be executed at at least 2 (better 3) energies.
-
-
-Additional to the data files, the acquisition will produce a .encal file containing an header and, for each step of the acquisition, the threshold value and the file name.
-
-settings standard
-type Mythen+
-nmod 12
-modulenumber:0 000
-modulenumber:1 111
-modulenumber:2 222
-modulenumber:3 333
-modulenumber:4 444
-modulenumber:5 555
-modulenumber:6 666
-modulenumber:7 777
-modulenumber:8 888
-modulenumber:9 999
-modulenumber:10 aaa
-modulenumber:11 bbb
-450 standard_12_4keV_S450_0
-460 standard_12_4keV_S460_0
-470 standard_12_4keV_S470_0
-480 standard_12_4keV_S480_0
-490 standard_12_4keV_S490_0
-500 standard_12_4keV_S500_0
-510 standard_12_4keV_S510_0
-520 standard_12_4keV_S520_0
-...
-...
-
-
-
-
-
-
-Figure 5:
-Acquisition GUI window to enable the energy calibration log.
-
-
-
-
-Figure 6:
-Acquisition GUI window to setup the threshold scan.
-
-
-
-
-
-
-
- Next: Data analysis
- Up: Energy calibration wizard manual
- Previous: Introduction
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/node3.html b/manual/docs/html/energyCalibrationHowTo/node3.html
deleted file mode 100644
index edd51edd3..000000000
--- a/manual/docs/html/energyCalibrationHowTo/node3.html
+++ /dev/null
@@ -1,190 +0,0 @@
-
-
-
-
-
-Data analysis
-
-
-
-
-
-
- Next: Setup calibration files
- Up: Energy calibration wizard manual
- Previous: Data acquisition
-Subsections
-The data analysis consists in fitting the S-curves obtained from the datasets acquired as above and then performing a linear fit between the energy values and the inflection points.
-
-
-
-
-
-
-The software used for the energy calibration data analysis is based on root (see http://root.cern.ch).
-
-To start the data analysis simply launch:
-
-> ./energyCalibrationWizard
-
-
-
-To add anew energy write the energy value and select (or digit) the name of the .encal file corresponding to that energy (see figure 7 ).
-Preview and a 2D color plot will be displayed, showing the channel numbers on the X-axis, the threshold on the Y-axis, and the number of counts as a color scale.
-By (right) clicking close to the axis you are able to zoom in/out, set the scale to logarithmic etc.
-Add to list . The energy value will be shown in the combo box on top and labels will display the settings of the detector, the number of modules, the number of channels per module and the modules serial numbers.
-
-
-Add then all the other energies to the calibration always by editing the energy value and .encal file name, pressing preview and add to list .
-selected energy actions you can navigate in the combo box with list of energies, view the plots and eventually remove the ones you don't want to use in your calibration.
-proceed to module calibration .
-
-
-
-
-
-Figure 7:
-Window to add energies to the calibration.
-
-In the module calibration window (see figure 8 ), you are still able to look at the calibration summary, and eventually return to the previous windown by pressing Back to energy setup .
-1 and the linear fit between the energy values and the fitted inflection points.
-Normally the points lie on a straight line (although often not perfect), therefore it should be simple to spot if there are problems in the fitting of some of the data.
-Manual save is unclicked, the calibration files will be saved locally, with the extension automatically generated by using the modules serial numbers, every time a linear fit is performed (i.e. if you mess up wiht the linear fit you overwrite a previous good file!). If you click the checkbox, you need to save the calibration by pressing Write to file for each module once you are happy with the fit.
-
-
-To change the Y scale of the plot, edit the Counts entry. After clicking of the energy button (eventually twice) the maximum of the histogram will be set to three times the value.
-
-
-To re-fit one energy with modified range or start parameters, you should press the central button with the energy value once the energy is selected. The text color tells you which curve you are referring to.
-
-You should set the range of the fit. In particular the maximum should be limited in order to avoid to enter the noise range (and can be pretty different for the various modules).
-Invert axis check button should be ckecked. Uncheck it in case your detector collects electrons (e.g. CdTe, Si n in p)
-
-
-You can change the start values of the parameters of the fits by editing the number eneries. The label nearby will show you the actual value of the fitted parameters.
-
-The button Finished will be enebled only once the calibration files have been generated for all modules.
-
-
-
-
-
-Figure 8:
-Window to calibrate the modules.
-
-
-
-
-
-
-
- Next: Setup calibration files
- Up: Energy calibration wizard manual
- Previous: Data acquisition
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/node4.html b/manual/docs/html/energyCalibrationHowTo/node4.html
deleted file mode 100644
index ade53625f..000000000
--- a/manual/docs/html/energyCalibrationHowTo/node4.html
+++ /dev/null
@@ -1,74 +0,0 @@
-
-
-
-
-
-Setup calibration files
-
-
-
-
-
-
- Next: About this document ...
- Up: Energy calibration wizard manual
- Previous: Data analysis
-
-To use the genrated calibration files as default ones, copy them into your default caldir/settings renaming them calibration.snxxx, where snxxx is the extension that the genrated files already have, which corresponds to the module serial number.
-
-for i in $(ls newcal_standard.sn* | awk -F "." '{print $2}'); do \
-mv newcal_standard.$i caldir/standard/calibration.$i; \
-done
-
-
-
-By reloading the default detector settings, the calibration coefficients will be automatically loaded.
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/energyCalibrationHowTo/node5.html b/manual/docs/html/energyCalibrationHowTo/node5.html
deleted file mode 100644
index 3e02de691..000000000
--- a/manual/docs/html/energyCalibrationHowTo/node5.html
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-
-
-
-About this document ...
-
-
-
-
- Up: Energy calibration wizard manual
- Previous: Setup calibration files
-Energy calibration wizard manual
-This document was generated using the
-LaTeX 2HTML
-Copyright © 1993, 1994, 1995, 1996,
-Nikos Drakos ,
-Computer Based Learning Unit, University of Leeds.
-Ross Moore ,
-Mathematics Department, Macquarie University, Sydney.
-
-The command line arguments were: latex2html -split 4 energyCalibrationHowTo.tex
-
-The translation was initiated by Thattil Dhanya on 2017-08-24
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientDocs/acquisition.html b/manual/docs/html/slsDetectorClientDocs/acquisition.html
deleted file mode 100644
index 29999682d..000000000
--- a/manual/docs/html/slsDetectorClientDocs/acquisition.html
+++ /dev/null
@@ -1,85 +0,0 @@
-
-
-
-
-Acquition commands
-
-
-
-
Commands to control the acquisition
-
-acquire blocking acquisition (like calling sls_detector_acquire). Starts receiver and detector, writes and processes the data, stops detector. Only get! Returns (string)"acquire unsuccessful" if fails, else "" for MYTHEN, "Acquired (int)" for others, where int is number of frames caught.
-
-busy returns 1 if the acquisition is active, 0 otherwise. Works when the acquisition is started in blocking mode. Only get! Returns
-
- status [s] starts or stops acquisition in detector in non blocking mode. s: [start, stop]. Returns the detector status: [running, error, transmitting, finished, waiting, idle]. Returns
-
-data gets all data from the detector (if any) processes them and writes them to file according to the preferences already setup (MYTHEN only). Only get!
-
-frame gets a single frame from the detector (if any) processes it and writes it to file according to the preferences already setup (MYTHEN only). Only get!
-
-readctr Reads the counters from the detector memory (analog detector returning values translated into number of photons - only GOTTHARD). Cannot put.
-
-resetctr i Resets counter in detector, restarts acquisition if i=1(analog detector returning values translated into number of photons - only GOTTHARD). Cannot put.
-
-resmat i sets/resets counter bit in detector.gets the counter bit in detector ????
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Actions
-
-
-
-
Commands to define scripts to be executed during the acquisition flow
-
-positions [n [p0..pn-1]] sets/gets number of angular position and positions to be acquired.. Returns
-
-startscript [s] sets/gets the script to be executed at the beginning of the acquisition. none unsets. Returns
-
-startscriptpar [s] sets/gets a string to be passed as a parameter to the startscript. Returns
-
-stopscript [s] sets/gets the script to be executed at the end of the acquisition. none unsets. Returns
-
-stopscriptpar [s] sets/gets a string to be passed as a parameter to the stopscript. Returns
-
-scriptbefore [s] sets/gets the script to be executed before starting the detector every time in the acquisition. none unsets. Returns
-
-scriptbeforepar [s] sets/gets a string to be passed as a parameter to the scriptbefore. Returns
-
-scriptafter [s] sets/gets the script to be executed after the detector has finished every time in the acquisition. none unsets. Returns
-
-scriptafterpar [s] sets/gets a string to be passed as a parameter to the scriptafter. Returns
-
-headerafter [s] sets/gets the script to be executed for logging the detector parameters. none unsets. Returns
-
-headerbefore [s] sets/gets the script to be executed for logging the detector parameters. none unsets. Returns
-
-headerbeforepar [s] sets/gets a string to be passed as a parameter to the headerbefore script. Returns
-
-headerafterpar [s] sets/gets a string to be passed as a parameter to the headerafter script. Returns
-
-enacallog [i] enables/disables logging of the parameters necessary for the energy calibration. 1 sets, 0 unsets. Returns
-
-angcallog [i] enables/disables logging of the parameters necessary for the angular calibration. 1 sets, 0 unsets. Returns
-
-scan0script [s] sets/gets the script to be executed for the scan 0 level. none unsets.
-
-scan0par [s] sets/gets a string to be passed as a parameter to the scan0script
-
-scan0prec [i] sets/gets number of digits to be used for the scan0 variable in the file name.
-
-scan0steps [i [s0..sn-1]] sets/gets number of steps (int) of the scan0 level and their values (float).
-
-scan0range [smin smax sstep] sets scan0 min, max and step, returns the number of steps and their values as scan0steps.
-
-scan1script [s] sets/gets the script to be executed for the scan1 level. none unsets.
-
-scan1par [s] sets/gets a string to be passed as a parameter to the scan1script
-
-scan1prec [i] sets/gets number of digits to be used for the scan1 variable in the file name.
-
-scan1steps [i [s0..sn-1]] sets/gets number of steps (int) of the scan1 level and their values (float).
-
-scan1range [smin smax sstep] sets scan1 min, max and step, returns the number of steps and their values as scan1steps.
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Advanced Usage
-
-
-
-
This page is for advanced users. Make sure you have first read the introduction.
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Configuration commands
-
-
-
-
Commands to configure the detector. these commands are often left to the configuration file.
-
-Data Structure : commands to configure detector data structureStatus : commands to configure detector statusData Size : commands to configure detector data sizeFlags : commands to configure detector flagsChip : commands to configure chip of the detectorVersions : commands to check version of each subsytemSpeed : commands to configure speed of detectorDetector Parameters : commands to configure/retrieve configuration of detector
-
-
commands to configure detector data structure
-
- externalgui sets/gets external gui flag. 1 sets and enables the 0MQ data stream (0MQ threads created) from receiver to client, while 0 unsets and disables. Returns
-
-free Free shared memory on the control PC
-
-add Adds a detector at the end of the multi-detector structure. put argument is the hostname or IP adress. Returns the chained list of detector hostnames.
-
-remove i Removes controller i from the multi-detector structure. Can be used for partial readout of the detector.
-
-type Sets/gets detector type. Returns
-
-hostname put adds the hostname (ot IP adress) at the end of the multi-detector structure. If used for a single controlled (i:) replaces the current hostname. Returns the list of the hostnames of the multi-detector structure. Returns
-
-id[:i] Returns the id of the detector structure. i is the detector position in a multi detector system. If used a put, configures the id of the detector structure. i is the detector position in a multi detector system and l is the id of the detector to be added.
-
-master i put sets the position of the master of the acquisition (-1 if none). Returns the position of the master of the detector structure (-1 if none).
-
-sync Sets/gets the synchronization mode of the detectors in the multi-detector structure. Can be: none, gating, trigger, complementary. Mainly used by MYTHEN/GOTTHARD.
-
-
commands to configure detector status
-
-online [i] sets the detector in online (1) or offline (0) mode. Returns
-
-checkonline returns the hostnames of all detectors without connecting to them. Returns (string) "All online" or "[list of offline hostnames] : Not online".
-
-activate Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only. Returns
-
-
commands to configure detector data size
-
-nmod [i] sets/gets the number of modules of the detector. Used for MYTHEN only. Returns
-
-maxmod Gets the maximum number of modules of the detector. Used for MYTHEN only. Cannot put! Returns
-
-dr [i] sets/gets the dynamic range of detector. Mythen [4,8,16,24]. Eiger [4,8,16,32]. Others cannot put! Returns
-
-roi [i] [xmin] [xmax] [ymin] [ymax] sets region of interest of the detector, where i is number of rois;i=0 to clear rois. Used for GOTTHARD only. Returns
-
-detsizechan [xmax] [ymax] sets the maximum number of channels in each dimension for complete detector set; -1 is no limit. Use for multi-detector system as first command in config file. Returns
-
-roimask [i] ?? Returns
-
-flippeddatax [i] enables/disables data being flipped across x axis. 1 enables, 0 disables. Used for EIGER only. 1 for bottom half-module, 0 for top-half module. Returns
-
-tengiga [i] enables/disables 10GbE in system (detector & receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only. Returns
-
-
commands to configure detector flags
-
-flags [flag] sets/gets the readout flags to mode. Options: none, storeinram, tot, continous, parallel, nonparallel, safe, digital, analog_digital, unknown. Used for MYTHEN and EIGER only. Returns returns concatenation of all active flags separated by spaces.
-
-extsig:[i] [flag] sets/gets the mode of the external signal i. Options: off, gate_in_active_high, gate_in_active_low, trigger_in_rising_edge, trigger_in_falling_edge, ro_trigger_in_rising_edge, ro_trigger_in_falling_edge, gate_out_active_high, gate_out_active_low, trigger_out_rising_edge, trigger_out_falling_edge, ro_trigger_out_rising_edge, ro_trigger_out_falling_edge. Returns
-
-programfpga [file] programs the FPGA with file f (with .pof extension). Used for JUNGFRAU, MOENCH only. Only put! Returns
-
-resetfpga [f] resets FPGA, where f can be any value. Used for JUNGFRAU only. Only put! Returns
-
-
commands to configure chip of the detector
-
-powerchip [i] Powers on/off the chip. 1 powers on, 0 powers off. Can also get the power status. Used for JUNGFRAU only. Returns
-
-led [i] sets/gets the led status. 1 on, 0 off. Used for MOENCH only ?? Returns
-
-pulse [n] [x] [y] pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put! Returns
-
-pulsenmove [n] [x] [y] pulses pixel n number of times and moves relatively by x value (x axis) and y value(y axis). Used in EIGER only. Only put! Returns
-
-pulsechip [n] pulses chip n number of times, while n=-1 will reset it to normal mode. Used in EIGER only. Only put! Returns
-
-
Commands to check versions of each subsystem
-
-moduleversion:[i] Gets the firmware version of module i. Used for MYTHEN only. Only get! Returns
-
-detectornumber Gets the serial number or MAC of detector. Only get! Returns
-
-modulenumber:[i] Gets the serial number of module i. Used for MYTHEN only. Only get! Returns
-
-detectorversion Gets the firmware version of detector. Only get! Returns
-
-softwareversion Gets the software version of detector server. Only get! Returns
-
-thisversion Gets the software version of this client software. Only get! Returns
-
-receiverversion Gets the software version of receiver. Only get! Returns
-
-framesl gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-
commands to configure speed of detector
-
-clkdivider [i] sets/gets the readout clock divider. EIGER, JUNGFRAU [0(fast speed), 1(half speed), 2(quarter speed)]. MYTHEN[???]. Returns
-
-setlength [i] sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only. Returns
-
-waitstates [i] sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only. Returns
-
-totdivider [i] sets/gets clock divider in tot mode. Used in MYTHEN only. Returns
-
-totdutycycle [i] sets/gets duty cycle of the tot clock. Used in MYTHEN only. Returns
-
-phasestep [i] Only put for gotthard. Moves the phase of the ADC clock.Returns
-
-oversampling [i] Sets/gets the number of adcsamples per clock. For the new chiptestboard.Returns
-
-adcclk [i] sets/gets the ADC clock frequency in MHz. For the new chiptestboard!Returns
-
-adcphase [i] Sets/gets the ADC clock frequency in MHz. For the new chiptestboard!Returns
-
-adcpipeline [i] Sets/gets the pipeline of the ADC. For the new chiptestbaord!Returns
-
-dbitclk [i] Sets/gets the clock frequency of the latching of the digital bits in MHz. For the new chiptestboard!Returns
-
-dbitphase [i] Sets/gets the phase of the clock for latching of the digital bits. For the new chiptestboard!?Returns
-
-dbitpipeline [i] Sets/gets the pipeline of the latching of the digital bits. For the new chiptestbaord!Returns
-
-
commands to configure/retrieve configuration of detector
-
-config [fname] sets/saves detector/receiver to configuration contained in fname. Same as executing sls_detector_put for every line. Normally a one time operation. Returns
-
-rx_printconfig prints the receiver configuration. Only get! Returns
-
-parameters [fname] sets/saves detector parameters contained in fname. Normally once per different measurement. Returns
-
-setup [fname] sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc. Returns
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Chiptest board
-
-
-
-
Commands specific for the new chiptest board as pattern generator
-
-adcinvert [mask] Sets/gets ADC inversion mask (8 digits hex format)
-
-adcdisable [mask] Sets/gets ADC disable mask (8 digits hex format)
-
-pattern fn loads binary pattern file fn
-
-patword addr [word] sets/gets 64 bit word at address addr of pattern memory. Both address and word in hex format. Advanced!
-
-patioctrl [word] sets/gets 64 bit mask defining input (0) and output (1) signals. hex format.
-
-patclkctrl [word] sets/gets 64 bit mask defining if output signal is a clock and runs. hex format. Unused at the moment.
-
-patlimits [addr1 addr2] sets/gets the start and stop limits of the pattern to be executed. hex format. Advanced!
-
-patloop0 [addr1 addr2] sets/gets the start and stop limits of the level 0 loop. hex format. Advanced!
-
-patnloop0 [n] sets/gets the number of cyclesof the level 0 loop (int).
-
-patwait0 [addr] sets/gets the address of the level 0 wait point. hex format. Advanced!
-
-patwaittime0 [n] sets/gets the duration of the witing of the 0 waiting point in clock cycles (int).
-
-patloop1 [addr1 addr2] sets/gets the start and stop limits of the level 1 loop. hex format. Advanced!
-
-patnloop1 [n] sets/gets the number of cyclesof the level 1 loop (int).
-
-patwait1 [addr] sets/gets the address of the level 1 wait point. hex format. Advanced!
-
-patwaittime1 [n] sets/gets the duration of the witing of the 1 waiting point in clock cycles (int).
-
-patloop2 [addr1 addr2] sets/gets the start and stop limits of the level 2 loop. hex format. Advanced!
-
-patnloop2 [n] sets/gets the number of cyclesof the level 2 loop (int).
-
-patwait2 [addr] sets/gets the address of the level 2 wait point. hex format. Advanced!
-
-patwaittime2 [n] sets/gets the duration of the waiting of the 2 waiting point in clock cycles (int).
-
-dut_clk [i] sets/gets the signal to be used as a clock for the digital data coming from the device under test. Advanced!
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Data processing commands
-
-
-
-
Commands to setup the data processing (mainly MYTHEN related)
-
-flatfield [fn] put sets flatfield file to fn (relative to ffdir). returns the flatfield file name relative to ffdir (string). If
-
-ffdir [d] Sets/gets the directory in which the flat field file is located. Returns
-
-ratecorr [ns] Returns the dead time used for rate correections in ns (int). put sets the deadtime correction constant in ns, -1 will set it to default tau of settings (0 unset). Returns
-
-badchannels [fn] put sets the badchannels file to fn . returns the bad channels file name. If
-
-angconv [fn] put sets the angular conversion file to fn . returns the angular conversion file name. If
-
-globaloff [f] Sets/gets the beamline angular global offset (float).
-
-fineoff [f] Sets/gets the angular fine offset of the measurement (float).
-
-binsize [f] Sets/gets the bin size used for the angular conversion (float).
-
-angdir [i] Sets/gets the angular direction. 1 means increasing channels number as increasing angle, -1 increasing channel number decreasing angle.
-
-moveflag [i] Sets/gets the flag for physically moving the detector during the acquisition of several positions. 1 sets (moves), 0 unsets.
-
-samplex [f] Sets/gets the sample displacement in th direction parallel to the beam in um. Unused!
-
-sampley [f] Sets/gets the sample displacement in th direction orthogonal to the beam in um. Unused!
-
-threaded [i] Sets/gets the data processing threaded flag. 1 is threaded, 0 unthreaded.
-
-darkimage fn Loads the dark image to the detector from file fn (pedestal image). Cannot get.
-
-gainimage fn Loads the gain image to the detector from file fn (gain map for translation into number of photons of an analog detector). Cannot get.
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Introduction
-
-
Introduction This program is intended to control the SLS detectors via command line interface. This is the only way to access all possible functionality of the detectors, however it is often recommendable to avoid changing the most advanced settings, rather leaving the task to configuration files, as when using the GUI or the API provided.
-
The command line interface consists in four main functions:
-
-sls_detector_acquire to acquire data from the detectorsls_detector_put to set detector parameterssls_detector_get to retrieve detector parameterssls_detector_help to get help concerning the text commands Additionally the program slsReceiver should be started on the machine expected to receive the data from the detector.
-
If you need control a single detector, the use of the command line interface does not need any additional arguments.
-
For commands addressing a single controller of your detector, the command cmd should be called with the index i of the controller:
-
sls_detector_clnt i:cmd
-
where sls_detector_clnt is the text client (put, get, acquire, help).
-
In case more than one detector is configured on the control PC, the command cmd should be called with their respective index j:
-
sls_detector_clnt j-cmd
-
where sls_detector_clnt is the text client (put, get, acquire, help).
-
To address a specific controller i of detector j use:
-
sls_detector_clnt j-i:cmd
-
For additional questions concerning the indexing of the detector, please refer to the SLS Detectors FAQ documentation.
-
The commands are sudivided into different pages depending on their functionalities:
-
-Acquisition : commands to start/stop the acquisition and retrieve dataConfiguration : commands to configure the detectorTiming : commands to configure the detector timingData postprocessing : commands to process the data - mainly for MYTHEN except for rate corrections.Settings : commands to define detector settings/threshold.Output : commands to define output file destination and formatActions : commands to define scripts to be executed during the acquisition flowNetwork : commands to setup the network between client, detector and receiverReceiver : commands to configure the receiverChiptest board : commands specific for the new chiptest board as pattern generatorDeveloper : commands to be used only for software debugging. Avoid using them!
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 ; s/[ \t\n]*$//g ; $subst{"_doc"} = $_;
- $_= ; s/[ \t\n]*$//g ; $subst{"_cgi"} = $_;
-}
-
-while ( @ARGV ) {
- $_ = shift @ARGV;
- if ( s/^-// ) {
- if ( /^l(.*)/ ) {
- $v = ($1 eq "") ? shift @ARGV : $1;
- ($v =~ /\/$/) || ($v .= "/");
- $_ = $v;
- if ( /(.+)\@(.+)/ ) {
- if ( exists $subst{$1} ) {
- $subst{$1} = $2;
- } else {
- print STDERR "Unknown tag file $1 given with option -l\n";
- &usage();
- }
- } else {
- print STDERR "Argument $_ is invalid for option -l\n";
- &usage();
- }
- }
- elsif ( /^q/ ) {
- $quiet = 1;
- }
- elsif ( /^\?|^h/ ) {
- &usage();
- }
- else {
- print STDERR "Illegal option -$_\n";
- &usage();
- }
- }
- else {
- push (@files, $_ );
- }
-}
-
-foreach $sub (keys %subst)
-{
- if ( $subst{$sub} eq "" )
- {
- print STDERR "No substitute given for tag file `$sub'\n";
- &usage();
- }
- elsif ( ! $quiet && $sub ne "_doc" && $sub ne "_cgi" )
- {
- print "Substituting $subst{$sub} for each occurence of tag file $sub\n";
- }
-}
-
-if ( ! @files ) {
- if (opendir(D,".")) {
- foreach $file ( readdir(D) ) {
- $match = ".html";
- next if ( $file =~ /^\.\.?$/ );
- ($file =~ /$match/) && (push @files, $file);
- ($file =~ "tree.js") && (push @files, $file);
- }
- closedir(D);
- }
-}
-
-if ( ! @files ) {
- print STDERR "Warning: No input files given and none found!\n";
-}
-
-foreach $f (@files)
-{
- if ( ! $quiet ) {
- print "Editing: $f...\n";
- }
- $oldf = $f;
- $f .= ".bak";
- unless (rename $oldf,$f) {
- print STDERR "Error: cannot rename file $oldf\n";
- exit 1;
- }
- if (open(F,"<$f")) {
- unless (open(G,">$oldf")) {
- print STDERR "Error: opening file $oldf for writing\n";
- exit 1;
- }
- if ($oldf ne "tree.js") {
- while () {
- s/doxygen\=\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\" (href|src)=\"\2/doxygen\=\"$1:$subst{$1}\" \3=\"$subst{$1}/g;
- print G "$_";
- }
- }
- else {
- while () {
- s/\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\", \"\2/\"$1:$subst{$1}\" ,\"$subst{$1}/g;
- print G "$_";
- }
- }
- }
- else {
- print STDERR "Warning file $f does not exist\n";
- }
- unlink $f;
-}
-
-sub usage {
- print STDERR "Usage: installdox [options] [html-file [html-file ...]]\n";
- print STDERR "Options:\n";
- print STDERR " -l tagfile\@linkName tag file + URL or directory \n";
- print STDERR " -q Quiet mode\n\n";
- exit 1;
-}
diff --git a/manual/docs/html/slsDetectorClientDocs/network.html b/manual/docs/html/slsDetectorClientDocs/network.html
deleted file mode 100644
index 99dd143cb..000000000
--- a/manual/docs/html/slsDetectorClientDocs/network.html
+++ /dev/null
@@ -1,115 +0,0 @@
-
-
-
-
-Network
-
-
-
-
Commands to setup the network between client, detector and receiver
-
-rx_hostname [s] sets/gets the receiver hostname or IP address, configures detector mac with all network parameters and updates receiver with acquisition parameters. Normally used for single detectors (Can be multi-detector). none disables. If used, use as last network command in configuring detector MAC. Returns
-
-rx_udpip [ip] sets/gets the ip address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-detector). Used if different from eth0. Returns
-
-rx_udpmac [mac] sets/gets the mac address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-detector). Returns
-
-rx_udpport [port] sets/gets the port of the receiver UDP interface where the data from the detector will be streamed to. Use single-detector command. Returns
-
-rx_udpport2 [port] sets/gets the second port of the receiver UDP interface where the data from the second half of the detector will be streamed to. Use single-detector command. Used for EIGER only. Returns
-
-detectormac [mac] sets/gets the mac address of the detector UDP interface from where the detector will stream data. Use single-detector command. Normally unused. Returns
-
-detectorip [ip] sets/gets the ip address of the detector UDP interface from where the detector will stream data. Use single-detector command. Keep in same subnet as rx_udpip (if rx_udpip specified). Returns
-
-txndelay_left [delay] sets/gets the transmission delay of first packet in an image being streamed out from the detector's left UDP port. Use single-detector command. Used for EIGER only. Returns
-
-txndelay_right [delay] sets/gets the transmission delay of first packet in an image being streamed out from the detector's right UDP port. Use single-detector command. Used for EIGER only. Returns
-
-txndelay_frame [delay] sets/gets the transmission frame period of entire frame being streamed out from the detector for both ports. Use single-detector command. Used for EIGER only. Returns
-
-flowcontrol_10g [delay] Enables/disables 10 GbE flow control. 1 enables, 0 disables. Used for EIGER only. Returns
-
-zmqport [port] sets/gets the 0MQ (TCP) port of the receiver from where data is streamed to the client. Use single-detector command to set individually or multi-detector command to calculate based on port for the rest. Returns
-
-configuremac [i] configures the MAC of the detector with these parameters: detectorip, detectormac, rx_udpip, rx_udpmac, rx_udpport, rx_udpport2 (if applicable). This command is already included in rx_hsotname. Only put!. Returns
-
-rx_tcpport [port] sets/gets the port of the client-receiver TCP interface. Use single-detector command. Is different for each detector if same rx_hostname used. Must be first command to communicate with receiver. Returns
-
-port [port] sets/gets the port of the client-detector control server TCP interface. Use single-detector command. Default value is 1952 for all detectors. Normally not changed. Returns
-
-stopport [port] sets/gets the port of the client-detector stop server TCP interface. Use single-detector command. Default value is 1953 for all detectors. Normally not changed. Returns
-
-lock [i] Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks. Returns
-
-lastclient Gets the last client communicating with the detector. Cannot put!. Returns
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Output settings
-
-
-
-
Commands to setup the file destination and format
-
-outdir [dir] Sets/gets the file output directory. Returns
-
-fname [fn] Sets/gets the root of the output file name Returns
-
-index [i] Sets/gets the current file index. Returns
-
-enablefwrite [i] Enables/disables file writing. 1 enables, 0 disables. Returns
-
-overwrite [i] enables(1) /disables(0) file overwriting. Returns
-
-currentfname gets the filename for the data without index and extension. MYTHEN only. Returns
-
-fileformat sets/gets the file format for data in receiver. Options: [ascii, binary, hdf5]. Ascii is not implemented in Receiver. Returns
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Page Index
-
-
Related Pages Here is a list of all related documentation pages:
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Receiver commands
-
-
-
-
Commands to configure the receiver. Not used in MYTHEN.
-
-receiver [s] starts/stops the receiver to listen to detector packets. Options: [ start, stop]. Returns idle, running].
-
-r_online [i] sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. Returns
-
-r_checkonline Checks the receiver if it is online/offline mode. Only get! Returns (string) "All online" or "[list of offline hostnames] : Not online".
-
-framescaught gets the number of frames caught by receiver. Average of all for multi-detector command. Only get! Returns
-
-resetframescaught [i] resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put! Returns
-
-frameindex [i] gets the current frame index of receiver. Average of all for multi-detector command. Only get! Returns
-
-r_lock [i] locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. Returns
-
-r_lastclient gets the last client communicating with the receiver. Only get! Returns
-
-r_readfreq [i] sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). Returns
-
-rx_fifodepth [i] sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss (loss due to packet processing time in Listener threads), not if limited by writing. Returns
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 do a search
- {
- this.Search();
- }
- }
-
- this.OnSearchSelectKey = function(evt)
- {
- var e = (evt) ? evt : window.event; // for IE
- if (e.keyCode==40 && this.searchIndex0) // Up
- {
- this.searchIndex--;
- this.OnSelectItem(this.searchIndex);
- }
- else if (e.keyCode==13 || e.keyCode==27)
- {
- this.OnSelectItem(this.searchIndex);
- this.CloseSelectionWindow();
- this.DOMSearchField().focus();
- }
- return false;
- }
-
- // --------- Actions
-
- // Closes the results window.
- this.CloseResultsWindow = function()
- {
- this.DOMPopupSearchResultsWindow().style.display = 'none';
- this.DOMSearchClose().style.display = 'none';
- this.Activate(false);
- }
-
- this.CloseSelectionWindow = function()
- {
- this.DOMSearchSelectWindow().style.display = 'none';
- }
-
- // Performs a search.
- this.Search = function()
- {
- this.keyTimeout = 0;
-
- // strip leading whitespace
- var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
-
- var code = searchValue.toLowerCase().charCodeAt(0);
- var hexCode;
- if (code<16)
- {
- hexCode="0"+code.toString(16);
- }
- else
- {
- hexCode=code.toString(16);
- }
-
- var resultsPage;
- var resultsPageWithSearch;
- var hasResultsPage;
-
- if (indexSectionsWithContent[this.searchIndex].charAt(code-32) == '1')
- {
- resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
- resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
- hasResultsPage = true;
- }
- else // nothing available for this search term
- {
- resultsPage = this.resultsPath + '/nomatches.html';
- resultsPageWithSearch = resultsPage;
- hasResultsPage = false;
- }
-
- window.frames.MSearchResults.location.href = resultsPageWithSearch;
- var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
-
- if (domPopupSearchResultsWindow.style.display!='block')
- {
- var domSearchBox = this.DOMSearchBox();
- this.DOMSearchClose().style.display = 'inline';
- if (this.insideFrame)
- {
- var domPopupSearchResults = this.DOMPopupSearchResults();
- domPopupSearchResultsWindow.style.position = 'relative';
- domPopupSearchResultsWindow.style.display = 'block';
- var width = document.body.clientWidth - 8; // the -8 is for IE :-(
- domPopupSearchResultsWindow.style.width = width + 'px';
- domPopupSearchResults.style.width = width + 'px';
- }
- else
- {
- var domPopupSearchResults = this.DOMPopupSearchResults();
- var left = getXPos(domSearchBox) + domSearchBox.offsetWidth;
- var top = getYPos(domSearchBox) + domSearchBox.offsetHeight + 1;
- domPopupSearchResultsWindow.style.display = 'block';
- left -= domPopupSearchResults.offsetWidth;
- domPopupSearchResultsWindow.style.top = top + 'px';
- domPopupSearchResultsWindow.style.left = left + 'px';
- }
- }
-
- this.lastSearchValue = searchValue;
- this.lastResultsPage = resultsPage;
- }
-
- // -------- Activation Functions
-
- // Activates or deactivates the search panel, resetting things to
- // their default values if necessary.
- this.Activate = function(isActive)
- {
- if (isActive || // open it
- this.DOMPopupSearchResultsWindow().style.display == 'block'
- )
- {
- this.DOMSearchBox().className = 'MSearchBoxActive';
-
- var searchField = this.DOMSearchField();
-
- if (searchField.value == this.searchLabel) // clear "Search" term upon entry
- {
- searchField.value = '';
- this.searchActive = true;
- }
- }
- else if (!isActive) // directly remove the panel
- {
- this.DOMSearchBox().className = 'MSearchBoxInactive';
- this.DOMSearchField().value = this.searchLabel;
- this.searchActive = false;
- this.lastSearchValue = ''
- this.lastResultsPage = '';
- }
- }
-}
-
-// -----------------------------------------------------------------------
-
-// The class that handles everything on the search results page.
-function SearchResults(name)
-{
- // The number of matches from the last run of .
- this.lastMatchCount = 0;
- this.lastKey = 0;
- this.repeatOn = false;
-
- // Toggles the visibility of the passed element ID.
- this.FindChildElement = function(id)
- {
- var parentElement = document.getElementById(id);
- var element = parentElement.firstChild;
-
- while (element && element!=parentElement)
- {
- if (element.nodeName == 'DIV' && element.className == 'SRChildren')
- {
- return element;
- }
-
- if (element.nodeName == 'DIV' && element.hasChildNodes())
- {
- element = element.firstChild;
- }
- else if (element.nextSibling)
- {
- element = element.nextSibling;
- }
- else
- {
- do
- {
- element = element.parentNode;
- }
- while (element && element!=parentElement && !element.nextSibling);
-
- if (element && element!=parentElement)
- {
- element = element.nextSibling;
- }
- }
- }
- }
-
- this.Toggle = function(id)
- {
- var element = this.FindChildElement(id);
- if (element)
- {
- if (element.style.display == 'block')
- {
- element.style.display = 'none';
- }
- else
- {
- element.style.display = 'block';
- }
- }
- }
-
- // Searches for the passed string. If there is no parameter,
- // it takes it from the URL query.
- //
- // Always returns true, since other documents may try to call it
- // and that may or may not be possible.
- this.Search = function(search)
- {
- if (!search) // get search word from URL
- {
- search = window.location.search;
- search = search.substring(1); // Remove the leading '?'
- search = unescape(search);
- }
-
- search = search.replace(/^ +/, ""); // strip leading spaces
- search = search.replace(/ +$/, ""); // strip trailing spaces
- search = search.toLowerCase();
- search = convertToId(search);
-
- var resultRows = document.getElementsByTagName("div");
- var matches = 0;
-
- var i = 0;
- while (i < resultRows.length)
- {
- var row = resultRows.item(i);
- if (row.className == "SRResult")
- {
- var rowMatchName = row.id.toLowerCase();
- rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
-
- if (search.length<=rowMatchName.length &&
- rowMatchName.substr(0, search.length)==search)
- {
- row.style.display = 'block';
- matches++;
- }
- else
- {
- row.style.display = 'none';
- }
- }
- i++;
- }
- document.getElementById("Searching").style.display='none';
- if (matches == 0) // no results
- {
- document.getElementById("NoMatches").style.display='block';
- }
- else // at least one result
- {
- document.getElementById("NoMatches").style.display='none';
- }
- this.lastMatchCount = matches;
- return true;
- }
-
- // return the first item with index index or higher that is visible
- this.NavNext = function(index)
- {
- var focusItem;
- while (1)
- {
- var focusName = 'Item'+index;
- focusItem = document.getElementById(focusName);
- if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
- {
- break;
- }
- else if (!focusItem) // last element
- {
- break;
- }
- focusItem=null;
- index++;
- }
- return focusItem;
- }
-
- this.NavPrev = function(index)
- {
- var focusItem;
- while (1)
- {
- var focusName = 'Item'+index;
- focusItem = document.getElementById(focusName);
- if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
- {
- break;
- }
- else if (!focusItem) // last element
- {
- break;
- }
- focusItem=null;
- index--;
- }
- return focusItem;
- }
-
- this.ProcessKeys = function(e)
- {
- if (e.type == "keydown")
- {
- this.repeatOn = false;
- this.lastKey = e.keyCode;
- }
- else if (e.type == "keypress")
- {
- if (!this.repeatOn)
- {
- if (this.lastKey) this.repeatOn = true;
- return false; // ignore first keypress after keydown
- }
- }
- else if (e.type == "keyup")
- {
- this.lastKey = 0;
- this.repeatOn = false;
- }
- return this.lastKey!=0;
- }
-
- this.Nav = function(evt,itemIndex)
- {
- var e = (evt) ? evt : window.event; // for IE
- if (e.keyCode==13) return true;
- if (!this.ProcessKeys(e)) return false;
-
- if (this.lastKey==38) // Up
- {
- var newIndex = itemIndex-1;
- var focusItem = this.NavPrev(newIndex);
- if (focusItem)
- {
- var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
- if (child && child.style.display == 'block') // children visible
- {
- var n=0;
- var tmpElem;
- while (1) // search for last child
- {
- tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
- if (tmpElem)
- {
- focusItem = tmpElem;
- }
- else // found it!
- {
- break;
- }
- n++;
- }
- }
- }
- if (focusItem)
- {
- focusItem.focus();
- }
- else // return focus to search field
- {
- parent.document.getElementById("MSearchField").focus();
- }
- }
- else if (this.lastKey==40) // Down
- {
- var newIndex = itemIndex+1;
- var focusItem;
- var item = document.getElementById('Item'+itemIndex);
- var elem = this.FindChildElement(item.parentNode.parentNode.id);
- if (elem && elem.style.display == 'block') // children visible
- {
- focusItem = document.getElementById('Item'+itemIndex+'_c0');
- }
- if (!focusItem) focusItem = this.NavNext(newIndex);
- if (focusItem) focusItem.focus();
- }
- else if (this.lastKey==39) // Right
- {
- var item = document.getElementById('Item'+itemIndex);
- var elem = this.FindChildElement(item.parentNode.parentNode.id);
- if (elem) elem.style.display = 'block';
- }
- else if (this.lastKey==37) // Left
- {
- var item = document.getElementById('Item'+itemIndex);
- var elem = this.FindChildElement(item.parentNode.parentNode.id);
- if (elem) elem.style.display = 'none';
- }
- else if (this.lastKey==27) // Escape
- {
- parent.searchBox.CloseResultsWindow();
- parent.document.getElementById("MSearchField").focus();
- }
- else if (this.lastKey==13) // Enter
- {
- return true;
- }
- return false;
- }
-
- this.NavChild = function(evt,itemIndex,childIndex)
- {
- var e = (evt) ? evt : window.event; // for IE
- if (e.keyCode==13) return true;
- if (!this.ProcessKeys(e)) return false;
-
- if (this.lastKey==38) // Up
- {
- if (childIndex>0)
- {
- var newIndex = childIndex-1;
- document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
- }
- else // already at first child, jump to parent
- {
- document.getElementById('Item'+itemIndex).focus();
- }
- }
- else if (this.lastKey==40) // Down
- {
- var newIndex = childIndex+1;
- var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
- if (!elem) // last child, jump to parent next parent
- {
- elem = this.NavNext(itemIndex+1);
- }
- if (elem)
- {
- elem.focus();
- }
- }
- else if (this.lastKey==27) // Escape
- {
- parent.searchBox.CloseResultsWindow();
- parent.document.getElementById("MSearchField").focus();
- }
- else if (this.lastKey==13) // Enter
- {
- return true;
- }
- return false;
- }
-}
diff --git a/manual/docs/html/slsDetectorClientDocs/search/search.png b/manual/docs/html/slsDetectorClientDocs/search/search.png
deleted file mode 100644
index 9dd2396db..000000000
Binary files a/manual/docs/html/slsDetectorClientDocs/search/search.png and /dev/null differ
diff --git a/manual/docs/html/slsDetectorClientDocs/settings.html b/manual/docs/html/slsDetectorClientDocs/settings.html
deleted file mode 100644
index 30b9ad4a8..000000000
--- a/manual/docs/html/slsDetectorClientDocs/settings.html
+++ /dev/null
@@ -1,311 +0,0 @@
-
-
-
-
-Detector settings commands
-
-
-
-
Commands to setup the settings of the detector
-
-
-
commands to setup settings/trim/cal directories
-
-settingsdir [dir] Sets/gets the directory where the settings files are located. Returns
-
-trimdir [dir] obsolete settingsdir. Returns
-
-caldir [dir] Sets/gets the directory where the calibration files are located. Returns
-
-trimen [n e0 e1...e(n-1)] Sets/gets the number of energies n at which the detector has default trim file and their values in eV (int). Returns
-
-
commands to configure settings and threshold of detector
-
-settings [s] sets/gets the settings of the detector. Options: standard, fast, highgain, dynamicgain, lowgain, mediumgain, veryhighgain, lownoise, dynamichg0, fixgain1, fixgain2, forceswitchg1, forceswitchg2. threshold or thresholdnotb to pass to detector. Gets from detector. Returns
-
-threshold [eV] [sett] sets/gets the detector threshold in eV. sett is optional and if provided also sets the settings. Use this for Eiger instead of settings. Returns
-
-thresholdnotb [eV] [sett] sets/gets the detector threshold in eV without loading trimbits. sett is optional and if provided also sets the settings. Use this for Eiger instead of settings. Returns
-
-trimbits [fname] loads/stores the trimbits to/from the detector. If no extension is specified, the serial number of each module will be attached. Returns
-
-trim:[mode] [fname] trims the detector according to mode and saves resulting trimbits to file. Mode: noise, beam, improve, fix. Used in MYTHEN only. Only put! Returns
-
-trimval [i] sets all trimbits to i. Used in EIGER only. Returns
-
-pedestal [i] starts acquisition for i frames, calculates pedestal and writes back to fpga. Used in GOTTHARD only. Only put! Returns
-
-
commands to configure DACs of detector
-
-vthreshold [i] [mv] Sets/gets detector threshold voltage for single photon counters. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcalibration [i] [mv] Sets/gets the voltage of the calibration pulses. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vtrimbit [i] [mv] Sets/gets the voltage to set the width of the trimbits. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vpreamp [i] [mv] Sets/gets the voltage to define the preamplifier feedback resistance. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vhaper1 [i] [mv] Sets/gets the voltage to define the feedback resistance of the first shaper. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vshaper2 [i] [mv] Sets/gets the voltage to define the feedback resistance of the second shaper. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vhighvoltage [i] Sets/gets the high voltage to the sensor in V. Returns
-
-vapower [i] Sets/gets the analog power supply for the old chiptest board in DAC units. Returns
-
-vddpower [i] Sets/gets the digital power supply for the old chiptest board in DAC units. Returns
-
-vshpower [i] Sets/gets the comparator power supply for the old chiptest board in DAC units. Returns
-
-viopower [i] Sets/gets the power supply of the FPGA I/Os for the old chiptest board in DAC units. Returns
-
-vrefds [i] [mv] Sets/gets vrefds. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcascn_pb [i] [mv] Sets/gets vcascn_pb. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcasc_pb [i] [mv] Sets/gets vcasc_pb. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vout_cm [i] [mv] Sets/gets vout_cm. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcasc_out [i] [mv] Sets/gets vcasc_out. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vin_com [i] [mv] Sets/gets vin_com. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vref_comp [i] [mv] Sets/gets vref_comp. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-ib_test_c [i] [mv] Sets/gets ib_test_c. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-dac[0..7] [i] [mv] Sets/gets dac[0..7] for MOENCH02. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vsvp [i] [mv] Sets/gets vsvp. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vsvn [i] [mv] Sets/gets vsvn. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vtr [i] [mv] Sets/gets vtr. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vrf [i] [mv] Sets/gets vrf. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vrs [i] [mv] Sets/gets vrs. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vtgstv [i] [mv] Sets/gets vtgstv. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcmp_ll [i] [mv] Sets/gets vcmp_ll. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcmp_lr [i] [mv] Sets/gets vcmp_lr. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcal_l [i] [mv] Sets/gets vcal_l. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcomp_rl [i] [mv] Sets/gets vcomp_rl. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcomp_rr [i] [mv] Sets/gets vcomp_rr. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-rxb_rb [i] [mv] Sets/gets rxb_rb. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-rxb_lb [i] [mv] Sets/gets rxb_lb. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcp [i] [mv] Sets/gets vcp. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vcn [i] [mv] Sets/gets vcn. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-vis [i] [mv] Sets/gets vis. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-iodelay [i] [mv] Sets/gets iodelay. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-dac:j [i] [mv] Sets/gets value for DAC number j for the new chiptestboard. Normally in DAC units unless mv is specified at the end of the command line. Returns
-
-adcvpp [i] Sets/gets the Vpp of the ADC 0 -> 1V ; 1 -> 1.14V ; 2 -> 1.33V ; 3 -> 1.6V ; 4 -> 2V . Returns
-
-v_a [i] mv Sets/gets value for Va on the new chiptest board. Must be in mV. Returns
-
-v_b [i] mv Sets/gets value for Vb on the new chiptest board. Must be in mV. Returns
-
-v_c [i] mv Sets/gets value for Vc on the new chiptest board. Must be in mV. Returns
-
-v_d [i] mv Sets/gets value for Vd on the new chiptest board. Must be in mV. Returns
-
-v_io [i] mv Sets/gets value for Vio on the new chiptest board. Must be in mV. Returns
-
-v_chip [i] mv Sets/gets value for Vchip on the new chiptest board. Must be in mV. Returns
-
-v_limit [i] mv Sets/gets a soft limit for the power supplies and the DACs on the new chiptest board. Must be in mV. Returns
-
-
commands to readout ADCs of detector
-
-temp_adc Gets the ADC temperature. Returns EIGER,JUNGFRAU(double"°C") Others
-
-temp_fpga Gets the FPGA temperature. Returns EIGER,JUNGFRAU(double"°C") Others
-
-temp_fpgaext Gets the external FPGA temperature. Used in EIGER only. Returns EIGER(double"°C")
-
-temp_10ge Gets the 10Gbe temperature. Used in EIGER only. Returns EIGER(double"°C")
-
-temp_dcdc Gets the temperature of the DC/DC converter. Used in EIGER only. Returns EIGER(double"°C")
-
-temp_sodl Gets the temperature of the left so-dimm memory . Used in EIGER only. Returns EIGER(double"°C")
-
-temp_sodr Gets the temperature of the right so-dimm memory. Used in EIGER only. Returns EIGER(double"°C")
-
-adc:j Gets the values of the slow ADC number j for the new chiptest board. Returns
-
-temp_fpgal Gets the temperature of the left frontend FPGA. Used in EIGER only. Returns EIGER(double"°C")
-
-temp_fpgar Gets the temperature of the right frontend FPGA. Used in EIGER only. Returns EIGER(double"°C")
-
-i_a Gets the current of the power supply a on the new chiptest board. Returns
-
-i_b Gets the current of the power supply b on the new chiptest board Returns
-
-i_c Gets the current of the power supply c on the new chiptest board Returns
-
-i_d Gets the current of the power supply d on the new chiptest board Returns
-
-i_io Gets the current of the power supply io on the new chiptest board Returns
-
-vm_a Gets the measured voltage of the power supply a on the new chiptest board Returns
-
-vm_b Gets the measured voltage of the power supply b on the new chiptest board Returns
-
-vm_c Gets the measured voltage of the power supply c on the new chiptest board Returns
-
-vm_d Gets the measured voltage of the power supply d on the new chiptest board Returns
-
-vm_io Gets the measured voltage of the power supply io on the new chiptest board Returns
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Developer
-
-
-
-
Commands to be used only for software debugging. Avoid using them!
-
-
-help Returns a list of possible commands.
-
-exitserver Shuts down all the detector servers. Don't use it!!!!
-
-exitreceiver Shuts down all the receivers. Don't use it!!!!
-
-flippeddatay [i] enables/disables data being flipped across y axis. 1 enables, 0 disables. Not implemented.
-
-digitest [i] will perform test which will plot the unique channel identifier, instead of data. Only get!
-
-bustest performs test of the bus interface between FPGA and embedded Linux system. Can last up to a few minutes. Cannot set! Used for Mythen only. Only get!
-
-digibittest:[i] performs digital test of the module i. Returns 0 if succeeded, otherwise error mask. Only put!
-
-reg [addr] [val] ??? writes to an register addr with value in hexadecimal format.
-
-adcreg [addr] [val] ??? writes to an adc register addr with value in hexadecimal format. Only put!
-
-
-clearbit ??? Only put!
-
-
-r_compression [i] sets/gets compression in receiver. 1 sets, 0 unsets. Not implemented.
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 Timing commands
-
-
-
-
Commands to setup the timing
-
-timing [mode] sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating (string)
-
-exptime [i] sets/gets exposure time in s. Returns
-
-subexptime [i] sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. Returns
-
-period [i] sets/gets frame period in s. Returns
-
-delay [i] sets/gets delay in s. Used in MYTHEN, GOTTHARD only. Returns
-
-gates [i] sets/gets number of gates. Used in MYTHEN, GOTTHARD only. Returns
-
-frames [i] sets/gets number of frames. If timing is not auto, then it is the number of frames per cycle/trigger. Returns
-
-cycles [i] sets/gets number of triggers. Timing mode should be set appropriately. Returns
-
-probes [i] sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-probe events. Used in MYTHEN only. Returns
-
-measurements [i] sets/gets number of measurements. Returns
-
-samples [i] sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. Returns
-
-exptimel gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-periodl gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-delayl gets delay left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-gatesl gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-cyclesl gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-probesl gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! Returns
-
-now Actual time of the detector. Only get!
-
-timestamp Last frame timestamp for MYTHEN. Only get!
-
-
-
-
-
-
-
-
-
-Generated on 24 Aug 2017 by
-
- 1.6.1 SLS Detector text clients manual
-
-
- Next: Introduction
-
-
-
SLS Detector text clients manual
-
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/labels.pl b/manual/docs/html/slsDetectorClientHowTo/labels.pl
deleted file mode 100644
index e5b868d94..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/labels.pl
+++ /dev/null
@@ -1,13 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate labels original text with physical files.
-
-
-1;
-
-
-# LaTeX2HTML 2008 (1.71)
-# labels from external_latex_labels array.
-
-
-1;
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/node1.html b/manual/docs/html/slsDetectorClientHowTo/node1.html
deleted file mode 100644
index c6faa0251..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/node1.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-
-Introduction
-
-
-
-
-
-
- Next: Acquisition
- Up: SLS Detector text clients
- Previous: SLS Detector text clients
-
-This program is intended to control the SLS detectors via command line interface.
-
-The command line interface consists in four main functions:
-
-sls_detector_acquire to acquire data from the detector
-
-sls_detector_put to set detector parameters
-
-sls_detector_get to retrieve detector parameters
-
-sls_detector_help to get help concerning the text commands
-
-
-Additionally the program slsReceiver should be started on the machine expected to receive the data from the detector.
-
-
-If you need control a single detector, the use of the command line interface does not need any additional arguments.
-
-
-For commands addressing a single controller of your detector, the command cmd should be called with the index i of the controller:
-sls_detector_clnt i:cmd
-sls_detector_clnt is the text client (put, get, acquire, help).
-
-
-In case more than one detector is configured on the control PC, the command cmd should be called with their respective index j:
-sls_detector_clnt j-cmd
-sls_detector_clnt is the text client (put, get, acquire, help).
-
-
-To address a specific controller i of detector j use:
-sls_detector_clnt j-i:cmd
-
-
-For additional questions concerning the indexing of the detector, please refer to the SLS Detectors FAQ documentation.
-
-
-
-
-
-
-
-
- Next: Acquisition
- Up: SLS Detector text clients
- Previous: SLS Detector text clients
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/node2.html b/manual/docs/html/slsDetectorClientHowTo/node2.html
deleted file mode 100644
index 90e08c7b9..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/node2.html
+++ /dev/null
@@ -1,74 +0,0 @@
-
-
-
-
-
-Acquisition
-
-
-
-
-
-
- Next: Detector setup
- Up: SLS Detector text clients
- Previous: Introduction
-
-By calling:
-sls\_detector\_acquire [j-]
-j is started and the data are acquired, postprocessed and written to file according to the configuration and setup of the measurements.
-
-For additional questions concerning the acquisition flow, please refer to the SLS Detectors FAQ documentation.
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/node3.html b/manual/docs/html/slsDetectorClientHowTo/node3.html
deleted file mode 100644
index afe4838f4..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/node3.html
+++ /dev/null
@@ -1,769 +0,0 @@
-
-
-
-
-
-Detector setup
-
-
-
-
-
-
- Next: Retrieving detector parameters
- Up: SLS Detector text clients
- Previous: Acquisition
-Subsections
-sls\_detector\_put [j-][i:]var arg
-
-is used to configure the detector parameters var with the value arg.
-sls\_detector\_get with the same command.
-
-
-
-
-
-
-
-config fname Load the configuration file fname.
-examples. This should be done every time the configuration of the detectors(s) changes or the control PC is rebooted. Must be executed on all the control PCs, before executing other commands.
-
-parameters fname Load the parameter file fname.
-examples.
-
-settings sett Configures the settings of the detector. Refer to detailed detector documentation for more details:
-
-threshold ev For photon counting detectors, sets the detector threshold in eV. The detector should be properly calibrated, otherwise standard calibration coefficients are used, which can give an uncertainty up to a few keVs.
-
-timing sync Sets the timing mode of the detector. Can be auto, gating (works only if at least one of the signals is configured as gate_in), trigger (works only if at least one of the signals is configured as trigger_in), ro_trigger (works only if at least one of the signals is configured as ro_trigger_in), triggered_gating (works only if one of the signals is configured as gate_in and one as trigger_in).
-
-outdir path Defines the path where the output files will be saved to.
-
-fname prefix Defines the prefix of the file name for the data output.
-prefix[_dd ][_Sv0 ][_sv1 ][_pp ][_ff ]_i .ext
-d is the controller index, in case of data receiver and more than one controller;
-v0 is the scan0 variable with the desired precision, if scan0 is enabled;
-v1 is the scan1 variable with the desired precision, if scan1 is enabled;
-p is the position index, if different positions are configured;
-f is the frame index of the first frame stored in the file, if many frames and cycles are configured;
-i is the file index;
-ext is the file extension e.g. .raw for MYTHEN and EIGER raw data, .dat for MYTHEN processed data.
-
-index i Sets the starting index of the file i at the beginning of the acquisition (automatically incremented for each measurement).
-
-enablefwrite b Enables (1) or disables (0) file writing.
-
-exptime ts Sets the exposure time of a single acquisition to ts (in s). It is overridden in case the detector is in gating mode.
-
-subexptime ts Sets the subexposure time of a single subacquisition to ts (in s) in EIGER autosumming mode (=dr 32 ). Refer to detailed documentation to understand how the different timing modes work.
-
-period ts Sets the frames period (in s). It is overridden in case the detector is in gating mode.
-
-delay ts Sets the delay after trigger in triggered mode (in s).
-
-gates n Sets the number of gates per frame in gated (stroboscopic) mode.
-
-frames n Sets the number of frames acquired sequentially per cycle (e.g. after each trigger), with the exposure time defined by exptime and the period defined by period (unless in gated mode). The frame index in the output file name will automatically be incremented.
-
-cycles n Sets the number of cycles (e.g. number of triggers). The frame index in the output file name will automatically be incremented.
-
-probes Sets the number of probes to accumulate for stroboscopic measurements.
-
-measurements Sets the number of repetitions of the acquisitions (non real time!). The file index in the file name will be automatically incremented.
-
-dr n Sets the dynamic range n (in bits) of the data for a photon counting detector. For EIGER it can be set to 4, 8, 16 (but the real counter depth will still be limited to 12 bits) or 32 when one wants to activate the internal subframe summing mode.
-
-
-
-flags s Sets some particular flags for your detector. For MYTHEN s can be none , storeinram (for buffered readout) or tot (for time over threshold). For EIGER, s can be continous (for continous readout- still buffer on memories happens), storeinram (for buffered readout. Do not use as has no graet advantages), parallel for parallel exposure to the next frame and readout of the previous frame, nonparallel to decouple sequentially readout and exposure, safe (rowclock interleaved).
-
-help cmd Returns the help for command cmd.
-
-lock Locks (1) or unlocks (0) the detector to this particular control PC. An be unlocked again only from the same PC or by rebooting the detector.
-
-nmod n Sets the number of modules for the detector to n for partial readout. Will be replaced by ROI.
-
-
-
-
-
-
-
-flatfield fname Sets the flat field file name. File ffdir/fname will be used to calculate the flat field coefficients. none to unset flat field corrections.
-
-ratecorr ns Sets the deadtime to be used for rate corrections in ns. 0 to unset, -1 to use default dead time for the actual settings.In the case of EIGER, as online data rate correctiosn are applied, then a correction table has to be calculated every time the rate correction
-
-
-
-
-
-
-
-
-
-fineoff deg Sets the fine offset for the experiment.
-
-samplex mm Sets the sample displacement from the center of the diffractometer in the X-ray direction, to improve angular conversion (unused).
-
-sampley mm Sets the sample displacement from the center of the diffractometer in the ortogonal direction, to improve angular conversion (unused)
-
-
-
-
-
-
-See SLS Detectors Documentation for a detailed description of the acquisition flow.
-
-positions n p1 p2...pn Sets the number of positions n and their value.
-
-
-startscript s Sets the script to be executed at the beginning of each measurement. none unsets.
-
-
-startscriptpar p Sets the parameter to be passed to the start script
-
-
-stopscript s Sets the script to be executed at the end of each measurement. none unsets.
-
-
-stopscriptpar p Sets the parameter to be passed to the stop script.
-
-
-scriptbefore s Sets the script to be executed before each acquisition. none unsets.
-
-
-scriptbeforepar p Sets the parameter to be passed to the script before.
-
-
-scriptafter s Sets the script to be executed after each acquisition. none unsets.
-
-
-scriptafterpar p Sets the parameter to be passed to the script after.
-
-
-headerbefore s Sets the script to be executed to acquire the header of the acquisition. none unsets.
-
-
-headerbeforepar p Sets the parameter to be passed to the header before.
-
-
-headerafter s Sets the script to be executed to append to the header of the acquisition. none unsets.
-
-
-headerafterpar p Sets the parameter to be passed to the header after.
-
-
-scan0scripts s Sets the script to execute at scan 0 level. none unsets, threshold, energy, trimbits, position perform the corresponding scans without need of a custom script.
-
-
-scan0par p Sets a parameter to be passed to the scan 0 level script.
-
-
-scan0prec i Sets the number of decimal digits for the scan0 level parameter in the file name (default is 0).
-
-
-scan0steps n s1 s2..sn Sets the number of scan 0 level steps n and their value.
-
-
-scan0range min max step Sets the minimum, the maximum and the step for the scan 0 level steps (easier to use than scan0steps if equally spaced steps in a range)
-
-
-scan1script s Sets the script to execute at scan 1 level. none unsets, threshold, energy, trimbits, position perform the corresponding scans without need of a custom script.
-
-
-scan1par p Sets a parameter to be passed to the scan 1 level script.
-
-
-scan1prec i Sets the number of decimal digits for the scan1 level parameter in the file name (default is 0).
-
-
-scan1steps n s1 s2...sn Sets the number of scan 0 level steps n and their value.
-
-
-scan1range min max step Sets the minimum, the maximum and the step for the scan 0 level steps (easier to use than scan0steps if equally spaced steps in a range)
-
-
-
-
-
-
-
-
-
-
-This operations should be performed only rarely to configure the detector
-
-
-
-trim:mode fname Trims the detector according to mode (can be noise, beam, improve, fix) and saves the resulting trimbits to file fname. Take care to set a proper exptime and vthreshold before trimming.
-
-
-encallog b Sets (1) or unsets (0) the logging for energy calibration.
-
-
-angcallog b Sets (1) or unsets (0) the logging for angular calibration.
-
-
-
-
-
-
-
-
-It is normally recommended to use sls\_detector\_acquire [j-], which takes care of everything
-
-status s Starts (start) or stops (stop) the detector acquisition.
-
-online b Sets the detector in online (1) or offline (0) mode.
-
-resetctr i GOTTHARD- ADVANCED- resets counter in detector, restarts acquisition if i=1
-
-resmat i EIGER- ADVANCED - resets counter in detector before the following acquisition. Default settings is resmat 1 . resmat 0 does not reset the counter bit before the acquisition. Note that in EIGER the counter is always reset after the acquisition.
-
-
-
-
-
-
-Advanced commands to configure the detector system. Should be left to the configuration file
-
-type s Sets the types of detector controllers in the system. Can be Mythen, Gotthard, EIGER and multiple controllers should be catenated with a + (e.g. Mythen+Mythen for 2 Mythen controllers).
-
-d:hostname s Sets the hostname or IP address for the controller d, where d is the controller index within the detector structure.
-
-d:extsig:i s Configures the usage of the external IO signals to synchronize the detectors. s can be: off, gate_in_active_high, gate_in_active_low, trigger_in_rising_edge,
- trigger_in_falling_edge,
- ro_trigger_in_rising_edge,
- ro_trigger_in_falling_edge,
- gate_out_active_high,
- gate_out_active_low,
- trigger_out_rising_edge,
- trigger_out_falling_edge,
- ro_trigger_out_rising_edge,
- ro_trigger_out_falling_edge, sync.
-
-
-master i Sets the master of a multi-controller detector to the controller with index i. -1 removes master. Setting a master is useful only if the controllers are synchronized via hardware using the external IO signals. Usually left to the configuration file. Please refer to SLS Detectors FAQ documentation for more detailed information about the usage.
-
-sync s Sets the synchronization mode of the various controller within a detector structure. s acn be none, gating, trigger, complementary. Check that the detectors are correctly connected to avoid freezing of the acquisition. Usually left to the configuration file. Please refer to SLS Detectors FAQ documentation for more detailed information about the usage.
-
-trimdir s Obsolete. Same ad settingsdir.
-
-settingsdir s Sets the path of the drectory where the trim/settings files are stored. Usually left to the configuration file.
-
-caldir s Sets the path of the drectory where the calibration files are stored. Can be the same as settingsdir. Usually left to the configuration file.
-
-trimen n e1 e2 ...en Unused. Sets the list of energies for which trimfiles exist.
-
-port p Sets the port used by the sockets to control the detector. Do not change! Usually left to the configuration file.
-
-stopport p Sets the port used by the sockets to stop/get the status of the detector. Do not change! Usually left to the configuration file.
-
-add s Avoid using it. Adds the controller s to the detector structure.
-
-remove i Avoid using it. Removes the controller in position i from the detector structure.
-
-id:i l Avoid using it. configures the id of the detector structure. i is the detector position in a multi detector system and l is the id of the detector to be added.
-
-free i Avoid using it. Frees the shared memory.
-
-exitserver Avoid using it. Turns off the communication server on the detector.
-
-
-
-
-
-
-
-detectormac mac sets the mac of the detector udp interface to mac (if configurable). Should be left to the configuration file.
-
-rx_tcpport i sets the communication port between client and receiver. Should be left to the configuration file.
-
-rx_udpport i sets the communication port between detector and receiver. Should be left to the configuration file.
-
-rx_hostname s sets the hostname (or IP address) of the receiver for the TCP/IP interface with the client.
-
-rx_udpip ip sets the IP address of the receiver for the UDP interface with the detector.
-
-rx_fifodepth v sets receiver fifo depth to value v. Default for EIGER is 100 frames betweeen listening and writing.
-
-r_online b sets the receiver in online (1) or offline (0) mode.
-
-r_lock b Locks (1) or unlocks (0) the receiver to this PC.
-
-receiver s starts/stops the receiver to listen to detector packets. - can be start or stop
-
-
-
-
-
-
-Some advanced commands to configure data postprocessing.
-
-ffdir dir Sets the directory where the flat field files are stored. Normally left to the configuration file.
-
-darkimage fname GOTTHARD- ADVANCED- Sets fname as dark image file for the detector.
-
-gainimage fname GOTTHARD- ADVANCED- Sets fname as gain image file for the detector.
-
-badchannels fname Sets the bad channel file to fname. Bad channels will be omitted in the .dat file. none to unset. Normally left to the configuration file.
-
-threaded b Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0). Normally left to the configuration file.
-
-
-
-
-Angular conversion
-
-
-
-globaloff deg Sets the offset of the beamline i.e. angular position of channel 0 when angular encoder at 0. Normally left to the configuration file.
-
-angconv fname Sets the file with the coefficients for angular conversion. none disables angular conversion. Normally left to the configuration file.
-
-binsize deg Sets the size of the angular bins for angular coversion. Normally left to the configuration file.
-
-angdir i Sets the angular direction of the detector (1 means channel number in the same direction as the angular encoder, -1 different direction). Normally left to the configuration file.
-
-d:moveflag i Related to a single controller d. 1 if the detector modules move with the angular encoder, 0 if they are static (useful for multidetector systems). Normally left to the configuration file.
-
-
-
-
-
-
-Some VERY ADVANCED testing functions implemented for EIGER:
-
-pulsechip n sets the chip into test mode with resmat = 0 and externalenable =1. Pulses chip by togglying the enable n number of times. The acquire is then done with no pixel matrix reset before the acquisition. If n
-pulse n x y Pulses pixel at coordinates (x,y) n number of times.
-
-pulsenmove n x y Pulses pixel n number of times and moves relatively by x value (x axis) and y value (y axis)
-
-
-
-
-
-
-Advanced settings changing the analog or digital performance of the acquisition. Use them only if you are sure of what you are doing!
-
-
-
-vthreshold n Sets the DAC value of the detector threshold to n.
-
-vcalibration n Sets the DAC value of the calibration pulse amplitude to n.
-
-vtrimbit n Sets the DAC value defining the trimbits LSB size to n.
-
-vpreamp n Sets the DAC value of the preamp feedback to n.
-
-vshaper1 n Sets the DAC value of the shaper1 feedback to n.
-
-vshaper2 n Sets the DAC value of the shaper2 feedback to n.
-
-vhighvoltage n Sets the DAC value of the high voltage to n (in V).
-
-vapower n CHIPTEST BOARD ONLY - Sets the DAC value of the analog voltage to n.
-
-vddpower n CHIPTEST BOARD ONLY - Sets the DAC value of the analog voltage to n.
-
-vshpower n CHIPTEST BOARD ONLY - Sets the comparator power supply in dac units (0-1024).
-
-viopower n CHIPTEST BOARD ONLY - Sets the FPGA I/O power supply in dac units (0-1024).
-
-vref_ds n Sets vrefds
-
-vcascn_pb n Sets vcascn_pb
-
-vcascp_pb n Sets vcascp_pb
-
-vout_cm n Sets vout_cm
-
-vcasc_out n Sets vcasc_out
-
-vin_cm n Sets vin_cm
-
-vref_comp n Sets vref_comp
-
-ib_test_c n Sets ib_test_c
-
-vsvp n Sets vsvp DAC to n
-
-vsvn n Sets vsvn DAC to n
-
-vtr n Sets vtr DAC to n
-
-vrf n Sets vrf DAC to n
-
-vrs n Sets vrs DAC to n
-
-vtgstv n Sets vtgstv DAC to n
-
-vcmp_ll n Sets vcmp_ll DAC to n
-
-vcmp_lr n Sets vcmp_lr DAC to n
-
-vcmp_rl n Sets vcmp_rl DAC to n
-
-vcmp_rr n Sets vcmp_rr DAC to n
-
-vcall n Sets vcall DAC to n
-
-rxb_rb n Sets rxb_rb DAC to n
-
-rxb_lb n Sets rxb_rb DAC to n
-
-vcp n Sets vcp DAC to n
-
-vcn n Sets vcn DAC to n
-
-vis n Sets vis DAC to n
-
-iodelay n Sets iodelay to n
-
-reg a d Write to register of address a the data d
-
-clkdivider n Sets the clock divider for the readout. Can be increased for longer cables. For EIGER options are 0 (full speed), 1 (half speed), 2 (quarter speed), and 3 (slow).
-
-setlength n Changes the length of the set/reset signals in the acquisition. Never reduce it!
-
-waitstates n Sets the wait states for CPU/FPGA communication. Do not change it!
-
-totdivider n Sets the tot clock divider.
-
-totdutycycle n Sets the tot duty cycle.
-
-setup s Loads the setup files to the detector (config, parameters, trimbits etc.).
-
-trimbits fn Loads the trimbit files fn.snxxx to the detector
-
-
-
-
-
-
-
-digibittest i only for GOTTHARD. If i=1, the acquisition will return a unique channel identifier, instead of data, if i=0 normal acquisition.
-
-
-
-
-
-
-
-
-
-
- Next: Retrieving detector parameters
- Up: SLS Detector text clients
- Previous: Acquisition
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/node4.html b/manual/docs/html/slsDetectorClientHowTo/node4.html
deleted file mode 100644
index f1ecf7e20..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/node4.html
+++ /dev/null
@@ -1,821 +0,0 @@
-
-
-
-
-
-Retrieving detector parameters
-
-
-
-
-
-
- Next: Usage
- Up: SLS Detector text clients
- Previous: Detector setup
-Subsections
-sls\_detector\_get [j-][i:]var [arg]
-
-is used to retrieve the detector parameters var.
-arg is needed.
-
-
-
-
-All the commends return two strings, where string1 is the command, string2 is teh actual returned string.
-
-
-
-config fname Dumps the current configuration of the detector to the file fname.
-
-parameters fname Dumps the current acquisition parameters of the detector to the file fname.
-
-settings Returns the current settings of the detector. Returns a string
-
-
-
-threshold For photon counting detectors, returns the detector threshold in eV, -1 if undefined. Returns ``threshold value_in_eV''. If it fails, the returned threshold is the old set value.
-
-
-
-timing Returns the acquisition timing mode of the detector.
-Refer to the detailed documentation to understand how the different timing modes work.
-
-outdir Returns the path where the output files are saved to.
-
-fname Returns the prefix of the file name for the data output.
-
-enablefwrite Returns if data are written to file (1) or not (0).
-
-exptime Returns the exposure time of a single acquisition in seconds. Example: "exptime 1.000000000''
-Refer to detailed documentation to understand how the different timing modes work.
-
-period Returns the frames period (in s). Example: ``period 1.000000000''
-Refer to detailed documentation to understand how the different timing modes work.
-
-delay Returns the delay after trigger in triggered mode (in s).
-Refer to detailed documentation to understand how the different timing modes work.
-
-gates Returns the number of gates per frame in gated (stroboscopic) mode.
-Refer to detailed documentation to understand how the different timing modes work.
-
-frames Returns the number of frames acquired sequentially per cycle (e.g. after each trigger), with the exposure time defined by exptime and the period defined by period (unless in gated mode). Returned as a string to be interpreted as an integer ``frames integer''
-Note that the total number of images is frames times cycles.
-Refer to detailed documentation to understand how the different timing modes work.
-
-cycles n Returns the number of cycles (e.g. number of triggers). Returned as atring to be interpreted as an integer ``cycles integer''
-Note that the total number of images is frames times cycles.
-Refer to detailed documentation to understand how the different timing modes work.
-
-probes Returns the number of probes to accumulate for stroboscopic measurements.
-Refer to detailed documentation to understand how the different timing modes work.
-
-measurements Returns the number of repetitions of the acquisitions (non real time!).
-Refer to detailed documentation to understand how the different timing modes work.
-
-dr Returns the dynamic range n (in bits) of the data for a photon counting detector. Returns a string that should be interpreted as an integer.
-
-
-
-flags s Returns the flags set for your detector.
-
-help cmd Returns the help for command cmd.
-
-lock Returns if the detector is locked to a single PC.
-
-lastclient Returns the last client which has connected to the detector.
-
-nmod n Returns the number of modules which are read out. Will be replaced by ROI.
-
-maxmod Returns the maximum number of modules (size) of the detector. Will be replaced by size.
-
-
-
-
-
-
-
-flatfield Returns the flat field file name.
-
-ratecorr Returns the dead time used for rate corrections.
-
-
-
-
-
-
-
-
-
-fineoff Returns the fine offset used to convert channel number to angles
-
-samplex Returns the sample displacement from the center of the diffractometerin the X-ray direction, to improve angular conversion (unused).
-
-sampley Returns the sample displacement from the center of the diffractometer in the ortogonal direction, to improve angular conversion (unused)
-
-
-
-
-
-
-See SLS Detectors Documentation for a detailed description of the acquisition flow.
-
-positions Returns the number of positions n and their value.
-
-
-startscript Returns the script to be executed at the beginning of each measurement.
-
-
-startscriptpar Returns the parameter to be passed to the start script
-
-
-stopscript Returns the script to be executed at the end of each measurement.
-
-
-stopscriptpar Returns the parameter to be passed to the stop script.
-
-
-scriptbefore Returns the script to be executed before each acquisition.
-
-
-scriptbeforepar Returns the parameter to be passed to the script before.
-
-
-scriptafter Returns the script to be executed after each acquisition.
-
-
-scriptafterpar Returns the parameter to be passed to the script after.
-
-
-headerbefore Returns the script to be executed to acquire the header of the acquisition.
-
-
-headerbeforepar Returns the parameter to be passed to the header before.
-
-
-headerafter Returns the script to be executed to append to the header of the acquisition.
-
-
-headerafterpar Returns the parameter to be passed to the header after.
-
-
-scan0scripts Returns the script to execute at scan 0 level.
-
-
-scan0par Returns a parameter to be passed to the scan 0 level script.
-
-
-scan0prec Returns the number of decimal digits for the scan0 level parameter in the file name (default is 0).
-
-
-scan0steps Returns the number of scan 0 level steps n and their value.
-
-
-scan0range Same as scan0steps.
-
-
-scan1script Returns the script to execute at scan 1 level.
-
-
-scan1par Returns a parameter to be passed to the scan 1 level script.
-
-
-scan1prec Returns the number of decimal digits for the scan1 level parameter in the file name (default is 0).
-
-
-scan1steps Returns the number of scan 0 level steps n and their value.
-
-
-scan1range Same as scan1steps.
-
-
-
-
-
-
-Commands to be used to retrieve information about the detector version or perform tests.
-
-
-
-moduleversion[:i] Returns the version of the module firmware.
-
-detectornumber Returns the serial number of the module (normally the MAC address).
-
-modulenumber[:i] Returns the serial number of the module i.
-
-detectorversion Returns the version of the controller firmware.
-
-softwareversion Returns the version of the software running on the detector.
-
-thisversion Returns the version of the control software which is being used.
-
-detectorsvnversion Returns the SVN version of the software on the detector.
-
-
-
-
-
-
-
-
-
-digitest[:i] Makes a digital test of module i. Afterwards the detector must be reconfigured for the acquisition (settings, threshold, exptime, dr, frames etc.). Returns 0 if succeeded, otherwise an error mask.
-
-bustest Makes a digital test of the communication between CPU and FPGA. Returns 0 if succeeded, otherwise the number of errors.
-
-
-
-
-
-
-
-
-
-
-This operations should be performed only rarely to configure the detector
-
-
-
-encallog returns whether the logging for energy calibration is enabled.
-
-
-angcallog returns whether the logging for angular calibration is enabled.
-
-
-
-
-
-
-
-
-It is normally recommended to use sls\_detector\_acquire [j-], which takes care of everything
-
-acquire Same as sls\_detector\_acquire
-
-data Gets, saves and processes all data stored on the detector, if any.
-
-frame Gets, saves and processes one frame stored on the detector, if any in a Firt-In/First-Out mode.
-
-status Returns the detector status - can be: running, error, transmitting, finished, waiting or idle
-
-online Returns whether the detector is in online or offline mode.
-
-checkonline Returns whether the detector is in online or offline mode.
-
-readctr i fname GOTTHARD related - reads counter in detector to file fname, restarts acquisition if i=1
-
-exptimel Returns the exposure time left for the current frame.
-
-periodl Returns the period left for the current frame.
-
-delayl Returns the delay after trigger left for the current frame.
-
-gatesl Returns the number of gates left for the current frame.
-
-framesl Returns the number of frames left for the current cycle.
-
-cyclesl Returns the number of cycles left for the current acquisition.
-
-now Returns the current timestamp of the detector clock.
-
-timestamp Returns the timestamp of the acquisitions in a First-In/First-Out mode i.e. every time it is called it returns the timestamp of the first acquisition start of readout. The FIFO is reset everytime the acquisition is started.
-
-
-
-
-
-
-Advanced commands to configure the detector system. Should be left to the configuration file
-
-type Returns the types of detector controllers in the system.
-
-hostname Returns the hostnames or IP addresses for the detector
-
-d:extsig:i Returns the usage of the external IO signal i of the controller d.
-
-master Returns the master of the acquisition in a multicontroller detector. -1 is none.
-
-sync Returns the synchronization mode of the various controller within a detector structure.
-
-trimdir Same ad settingsdir.
-
-settingsdir Returns the path of the directory where the trim/settings files are stored.
-
-caldir Returns the path of the directory where the calibration files are stored.
-
-trimen n e1 e2 ...en Unused. Returns the list of energies for which trimfiles exist.
-
-port Returns the port used by the sockets to control the detector.
-
-stopport Returns the port used by the sockets to stop/get the status of the detector.
-
-id[:i] returns the id of the detector structure. i is the detector position in a multi detector system
-
-free Avoid using it. Frees the shared memory.
-
-
-Settable communication parameters:
-
-txndelay_left EIGER advanced: Set transmission delay of sending the left port frame
-
-txndelay_right EIGER advanced: Set transmission delay of sending the right port frame
-
-
-txndelay_frame EIGER advanced: Set transmission delay of sending the entire frame In addition to left and right. This value has to be greater than the maximum of the transmission delays of each port.
-
-
-
-
-
-
-
-detectormac returns the mac of the detector udp interface to mac (if configurable). Should be left to the configuration file.
-
-rx_tcpport returns the communication port between client and receiver. Should be left to the configuration file.
-
-rx_udpport returns the communication port between detector and receiver. Should be left to the configuration file.
-
-rx_hostname returns the hostname (or IP address) of the receiver for the TCP/IP interface with the client.
-
-rx_udpip returns the IP address of the receiver for the UDP interface with the detector.
-
-
-
-r_online b Returns whether the receiver in online (1) or offline (0) mode.
-
-r_checkonline Returns whether the receiver in online (1) or offline (0) mode.
-
-framescaught Returns the number of frames received. Returns: "framescaught n''
-
-resetframescaught n Sets the number of frames received to 1
-
-frameindex Returns the index of the last frame received.
-
-r_lock Returns whether the receiver is locked (1) or unlocked (0).
-
-r_lastclient Returns the IP of the last client which connected to the receiver.
-
-
-
-
-
-
-Some advanced commands to configure data postprocessing.
-
-ffdir Returns the directory where the flat field files are stored.
-
-darkimage fname GOTTHARD- ADVANCED- Returns the dark image file for the detector.
-
-gainimage fname GOTTHARD- ADVANCED- Returns gain image file for the detector.
-
-badchannels fname Returns bad channel file to fname.
-
-threaded b Returns whether the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
-
-
-
-
-Angular conversion
-
-
-
-globaloff Returns the offset of the beamline i.e. angular position of channel 0 when angular encoder at 0.
-
-angconv Returns the file used for the coefficients for angular conversion.
-
-binsize Returns the size of the angular bins for angular conversion.
-
-angdir Returns the angular direction of the detector (1 means channel number in the same direction as the angular encoder, -1 different direction).
-
-d:moveflag Related to a single controller d. Returns 1 if the detector modules move with the angular encoder, 0 if they are static (useful for multidetector systems).
-
-
-
-
-
-
-Advanced settings changing the analog or digital performance of the acquisition. Use them only if you are sure of what you are doing!
-
-
-
-vthreshold Returns the DAC value of the detector threshold to n.
-
-vcalibration Returns the DAC value of the calibration pulse amplitude to n.
-
-vtrimbit Returns the DAC value defining the trimbits LSB size to n.
-
-vpreamp Returns the DAC value of the preamp feedback to n.
-
-vshaper1 Returns the DAC value of the shaper1 feedback to n.
-
-vshaper2 Returns the DAC value of the shaper2 feedback to n.
-
-vhighvoltage Returns the DAC value of the high voltage to n.
-
-vapower CHIPTEST BOARD ONLY - Returns the DAC value of the analog voltage to n.
-
-vddpower CHIPTEST BOARD ONLY - Returns the DAC value of the analog voltage to n.
-
-vshpower CHIPTEST BOARD ONLY - Returns the comparator power supply in dac units (0-1024).
-
-viopower CHIPTEST BOARD ONLY - Returns the FPGA I/O power supply in dac units (0-1024).
-
-vref_ds Returns vrefds
-
-vcascn_pb Returns vcascn_pb
-
-vcascp_pb Returns vcascp_pb
-
-vout_cm Returns vout_cm
-
-vcasc_out Returns vcasc_out
-
-vin_cm Returns vin_cm
-
-vref_comp Returns vref_comp
-
-ib_test_c Returns ib_test_c
-
-vsvp Returns vsvp
-
-vsvn Returns vsvn
-
-vtr Returns vtr trim strength (EIGER)
-
-vrf Returns vrf preamp gain (EIGER)
-
-vrs Returns vrs shaper gain (EIGER)
-
-vtgstv Returns vtgstv (EIGER)
-
-vcmp_ll Returns vcmp_ll (EIGER) leftmost chip theshold
-
-vcmp_lr Returns vcmp_lr (EIGER) second to leftmost chip theshold
-
-vcmp_rl Returns vcmp_rl (EIGER) second to rightmost chip theshold
-
-vcmp_rr Returns vcmp_rr (EIGER) rightmost chip theshold
-
-vcall Returns vcall calibration stength (EIGER)
-
-rxb_rb Returns rxb_rb rightmost chip value to decode 0-1 in the readout
-
-rxb_lb Returns rxb_lb leftmost chip value to decode 0-1 in the readout
-
-vcp Returns vcp cascode p value (EIGER)
-
-vcn Returns vcn cascode n value (EIGER)
-
-vis Returns vis shaper current (EIGER)
-
-iodelay Returns iodelay
-
-temp_adc Returns the temperature of the ADCs
-
-temp_fpga Returns the temperature of the FPGA.
-
-temp_fpgaext Returns the temperature close to the fpga (EIGER).
-
-temp_10ge Returns the temperature close to the 10GE (EIGER).
-
-temp_dcdc Returns the temperature close to the dc dc converter (EIGER).
-
-temp_sodl Returns the temperature close to the left so-dimm memory (EIGER).
-
-temp_sodr Returns the temperature close to the right so-dimm memory (EIGER).
-
-temp_fpgafl Returns the temperature of the left front end board fpga (EIGER).
-
-temp_fpgafr Returns the temperature of the right front end board fpga (EIGER).
-
-
-
-reg a Write to register of address a the data d
-
-clkdivider Returns the clock divider for the readout.
-
-setlength Returns the length of the set/reset signals in the acquisition.
-
-waitstates Returns the wait states for CPU/FPGA communication.
-
-totdivider Returns the tot clock divider.
-
-totdutycycle Returns the tot duty cycle.
-
-setup Dumps all settings to file (config, parameters, trimbits etc.).
-
-trimbits fn Dumps the trimbits to the file files fn.snxxx
-
-
-
-
-
-
-
-
-
-
- Next: Usage
- Up: SLS Detector text clients
- Previous: Detector setup
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/node5.html b/manual/docs/html/slsDetectorClientHowTo/node5.html
deleted file mode 100644
index f6a10d6ff..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/node5.html
+++ /dev/null
@@ -1,166 +0,0 @@
-
-
-
-
-
-Usage
-
-
-
-
-
-
- Next: About this document ...
- Up: SLS Detector text clients
- Previous: Retrieving detector parameters
-Subsections
-
-
-First, your detector should always be configured for each PC that you might want to use for controlling the detector.
-To do that:
-
-sls_detector_put config mydetector.config
-
-Refer to sample configuration files to produce the appropriate one for your detector.
-
-
-One can configure all the detector settings in a parameter file setup.det , which is loaded by doing:
-
-sls_detector_put parameters setup.det
-
-
-
-In the case of EIGER, the parameter file (setup.det needs to setup the proper bias voltage of the sensor, i.e. needs to contain the line vhighvoltage 150 .
-
-
-
-
-
-
-You will then need to setup the detector threshold and settings, the exposure time, the number of real time frames and eventually how many real time frames should be acquired:
-
-sls_detector_put settings standard
-sls_detector_put threshold 6000
-sls_detector_put exptime 1.
-sls_detector_put frames 10
-
-In this case 10 consecutive 1s frames will be acquired.
-
-
-You need to setup where the files will be written to
-
-sls_detector_put outdir /scratch
-sls_detector_put fname run
-sls_detector_put index 0
-
-this way your files will all be named /scratch/run_fj_i.dat where j goes between 0 and 9 and is relative to the frame number, i starts from 0 and is automatically incremented. The next acquisition it will be 1.
-
-
-To acquire simply type
-
-sls_detector_acquire
-
-
-
-You can poll the detector status using
-
-sls_detector_get status
-
-
-
-
-
-Flat field and rate corrections can be applied directly by simply selecting:
-
-sls_detector_put flatield myflatfield.raw
-sls_detector_put ratecorr -1
-
-
-
-
-
-
-
-
-
- Next: About this document ...
- Up: SLS Detector text clients
- Previous: Retrieving detector parameters
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/node6.html b/manual/docs/html/slsDetectorClientHowTo/node6.html
deleted file mode 100644
index 9dd8d116d..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/node6.html
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-
-
-
-About this document ...
-
-
-
-
- Up: SLS Detector text clients
- Previous: Usage
-SLS Detector text clients manual
-This document was generated using the
-LaTeX 2HTML
-Copyright © 1993, 1994, 1995, 1996,
-Nikos Drakos ,
-Computer Based Learning Unit, University of Leeds.
-Ross Moore ,
-Mathematics Department, Macquarie University, Sydney.
-
-The command line arguments were: latex2html -split 4 slsDetectorClientHowTo.tex
-
-The translation was initiated by Thattil Dhanya on 2017-08-24
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorClientHowTo/slsDetectorClientHowTo.css b/manual/docs/html/slsDetectorClientHowTo/slsDetectorClientHowTo.css
deleted file mode 100644
index d1824aff4..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/slsDetectorClientHowTo.css
+++ /dev/null
@@ -1,30 +0,0 @@
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
diff --git a/manual/docs/html/slsDetectorClientHowTo/slsDetectorClientHowTo.html b/manual/docs/html/slsDetectorClientHowTo/slsDetectorClientHowTo.html
deleted file mode 100644
index 0e7edcad0..000000000
--- a/manual/docs/html/slsDetectorClientHowTo/slsDetectorClientHowTo.html
+++ /dev/null
@@ -1,154 +0,0 @@
-
-
-
-
-
-SLS Detector text clients manual
-
-
- Next: Introduction
-
-
-
SLS Detector text clients manual
-
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/WARNINGS b/manual/docs/html/slsDetectorGuiHowTo/WARNINGS
deleted file mode 100644
index a6999a3cf..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/WARNINGS
+++ /dev/null
@@ -1,3 +0,0 @@
-No implementation found for style `graphicx'
-
-There is no author for this document.
diff --git a/manual/docs/html/slsDetectorGuiHowTo/index.html b/manual/docs/html/slsDetectorGuiHowTo/index.html
deleted file mode 100644
index 5532c393c..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/index.html
+++ /dev/null
@@ -1,119 +0,0 @@
-
-
-
-
-
-Mythen v3.0 manual
-
-
- Next: Installation and upgrades
-
-
-
Mythen v3.0 manual
-
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/internals.pl b/manual/docs/html/slsDetectorGuiHowTo/internals.pl
deleted file mode 100644
index 5007897ff..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/internals.pl
+++ /dev/null
@@ -1,14 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate internals original text with physical files.
-
-
-$key = q/sec:trimdir/;
-$ref_files{$key} = "$dir".q|node7.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/sec:encal/;
-$ref_files{$key} = "$dir".q|node16.html|;
-$noresave{$key} = "$nosave";
-
-1;
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/labels.pl b/manual/docs/html/slsDetectorGuiHowTo/labels.pl
deleted file mode 100644
index 02a07de78..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/labels.pl
+++ /dev/null
@@ -1,25 +0,0 @@
-# LaTeX2HTML 2008 (1.71)
-# Associate labels original text with physical files.
-
-
-$key = q/sec:trimdir/;
-$external_labels{$key} = "$URL/" . q|node7.html|;
-$noresave{$key} = "$nosave";
-
-$key = q/sec:encal/;
-$external_labels{$key} = "$URL/" . q|node16.html|;
-$noresave{$key} = "$nosave";
-
-1;
-
-
-# LaTeX2HTML 2008 (1.71)
-# labels from external_latex_labels array.
-
-
-$key = q/sec:trimdir/;
-$external_latex_labels{$key} = q|1.6|;
-$noresave{$key} = "$nosave";
-
-1;
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node1.html b/manual/docs/html/slsDetectorGuiHowTo/node1.html
deleted file mode 100644
index a5284bb6e..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node1.html
+++ /dev/null
@@ -1,88 +0,0 @@
-
-
-
-
-
-Installation and upgrades
-
-
-
-
-
-
- Next: The software package
- Up: Mythen v3.0 manual
- Previous: Mythen v3.0 manual
-
-The new MYTHEN software is intended to control the MCS mythen boards either by using a command line interface (text client) or by using with a graphical user interface (GUI).
-
-
-Here you can find in brief the main things you need to know in order to start working with your detector.
-
-
-
Subsections
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node10.html b/manual/docs/html/slsDetectorGuiHowTo/node10.html
deleted file mode 100644
index 0ec6c5772..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node10.html
+++ /dev/null
@@ -1,67 +0,0 @@
-
-
-
-
-
-Acquisition
-
-
-
-
-
-
- Next: Detector setup
- Up: slsDetectorClient
- Previous: Introduction
-
-the detector is started and the data are acquired, postprocessed and written to file according to the configuration
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node11.html b/manual/docs/html/slsDetectorGuiHowTo/node11.html
deleted file mode 100644
index 169f8e560..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node11.html
+++ /dev/null
@@ -1,269 +0,0 @@
-
-
-
-
-
-Detector setup
-
-
-
-
-
-
- Next: Retrieving detector parameters (plus
- Up: slsDetectorClient
- Previous: Acquisition
-
-mythen_put [id[:/-]]var arg
-
-
-is used to configure the detector parameter var
- e.g. mythen_put 0:exptime 1 sets the exposure time to 1 s
-
-
-
-help i get help
-
-config fname reads the configuration file specified and sets the values
-
-parameters fname sets the detector parameters specified in the file
-
-setup rootname reads the files specfied (and that could be created by get setup) and resets the complete detector configuration including flatfield corrections, badchannels, trimbits etc.
-
-hostname name this is mandatory!!!! sets hostname (or IP adress)
-
-online b b can be 0 or 1 and sets the detector in offline/online state. Must be used to restore communication if some socket called failed because the detector was not connected.
-
-status s either start or stop
-
-caldir path Sets path of the calibration files
-
-trimdir path Sets path of the trim files
-
-outdir path directory to which the files will be written by default
-
-fname name filename to which the files will be written by default (to which file and position indexes will eventually be attached)
-
-index i start index of the files (automatically incremented by the acquisition functions)
-
-nmod n Sets number of detector modules
-
-extsig:i mode Sets usage of the external digital signal i. mode can be: off, gate_in_active_high, gate_in_active_low, trigger_in_rising_edge, trigger_in_falling_edge, ro_trigger_in_rising_edge, ro_trigger_in_falling_edge, gate_out_active_high, gate_out_active_low, trigger_out_rising_edge, trigger_out_falling_edge, ro_trigger_out_rising_edge, ro_trigger_out_falling_edge
-
-timing Sets the timing mode of the detector. Can be auto, gating (works only if at least one of the signals is configured as gate_in), trigger (works only if at least one of the signals is configured as trigger_in), ro_trigger (works only if at least one of the signals is configured as ro_trigger_in), triggered_gating (works only if one ofthe signals is configured as gate_in and one as trigger_in).
-
-settings sett Sets detector settings. Can be: standard fast highgain (depending on trheshold energy and maximum count rate: please refere to manual for limit values!);
-
-threshold ev Sets detector threshold in eV. Should be half of the beam energy. It is precise only if the detector is calibrated
-
-vthreshold dac Sets detector threshold in DAC units. A very rough calibration is dac=800-10*keV
-
-exptime t Sets the exposure time per frame (in s)
-
-period t Sets the frames period (in s)
-
-delay t Sets the delay after trigger (in s)
-
-gates n Sets the number of gates per frame
-
-frames n Sets the number of frames per cycle (e.g. after each trigger)
-
-cycles n Sets the number of cycles (e.g. number of triggers)
-
-probes n Sets the number of probes to accumulate (max 3)
-
-dr n Sets the dynamic range - can be (1,) 4, 8,16 or 24 bits
-
-flags mode Sets the readout flags - can be none or storeinram
-
-flatfield fname Sets the flatfield file name - none disable flat field corrections
-
-ratecorr t Sets the rate corrections with dead time t ns (0 unsets, -1 uses default dead time for chosen settings
-
-badchannels fname Sets the badchannels file name - none disable bad channels corrections
-
-angconv fname Sets the angular conversion file name
-
-globaloff o sets the fixed angular offset of your encoder - should be almost constant!
-
-fineoff o sets a possible angular offset of your setup - should be small but can be senseful to modify
-
-binsize s sets the binning size of the angular conversion (otherwise defaults from the angualr conversion constants)
-
-angdir i sets the angular direction of the detector (i can be 1 or -1 - by default 1, channel 0 is smaller angle)
-
-positions np (pos0 pos1...posnp) Sets the number of positions at which the detector is moved during the acquisition and their values
-
-startscript script sets a script to be executed at the beginning of the measurements (e.g. open shutter). none unsets. Parameters will be parsed as script nrun=i par=spar where i is the run number and spar is the value of startscriptpar.
-
-stopscript script sets a script to be executed at the end of the measurement (e.g. close shutter). none unsets. Parameters will be parsed as script nrun=i par=spar where i is the run number and spar is the value of stopscriptpar.
-
-startscriptpar spar sets a parameter passed to the start script as string with the syntax par=spar. Its meaning must be interpreted inside the script!
-
-stopscriptpar spar sets a parameter passed to the start script as string with the syntax par=spar. Its meaning must be interpreted inside the script!
-
-scan0script script Sets a scan script to be executed at higher level. Script can be none (unset), threshold (change threshold DAC values for all modules), energy (change energy threshold DAC values using calibration for each module), trimbits (change trimbits for all channels) or any script (e.g changing temperature or moving sample) which will be called with the syntax script nrun=i fn=fname var=val par=spar where i is the file index, fname is the file name val is the current value of the scan variable and spar is the value of the scan parameter
-
-scan1script script Sets a scan script to be executed at lower level. Script can be none (unset), threshold (change threshold DAC values for all modules), energy (change energy threshold DAC values using calibration for each module), trimbits (change trimbits for all channels) or any script (e.g changing temperature or moving sample) which will be called with the syntax script nrun=i fn=fname var=val par=spar where i is the file index, fname is the file name val is the current value of the scan variable and spar is the value of the scan parameter
-
-scan0par spar sets the scan parameter to be passed to scan0script as a string with syntax par=spar. Its meaning has to be interpreted insode the script!
-
-scan1par spar sets the scan parameter to be passed to scan1script as a string with syntax par=spar. Its meaning has to be interpreted insode the script!
-
-scan0prec i sets the precision of the scan variable in order to properly generate the file names for scan0
-
-scan1prec i sets the precision of the scan variable in order to properly generate the file names for scan1
-
-scan0steps n (f0 f1..fn) sets the steps for the scan0script. n is the number of steps and the following values are the step values.
-
-scan1steps n (f0 f1..fn) sets the steps for the scan1script. n is the number of steps and the following values are the step values.
-
-scan0range mi ma st generates the steps for the scan0script in the range mi to ma with step st (is mi smaller than ma specify a negative step)
-
-scan1range mi ma st generates the steps for the scan1script in the range mi to ma with step st (is mi smaller than ma specify a negative step)
-
-scriptbefore script sets the script to be executed before each acquisition (before all positions) with the syntax script nrun=i fn=fname par=spar sv0=svar0 sv1=svar1 p0=spar0 p1=spar1 where i is the file index, fname is the file name, sva0, svar1 are the current values of the scan variables 0 and 1, spar0, spar1 are tthe scan parameter 0 and 1. none unsets.
-
-scriptafter script sets the script to be executed after each acquisition (after all positions) with the syntax script nrun=i fn=fname par=spar sv0=svar0 sv1=svar1 p0=spar0 p1=spar1 where i is the file index, fname is the file name, sva0, svar1 are the current values of the scan variables 0 and 1, spar0, spar1 are tthe scan parameter 0 and 1. none unsets.
-
-scriptbeforepar spar sets the parameter to be passed to the script before witht he syntax par=spar
-
-scriptafterpar spar sets the parameter to be passed to the script after witht he syntax par=spar
-
-headerbefore script sets the script to be executed before each acquisition (after moving the detector) with the syntax script nrun=i fn=fname par=spar where i is the run number, fname is the file name, spar is the header before parameter. The script is normally used to save a file header. none unsets.
-
-headerafter script sets the script to be executed after each acquisition (after each position) with the syntax script nrun=i fn=fname par=spar where i is the run number, fname is the file name, spar is the header after parameter. The script is normally used to complete the file header. none unsets.
-
-headerbeforepar spar sets the parameter to be passed to the header before script with the syntax par=spar
-
-headerafterpar spar sets the parameter to be passed to the header after script with the syntax par=spar
-
-
-
-
-
-
-
-
-
-
- Next: Retrieving detector parameters (plus
- Up: slsDetectorClient
- Previous: Acquisition
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node12.html b/manual/docs/html/slsDetectorGuiHowTo/node12.html
deleted file mode 100644
index cf6956449..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node12.html
+++ /dev/null
@@ -1,300 +0,0 @@
-
-
-
-
-
-Retrieving detector parameters (plus trimming and test modalities)
-
-
-
-
-
-
- Next: Tips
- Up: slsDetectorClient
- Previous: Detector setup
-
-is used to retrieve the detector parameter var
- e.g. mythen_get 0:exptime returns the exposure time in seconds
-
-
-
-help This help
-
-config fname writes the configuration file
-
-parameters fname writes the main detector parameters for the measuremen tin the file
-
-setup rootname writes the complete detector setup (including configuration, trimbits, flat field coefficients, badchannels etc.) is a set of files for which the extension is automatically generated
-
-online return whether the detector is in online (1) or offline (0) state.
-
-status gets the detector status - can be: running, error, transmitting, finished, waiting or idle
-
-data gets all data from the detector (if any) processes them and writes them to file according to the preferences already setup
-
-frame gets a single frame from the detector (if any) processes it and writes it to file according to the preferences already setup
-
-hostname Gets the detector hostname (or IP address)
-
-caldir Gets path of the calibration files
-
-trimdir Gets path of the trim files
-
-outdir directory to which the files will be written by default
-
-fname filename to which the files will be written by default (to which file and position indexes will eventually be attached)
-
-index start index of the files (automatically incremented by the acquisition functions)
-
-nmod Gets number of detector modules
-
-maxmod Gets maximum number of detector modules
-
-extsig:i Gets usage of the external digital signal i. The return value can be: off, gate_in_active_high, gate_in_active_low, trigger_in_rising_edge, trigger_in_falling_edge, ro_trigger_in_rising_edge, ro_trigger_in_falling_edge, gate_out_active_high, gate_out_active_low, trigger_out_rising_edge, trigger_out_falling_edge, ro_trigger_out_rising_edge, ro_trigger_out_falling_edge
-
-timing Sets the timing mode of the detector. Can be auto, gating (works only if at least one of the signals is configured as gate_in), trigger (works only if at least one of the signals is configured as trigger_in), ro_trigger (works only if at least one of the signals is configured as ro_trigger_in), triggered_gating (works only if one ofthe signals is configured as gate_in and one as trigger_in).
-
-modulenumber Gets the module serial number
-
-moduleversion Gets the module version
-
-detectornumber Gets the detector number (MAC address)
-
-detectorversion Gets the detector firmware version
-
-softwareversion Gets the detector software version
-
-digitest:i Makes a digital test of the detector module i. Returns 0 if it succeeds
-
-bustest Makes a test of the detector bus. Returns 0 if it succeeds
-
-settings Gets detector settings. Can be: standard fast highgain undefined
-
-threshold Gets detector threshold in eV. It is precise only if the detector is calibrated
-
-vthreshold Gets detector threshold in DAC units. A very rough calibration is dac=800-10*keV
-
-exptime Gets the exposure time per frame (in s)
-
-period Gets the frames period (in s)
-
-delay Gets the delay after trigger (in s)
-
-gates Gets the number of gates per frame
-
-frames Gets the number of frames per cycle (e.g. after each trigger)
-
-cycles Gets the number of cycles (e.g. number of triggers)
-
-probes Gets the number of probes to accumulate (max 3)
-
-timestamp Gets the internal time stamp of the nex frame acquired (i.e. during an acquisition, all timestamps of the frames are stored in a FIFO which can be read after the acquisition - returns -1 if the FIFO is empty)
-
-dr Gets the dynamic range
-
-trim:mode fname Trims the detector and writes the trimfile fname.snxxx. mode can be: noise beam improve fix offline - Check that the start conditions are OK!!!
-
-flatfield fname returns whether the flat field corrections are enabled and if so writes the coefficients to the specified filename. If fname is none it is not written
-
-ratecorr returns wether the rate corrections are enabled and what is the dead time used in ns
-
-badchannels fname returns wether the bad channels corrections are enabled and if so writes the bad channels to the specified filename. If fname is none it is not written
-
-angconv fname returns wether the angular conversion is enabled and if so writes the angular conversion coefficients to the specified filename. If fname is none, it is not written
-
-globaloff returns the fixed angular offset of your encoder - should be almost constant!
-
-fineoff returns a possible angualr offset of your setup - should be small but can be senseful to modify
-
-binsize returns the binning size of the angular conversion
-
-angdir gets the angular direction of the detector (can be 1 or -1 - by default 1, channel 0 is smaller angle)
-
-positions returns the number of positions at which the detector is moved during the acquisition and their values
-
-startscript script sets a script to be executed at the beginning of the measurements (e.g. open shutter). none unsets. Parameters will be parsed as script nrun=i par=spar where i is the run number and spar is the value of startscriptpar.
-
-stopscript returns the script to be executed at the end of the measurement (e.g. close shutter). none unsets. Parameters will be parsed as script nrun=i par=spar where i is the run number and spar is the value of stopscriptpar.
-
-startscriptpar returns the parameter passed to the start script as string with the syntax par=spar. Its meaning must be interpreted inside the script!
-
-stopscriptpar returns the parameter passed to the start script as string with the syntax par=spar. Its meaning must be interpreted inside the script!
-
-scan0script returns the scan script to be executed at higher level. Script can be none (unset), threshold (change threshold DAC values for all modules), energy (change energy threshold DAC values using calibration for each module), trimbits (change trimbits for all channels) or any script (e.g changing temperature or moving sample) which will be called with the syntax script nrun=i fn=fname var=val par=spar where i is the file index, fname is the file name val is the current value of the scan variable and spar is the value of the scan parameter
-
-scan1script returns the scan script to be executed at lower level. Script can be none (unset), threshold (change threshold DAC values for all modules), energy (change energy threshold DAC values using calibration for each module), trimbits (change trimbits for all channels) or any script (e.g changing temperature or moving sample) which will be called with the syntax script nrun=i fn=fname var=val par=spar where i is the file index, fname is the file name val is the current value of the scan variable and spar is the value of the scan parameter
-
-scan0par returns the scan parameter to be passed to scan0script as a string with syntax par=spar. Its meaning has to be interpreted insode the script!
-
-scan1par returns the scan parameter to be passed to scan1script as a string with syntax par=spar. Its meaning has to be interpreted insode the script!
-
-scan0prec returns the precision of the scan variable in order to properly generate the file names for scan0
-
-scan1prec returns the precision of the scan variable in order to properly generate the file names for scan1
-
-scan0steps returns the steps for the scan0script. n is the number of steps and the following values are the step values.
-
-scan1steps returns the steps for the scan1script. n is the number of steps and the following values are the step values.
-
-scan0range returns the steps for the scan0script. n is the number of steps and the following values are the step values.
-
-scan1range returns the steps for the scan1script. n is the number of steps and the following values are the step values.
-
-scriptbefore returns the script to be executed before each acquisition (before all positions) with the syntax script nrun=i fn=fname par=spar sv0=svar0 sv1=svar1 p0=spar0 p1=spar1 where i is the file index, fname is the file name, sva0, svar1 are the current values of the scan variables 0 and 1, spar0, spar1 are tthe scan parameter 0 and 1.
-
-scriptafter returns the script to be executed after each acquisition (after all positions) with the syntax script nrun=i fn=fname par=spar sv0=svar0 sv1=svar1 p0=spar0 p1=spar1 where i is the file index, fname is the file name, sva0, svar1 are the current values of the scan variables 0 and 1, spar0, spar1 are tthe scan parameter 0 and 1.
-
-scriptbeforepar returns the parameter to be passed to the script before witht he syntax par=spar
-
-scriptafterpar returns the parameter to be passed to the script after witht he syntax par=spar
-
-headerbefore returns the script to be executed before each acquisition (after moving the detector) with the syntax script nrun=i fn=fname par=spar where i is the run number, fname is the file name, spar is the header before parameter. The script is normally used to save a file header.
-
-headerafter returns the script to be executed after each acquisition (after each position) with the syntax script nrun=i fn=fname par=spar where i is the run number, fname is the file name, spar is the header after parameter. The script is normally used to complete the file header.
-
-headerbeforepar returns the parameter to be passed to the header before script with the syntax par=spar
-
-headerafterpar returns the parameter to be passed to the header after script with the syntax par=spar
-
-
-
-
-
-
-
-
-
-
- Next: Tips
- Up: slsDetectorClient
- Previous: Detector setup
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node13.html b/manual/docs/html/slsDetectorGuiHowTo/node13.html
deleted file mode 100644
index 3c66f80b0..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node13.html
+++ /dev/null
@@ -1,222 +0,0 @@
-
-
-
-
-
-Tips
-
-
-
-
-
-
- Next: Acquisition
- Up: slsDetectorClient
- Previous: Retrieving detector parameters (plus
-Subsections
-
-
-First of all you should setup the hostname and the detector size and dynamic range:
-
-mythen_put hostname mcs1x00
-mythen_get nmod
-mythen_get dr
-
-You should also tell the program where to find the default trimbits files and calibration files:
-
-mythen_put trimdir /scratch/trimbits
-mythen_get caldir /scratch/calibration
-
-To chose the detector settings (e.g. standard):
-
-mythen_put settings standard
-
-In case mythen_get settings does not answer correctly, it most probably means that there is a problem in the architecture or setting of trimdir and caldir (see section 1.6 ).
-
-
-
-
-You need to setup where the files will be written to
-
-mythen_put outdir /scratch
-mythen_put fname run
-mythen_put index 0
-
-this way your files will al be named /scracth/run_i.dat where is starts from 0 and is automatically incremented.
-
-
-You will then need to setup the detector threshold and settings, the exposure time, the number of real time frames and eventually how many real time frames should be acquired:
-
-mythen_put settings standard
-mythen_put threshold 6000
-mythen_put exptime 1.
-mythen_put frames 10
-
-In this case 10 consecutive 1s frames will be acquired.
-External gating and triggering or more advanced acquisition modes are not explained here.
-
-
-
-
-There are two ways of acquiring data.
-
-mythen_acquire 0
-
-This is particulary indicated for fast real time acquisitions.
-
-
-If you want to acquire few long frames you can run:
-
-mythen_put status start
-
-and the poll the detector status using
-
-mythen_get status
-
-if the answer is either transmitting or finished, the data are ready to be downloaded from the detector.
-This can be done using either:
-
-mythen_get frame
-
-where a single data frame is downloaded or
-
-mythen_get data
-
-where all data present on the detector are downloaded.
-This is not indicated when many short real time frames should be acquired since the detector memory would be full before finishing the acquisition since the download time is so limited.
-
-
-
-
-Flat field and rate corrections can be applied direcly by simply selecting:
-
-mythen_put flatield myflatfield.raw
-mythen_put ratecorr -1
-
-
-
-Concerning the angular conversion, it is very reccomended that the users edit the file usersFunctions.cpp contained in the folder slsDetectorSoftware/usersFunctions.
-In the file it is possible to modify the function used for calculating the angular conversion and the ones used for interfacing with the diffractometer equipment i.e. reading the encoder fo the detector position, the ionization chanmbers etc.
-
-
-It is also possible to configure some scans/scripts to be executed during the acquisition. They will be normally called as system calls except for threshold, energy and trimbits scans.
-
-
-Possible arguments are:
-
-help This help
-
--f myconf.txt loads the configuration file to myconf.txt
-
--id i Sets the detector to id i (the default is i). Useful when more than one detector are operated in parallel.
-
--offline works in offline mode i.e. not connecting to the detector. Usefule e.g. to perform the energy calibration of the detector and possibly in the future to reprocess and visualize the data (not yet implemented).
-
--size n sets the size of the text to n (the default is n=10);
-
--scale s scales the size of the text and the root canvas by the scaling factor s (the default is s=1). It is useful when executing the program on a PC with low screen resolution (e.g. a laptop) and the window would then fall out of the screen.");
-
-
-The configuration of the detector can either be set when startin the GUI using the configuration file or using the text client or even using the configuration tab of the GUI.
-
-
-
-
-
-
-
-
- Next: Acquisition
- Up: slsDetectorClient
- Previous: Retrieving detector parameters (plus
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node14.html b/manual/docs/html/slsDetectorGuiHowTo/node14.html
deleted file mode 100644
index da7789424..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node14.html
+++ /dev/null
@@ -1,70 +0,0 @@
-
-
-
-
-
-Acquisition
-
-
-
-
-
-
- Next: Other functions
- Up: slsDetectorClient
- Previous: Tips
-
-The stop button stops the acquisition i.e. if there are data left to be saved processed etc. the program will not really stop until the offline processes are done.
-
-
-Please don't be too nervous clicking on start and/or stop since this is one of the main causes of crashes (the program has been teste only for quiet users :-)).
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node15.html b/manual/docs/html/slsDetectorGuiHowTo/node15.html
deleted file mode 100644
index e373bc1b9..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node15.html
+++ /dev/null
@@ -1,187 +0,0 @@
-
-
-
-
-
-Other functions
-
-
-
-
-
-
- Next: Energy calibration
- Up: slsDetectorClient
- Previous: Acquisition
-Subsections
-The main parameters are group in tabs according to their meaning. To enable some tabs you should enter the modes menu and select Advanced/configuration/Debug
-Here is the general subject of the tabs:
-
-Measurement Main acquisition parameters that you may want to change often
-
-Data Output Where to write the data, in which format and what to to with them
-
-Plot What to plot and how (only partially implemented)
-
-Actions Allows to configure scans and/or execute scripts at teh beginning or at the end of the measurement.
-
-Time resolved Parameters for time resolved (real time) measurements
-
-Advanced Must be activated with the modes menu button. Allows to set some advanced configuration which you don't want general users to change (e.g. data size, external signals, advanced acquisition speed)
-
-Trimming Must be activated with the modes menu button. Allows to trim the detector and/or load specific trim files.
-
-Configuration Must be activated with the modes menu button. Allows to configure the detector
-
-Debugging Must be activated with the modes menu button. Allows to test the detectors functionality, acquire serial numbers etc.
-
-
-Most of the parameters are explained through a tooltip which appers if you leave the mouse on the widget for a few seconds.
-
-
-The configuration and/or the complete setup of the detector can be loaded and saved using the Utilities menu.
-
-
-
-
-Where to find some important parameters (should be set only once, then it should remain in memory):
-
-Hostname Configuration tab. Press enter to update.
-
-Trim dir Configuration tab. Press enter to update.
-
-Cal dir Configuration tab. Press enter to update.
-
-Number of modules Configuration tab or Advanced tab
-
-Dynamic range Advanced tab
-
-Output directory Data Output tab.
-
-File name Measurement tab.
-
-File index Measurement tab (automatically incremented).
-
-
-
-
-
-
-Where to find some important parameters (should be set only once, then it should remain in memory):
-
-Settings Measurement tab
-
-Threshold Measurement tab
-
-Exposure time Measurement tab
-
-Number of frames Measurement tab for non time-resolved measurement, Time resolved tab for fast real time measurements. if you need some action between frame see Actions tab.
-
-
-
-
-
-
-
-
-
-
- Next: Energy calibration
- Up: slsDetectorClient
- Previous: Acquisition
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node16.html b/manual/docs/html/slsDetectorGuiHowTo/node16.html
deleted file mode 100644
index 8df174454..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node16.html
+++ /dev/null
@@ -1,121 +0,0 @@
-
-
-
-
-
-Energy calibration
-
-
-
-
-
-
- Next: About this document ...
- Up: Mythen v3.0 manual
- Previous: Other functions
-
-The data can be acquired either with the mythenGUI (by using the calibration wizard or the threshold scan utility in the Action tab) or with the slsDetectorClient (by scanning the threshold using mythen_put 0:vthreshold), but since the analysis needs the use of root, the GUI must be used to finalize the calibration.
-
-
-In the mythenGUI menu Utilities/Calibration wizard it is possible to simply and automatically perform the energy calibration of the detector:
-
-
-Check the ``Detector online'' box in case you want to acquire the data, otherwise simply unclick it and you will be required to provide already acquired data and the details about the detector.
-
-If the detector is online, the settings, the number of modules and their serial number will automatically be retrieved. If you selected the offline mode, you must provide the detector settings for the calibration that you want to perform and the serial numbers of the modules in the correct order (to do so, enter the 3 hexadecimal digits in the right sequence and press enter for each module - in case of error the list is editable).
-
-Enter the energy of your beam (in keV!);
-
-For the following calibration steps, check the ``Detector online'' box in case you want to acquire the data, otherwise simply unclick it and you will be required to provide already acquired data and the details about the detector.
-
-Add a new calibration step like in point 3. and iterate for all the energies at which you want to perform the calibration.
-
-To generate the calibration files, chose ``Generate calibration files'' and select the file created prevously. The settings, number of modules and serial numbers of the modules and the energies at which the acquisition has been already performed should be displayed.
-
-Chose the directory and the root of the calibrations files name. An extension corresponding to the serial number of the modules will be generated.
-
-The calibration files for each module should be generated. For each energy you can set the start parameters of the fit and the fitting range (press enter after each change) so that the fitted curves nicely fit the data. The linear fit between energies and inflection points can also be checked.
-
-
-
-
-
-
-
-
-
-
- Next: About this document ...
- Up: Mythen v3.0 manual
- Previous: Other functions
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node17.html b/manual/docs/html/slsDetectorGuiHowTo/node17.html
deleted file mode 100644
index 7ad5f9802..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node17.html
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-
-
-
-About this document ...
-
-
-
-
- Up: Mythen v3.0 manual
- Previous: Energy calibration
-Mythen v3.0 manual
-This document was generated using the
-LaTeX 2HTML
-Copyright © 1993, 1994, 1995, 1996,
-Nikos Drakos ,
-Computer Based Learning Unit, University of Leeds.
-Ross Moore ,
-Mathematics Department, Macquarie University, Sydney.
-
-The command line arguments were: latex2html -split 4 slsDetectorGuiHowTo.tex
-
-The translation was initiated by Thattil Dhanya on 2017-08-24
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node2.html b/manual/docs/html/slsDetectorGuiHowTo/node2.html
deleted file mode 100644
index 9b8e95a22..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node2.html
+++ /dev/null
@@ -1,78 +0,0 @@
-
-
-
-
-
-The software package
-
-
-
-
-
-
- Next: Requirements
- Up: Installation and upgrades
- Previous: Installation and upgrades
-
-The actual software for the Mythen II system (MCS1 to MCS24) runs on 32 bit Scientific Linux machines (SLC5 tested, gcc 4.1.2 but it should not be critical).
-
-
-The complete software package is composed of several programs which can be instaleld (or locally compiled) depending on the needs:
-
-
-The slsDetector shared and static libraries which are necessary for all user interfaces and can be simply used for implementig custom detector drivers;
-
-The command line interface (slsDetectorClient) sls_detector_put, sls_detector_get, sls_detector_acquire which is provided to communicate with the detectors;
-
-A virtual server mythenServer which can be used to simulate the behavior of the detector for what concerns the communication in case the detector is not online or is in use.
-
-
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node3.html b/manual/docs/html/slsDetectorGuiHowTo/node3.html
deleted file mode 100644
index cb879e7a2..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node3.html
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
-
-
-
-Requirements
-
-
-
-
-
-
- Next: Compilation
- Up: Installation and upgrades
- Previous: The software package
-
-For installing the slsDetector shared and static libraries and the slsDetectorClient software, any Linux installation with a working gcc should be fine.
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node4.html b/manual/docs/html/slsDetectorGuiHowTo/node4.html
deleted file mode 100644
index 93c16cb64..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node4.html
+++ /dev/null
@@ -1,80 +0,0 @@
-
-
-
-
-
-Compilation
-
-
-
-
-
-
- Next: Building
- Up: Installation and upgrades
- Previous: Requirements
-
-make lib compile slsDetector library
-make slsDetectorClient compile slsDetectorClient package
-make all compile slsDetector libraries, the slsDetectorClient package
-make clean remove object files and executables
-make help lists possible targets
-
-
-
-To be able to run the slsDetectorClient commands, add their location to your path.
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node5.html b/manual/docs/html/slsDetectorGuiHowTo/node5.html
deleted file mode 100644
index d38ba15e1..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node5.html
+++ /dev/null
@@ -1,102 +0,0 @@
-
-
-
-
-
-Building
-
-
-
-
-
-
- Next: Detector upgrade
- Up: Installation and upgrades
- Previous: Compilation
-
-> source configure
-
-(NOT >./configure otherwise the enviroment variables will not be available for the make command).
-This allows you to configure:
-
-
-INSTALLROOT Directory where you want to install the software. Defaults to /usr/local/
-BINDIR Directory where you want to install the binaries. Defaults to bin/
-INCDIR Directory where you want to pute the header files. Defaults to include/slsdetector/
-LIBDIR Directory where you want to install the libraries. Defaults to lib/
-DOCDIR Directory where you want to copy the documentation. Defaults to share/doc/
-
-
-
-To build you can:
-
-
-make install_lib install detector library and include files"
-make install_client install slsDetectorClient
-make install install library, include files and mythenClient''
-make install_libdoc install library documentation
-make install_clientdoc install mythenClient documentation
-make install_doc install all documentation
-make help lists possible targets
-
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node6.html b/manual/docs/html/slsDetectorGuiHowTo/node6.html
deleted file mode 100644
index ead093fbc..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node6.html
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-
-
-
-Detector upgrade
-
-
-
-
-
-
- Next: The trimbits and calibration
- Up: Installation and upgrades
- Previous: Building
-
-The upgrade of the detector consists in both the upgrade of the communication software and of the firmware.
-
-To upgrade the firmware you need either a working version of the Altera Quartus software or of the Quartus programmer, which can easly be downloade from
-https://www.altera.com/download/programming/quartus2/pq2-index.jsp
-C:\altera\80sp1\qprogrammer\drivers\usb-blasterp (where C:\altera\80sp1\qprogrammer\ is assumed to be ther path where your Quartus version is installed).
-
-After starting the Quartus programmer, click on Hardware Setup and in the "Currently selected hardware" window select USB-Blaster.
-
-In the Mode combo box select "Active Serial Programming".
-
-Plug the end of your USB-Blaster WITH THE ADAPTER PROVIDED in the connector ASMI on the MCS board taking care that pin1 corresponds to the one indexed and with the rectangualr pad.
-
-Click on add file and from select the programming file provided when the upgrade has been reccomended.
-
-Check "Program/Configure" and "Verify".
-
-Push the start button and wait until the programming process is finished (progress bar top left).
-
-In case the programmer gives you error messages, check the polarity of your cable (pin1 corresponds) and that you have selected the correct programming connector.
-
-
-
-
-To upgrade the software on the detector board transfer the provided software by ftp to the MCS:
-
-ftp mymcs.mydomain.com
-username: root
-password: pass
-cd /mnt/flash/root
-put mythenDetectorServer
-quit
-
-If the /mnt/flash/root directory does not exist, create it before the transfer by telnetting to the MCS.
-/mnt/etc/inittab ends with the line myid2:3:once:/mnt/flash/root/mythenDetectorServer ).
-chmod a+xrw /mnt/flash/root/mythenDetectorServer
-
-
-
-
-
-
-
- Next: The trimbits and calibration
- Up: Installation and upgrades
- Previous: Building
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node7.html b/manual/docs/html/slsDetectorGuiHowTo/node7.html
deleted file mode 100644
index b8e1cffcc..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node7.html
+++ /dev/null
@@ -1,99 +0,0 @@
-
-
-
-
-
-The trimbits and calibration files
-
-
-
-
-
-
- Next: slsDetectorClient
- Up: Installation and upgrades
- Previous: Detector upgrade
-trimdir and a directory where the calibration files (needed to convert the threshold energy in DAC units) are stored which in the following will be named caldir .
-trimdir and caldir can even be the same directory, and an example of it is given in the software package by the example directory trimbits.
-
-trimdir should contain three subdirectories standard, fast and highgain containing respectively the trimfiles standard.trim, fast.trim and highgain.trim which contain the correct voltage settings for the detector although all the individual channel thresholds set to 0. The original files contained in the package should be used, infact in case of error the detector would not recognize the correct settings.
-noise.snxxx where xxx is the module serial number.
-
-caldir should contain three subdirectories standard, fast and highgain containing respectively the trimfiles standard.cal, fast.cal and highgain.cal which contain an average calibration of the modules for the diffrent settings. However this can different from the correct one for each individual module even of several kev and therefore it is very important to perform an energy calibration on a module basis (see section calibration.snxxx where xxx is the module serial number.
-
-
-
-
-
-
-
-
- Next: slsDetectorClient
- Up: Installation and upgrades
- Previous: Detector upgrade
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node8.html b/manual/docs/html/slsDetectorGuiHowTo/node8.html
deleted file mode 100644
index 62602d5fb..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node8.html
+++ /dev/null
@@ -1,100 +0,0 @@
-
-
-
-
-
-slsDetectorClient
-
-
-
-
-
-
- Next: Introduction
- Up: Mythen v3.0 manual
- Previous: The trimbits and calibration
-
-
Subsections
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/node9.html b/manual/docs/html/slsDetectorGuiHowTo/node9.html
deleted file mode 100644
index df7621dfd..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/node9.html
+++ /dev/null
@@ -1,112 +0,0 @@
-
-
-
-
-
-Introduction
-
-
-
-
-
-
- Next: Acquisition
- Up: slsDetectorClient
- Previous: slsDetectorClient
-
-This program is intended to control the MYTHEN detectors via command line interface.
-
-
-To get all the possibilities of usage simply type:
-
-sls_detector_acquire to readout the detector at full speed
-
-sls_detector_put to set detector parameters
-
-sls_detector_get to retrieve detector parameters
-
-
-
-
-There are different ways for communicationg with your detector(s).
-
-multiDetector
-is represented by a group of controllers which operate symultaneously with the same parameters. You can define several multiDetector systems and int this case you address them using different indexes. In this case the syntax will be sls\_detector\_cmd i- where cmd can be acquire, put, get and i is the index of the multiDetector entity (if omitted defaults to 0 - standard usage). Normally it is handy to use the multiDetector structure also in case of single detectors. However in some cases one cannot avoid using the slsDetector structure for detailed configuration (e.g. meaning of external signals or other flags)
-
-slsDetector
-is represented by a single controller. You can define several multiDetector systems and int this case you address them using different indexes. In this case the syntax will be sls\_detector\_cmd i: where cmd can be acquire, put, get and i is the index of the slsDetector entity, which cannot be omitted. When creating the multiDetector structure, the indexes are automatically assigned to the detectors contained in it. You can retrieve the indexes relative to the slsDetector using: sls\_detector\_get hostname:pos, sls\_detector\_get id:pos whic will return the hostname in position pos of your multiDetector structure (pos=0 in case of single detectors) and its index.
-
-
-
-
-
-
-
-
-
-
- Next: Acquisition
- Up: slsDetectorClient
- Previous: slsDetectorClient
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorGuiHowTo/slsDetectorGuiHowTo.css b/manual/docs/html/slsDetectorGuiHowTo/slsDetectorGuiHowTo.css
deleted file mode 100644
index d1824aff4..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/slsDetectorGuiHowTo.css
+++ /dev/null
@@ -1,30 +0,0 @@
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
diff --git a/manual/docs/html/slsDetectorGuiHowTo/slsDetectorGuiHowTo.html b/manual/docs/html/slsDetectorGuiHowTo/slsDetectorGuiHowTo.html
deleted file mode 100644
index 5532c393c..000000000
--- a/manual/docs/html/slsDetectorGuiHowTo/slsDetectorGuiHowTo.html
+++ /dev/null
@@ -1,119 +0,0 @@
-
-
-
-
-
-Mythen v3.0 manual
-
-
- Next: Installation and upgrades
-
-
-
Mythen v3.0 manual
-
-
-
-
-Thattil Dhanya
-2017-08-24
-
-
-
diff --git a/manual/docs/html/slsDetectorUsersDocs/annotated.html b/manual/docs/html/slsDetectorUsersDocs/annotated.html
deleted file mode 100644
index e6739409e..000000000
--- a/manual/docs/html/slsDetectorUsersDocs/annotated.html
+++ /dev/null
@@ -1,70 +0,0 @@
-
-
-
-
-Class List
-
-
Class List Here are the classes, structs, unions and interfaces with brief descriptions:
- detectorData Data structure to hold the detector data after postprocessing (e.g. to plot, store in a root tree etc.) slsDetectorUsers Class for detector functionalitiesto embed the detector controls in the users custom interface e.g. EPICS, Lima etc slsReceiverUsers Class for implementing the SLS data receiver in the users application. Callbacks can be defined for processing and/or saving data
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Member List
-
-
detectorData Member List This is the complete list of members for
detectorData , including all inherited members.
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 detectorData Class Reference
-
-
detectorData Class Reference
-
data structure to hold the detector data after postprocessing (e.g. to plot, store in a root tree etc.)
-More...
-
-
#include <detectorData.h >
-
-
List of all members.
-
-Public Member Functions detectorData (double *val=NULL, double *err=NULL, double *ang=NULL, double p_ind=-1, const char *fname="", int np=-1, int ny=1) The constructor. ~detectorData () The destructor deletes also the arrays pointing to data/errors/angles if not NULL. Public Attributes double * values pointer to the data double * errors pointer to the errors double * angles pointer to the angles (NULL if no angular conversion) double progressIndex file index char fileName [1000] file name int npoints number of points int npy dimensions in y coordinate
-
Detailed Description
-
data structure to hold the detector data after postprocessing (e.g. to plot, store in a root tree etc.)
-
-
Definition at line 9 of file detectorData.h .
-
Constructor & Destructor Documentation
-
-
-
-
-
- detectorData::detectorData
- (
- double *
- val = NULL,
-
-
- double *
- err = NULL,
-
-
- double *
- ang = NULL,
-
-
- double
- p_ind = -1,
-
-
- const char *
- fname = "",
-
-
- int
- np = -1,
-
-
- int
- ny = 1
-
-
- )
- [inline]
-
-
-
-
-
The constructor.
-
Parameters:
-
- val pointer to the data err pointer to errors ang pointer to the angles f_ind file index fname file name to which the data are saved np number of points in x coordinate defaults to the number of detector channels (1D detector) ny dimension in y (1D detector)
-
-
-
-
Definition at line 20 of file detectorData.h .
-
-
-
-
-
-
-
-
- detectorData::~detectorData
- (
- )
- [inline]
-
-
-
-
-
The destructor deletes also the arrays pointing to data/errors/angles if not NULL.
-
-
Definition at line 27 of file detectorData.h .
-
-
-
-
Member Data Documentation
-
-
-
-
-
-
pointer to the angles (NULL if no angular conversion)
-
-
Definition at line 31 of file detectorData.h .
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dimensions in y coordinate
-
-
Definition at line 35 of file detectorData.h .
-
-
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Alphabetical List
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Member List
-
-
slsDetectorUsers Member List This is the complete list of members for
slsDetectorUsers , including all inherited members.
- addFrame (double *data, double pos, double i0, double t, string fname, double var)slsDetectorUsers [virtual]dumpDetectorSetup (string const fname)slsDetectorUsers enableAngularConversion (int i=-1)slsDetectorUsers enableCountRateCorrection (int i=-1)slsDetectorUsers enableDataStreamingFromReceiver (int i=-1)slsDetectorUsers enableFlatFieldCorrection (int i=-1)slsDetectorUsers enablePixelMaskCorrection (int i=-1)slsDetectorUsers enableWriteToFile (int i=-1)slsDetectorUsers finalizeDataset (double *a, double *v, double *e, int &np)slsDetectorUsers [virtual]getADC (int id, int adcindex)slsDetectorUsers getCommand (int narg, char *args[], int pos=-1)slsDetectorUsers getContinuousReadoutFlag ()slsDetectorUsers getDetectorDeveloper ()slsDetectorUsers getDetectorFirmwareVersion ()slsDetectorUsers getDetectorSerialNumber ()slsDetectorUsers getDetectorSettings (string s)slsDetectorUsers [inline, static]getDetectorSettings (int s)slsDetectorUsers [inline, static]getDetectorSize (int &x0, int &y0, int &nx, int &ny)slsDetectorUsers getDetectorSoftwareVersion ()slsDetectorUsers getDetectorStatus ()slsDetectorUsers getDetectorType ()slsDetectorUsers getFileIndex ()slsDetectorUsers getFileName ()slsDetectorUsers getFilePath ()slsDetectorUsers getFlatFieldCorrectionDir ()slsDetectorUsers getFlatFieldCorrectionFile ()slsDetectorUsers getMaximumDetectorSize (int &nx, int &ny)slsDetectorUsers getModuleFirmwareVersion ()slsDetectorUsers getModuleSerialNumber (int imod=-1)slsDetectorUsers getNonParallelReadoutFlag ()slsDetectorUsers getParallelReadoutFlag ()slsDetectorUsers getPositions (double *pos=NULL)slsDetectorUsers getSafeReadoutFlag ()slsDetectorUsers getStoreInRamReadoutFlag ()slsDetectorUsers getThisSoftwareVersion ()slsDetectorUsers getThresholdEnergy ()slsDetectorUsers getTimingMode (int f)slsDetectorUsers [inline, static]getTimingMode (string s)slsDetectorUsers [inline, static]initDataset (int refresh)slsDetectorUsers [virtual]putCommand (int narg, char *args[], int pos=-1)slsDetectorUsers readConfigurationFile (string const fname)slsDetectorUsers registerAcquisitionFinishedCallback (int(*func)(double, int, void *), void *pArg)slsDetectorUsers registerConnectChannelsCallback (int(*func)(void *), void *arg)slsDetectorUsers registerDataCallback (int(*userCallback)(detectorData *d, int f, int s, void *), void *pArg)slsDetectorUsers registerDisconnectChannelsCallback (int(*func)(void *), void *arg)slsDetectorUsers registerGetI0Callback (double(*func)(int, void *), void *arg)slsDetectorUsers registerGetPositionCallback (double(*func)(void *), void *arg)slsDetectorUsers registerGoToPositionCallback (int(*func)(double, void *), void *arg)slsDetectorUsers registerGoToPositionNoWaitCallback (int(*func)(double, void *), void *arg)slsDetectorUsers registerRawDataCallback (int(*userCallback)(double *p, int n, void *), void *pArg)slsDetectorUsers retrieveDetectorSetup (string const fname)slsDetectorUsers runStatusType (int s)slsDetectorUsers [inline, static]setAllTrimbits (int val)slsDetectorUsers setBitDepth (int i=-1)slsDetectorUsers setClockDivider (int value)slsDetectorUsers setContinuousReadoutFlag ()slsDetectorUsers setDAC (int id, int dacindex, int val)slsDetectorUsers setDelayAfterTrigger (double t=-1, bool inseconds=false)slsDetectorUsers setDetectorSize (int x0=-1, int y0=-1, int nx=-1, int ny=-1)slsDetectorUsers setExposurePeriod (double t=-1, bool inseconds=false)slsDetectorUsers setExposureTime (double t=-1, bool inseconds=false)slsDetectorUsers setFileIndex (int i)slsDetectorUsers setFileName (string s)slsDetectorUsers setFilePath (string s)slsDetectorUsers setFlatFieldCorrectionDir (string dir)slsDetectorUsers setFlatFieldCorrectionFile (string fname="")slsDetectorUsers setNonParallelReadoutFlag ()slsDetectorUsers setNumberOfCycles (int64_t t=-1)slsDetectorUsers setNumberOfFrames (int64_t t=-1)slsDetectorUsers setNumberOfGates (int64_t t=-1)slsDetectorUsers setOnline (int const online=-1)slsDetectorUsers setParallelReadoutFlag ()slsDetectorUsers setPositions (int nPos, double *pos)slsDetectorUsers setReceiverMode (int n=-1)slsDetectorUsers setSafeReadoutFlag ()slsDetectorUsers setSettings (int isettings=-1)slsDetectorUsers setStoreInRamReadoutFlag ()slsDetectorUsers setThresholdEnergy (int e_eV)slsDetectorUsers setTimingMode (int pol=-1)slsDetectorUsers slsDetectorUsers (int id=0)slsDetectorUsers startMeasurement ()slsDetectorUsers stopMeasurement ()slsDetectorUsers ~slsDetectorUsers ()slsDetectorUsers [virtual]
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 slsDetectorUsers Class Reference
-
-
slsDetectorUsers Class Reference
-
Class for detector functionalitiesto embed the detector controls in the users custom interface e.g. EPICS, Lima etc.
-More...
-
-
#include <slsDetectorUsers.h >
-
-
List of all members.
-
-Public Member Functions slsDetectorUsers (int id=0) default constructor virtual ~slsDetectorUsers () virtual destructor string getDetectorDeveloper () useful to define subset of working functions int setOnline (int const online=-1) sets the onlineFlag void startMeasurement () start measurement and acquires int stopMeasurement () stop measurement int getDetectorStatus () get run status string getFilePath () returns the default output files path string setFilePath (string s) sets the default output files path string getFileName ()string setFileName (string s) sets the default output files path int getFileIndex ()int setFileIndex (int i) sets the default output file index string getFlatFieldCorrectionDir () get flat field corrections file directory string setFlatFieldCorrectionDir (string dir) set flat field corrections file directory string getFlatFieldCorrectionFile () get flat field corrections file name int setFlatFieldCorrectionFile (string fname="") set flat field correction file int enableFlatFieldCorrection (int i=-1) enable/disable flat field corrections (without changing file name) int enableCountRateCorrection (int i=-1) enable/disable count rate corrections int enablePixelMaskCorrection (int i=-1) enable/disable bad channel corrections int enableAngularConversion (int i=-1) enable/disable angular conversion int enableWriteToFile (int i=-1)int setPositions (int nPos, double *pos) set positions for the acquisition int getPositions (double *pos=NULL) get positions for the acquisition int setDetectorSize (int x0=-1, int y0=-1, int nx=-1, int ny=-1) sets the detector size int getDetectorSize (int &x0, int &y0, int &nx, int &ny) gets detector size int getMaximumDetectorSize (int &nx, int &ny) setsthe maximum detector size int setBitDepth (int i=-1) set/get dynamic range int setSettings (int isettings=-1) set detector settings int getThresholdEnergy () get threshold energy int setThresholdEnergy (int e_eV) set threshold energy double setExposureTime (double t=-1, bool inseconds=false) set/get exposure time value double setExposurePeriod (double t=-1, bool inseconds=false) set/get exposure period double setDelayAfterTrigger (double t=-1, bool inseconds=false) set/get delay after trigger int64_t setNumberOfGates (int64_t t=-1) set/get number of gates int64_t setNumberOfFrames (int64_t t=-1) set/get number of frames i.e. number of exposure per trigger int64_t setNumberOfCycles (int64_t t=-1) set/get number of cycles i.e. number of triggers int setTimingMode (int pol=-1) set/get the external communication mode int readConfigurationFile (string const fname) Reads the configuration file -- will contain all the informations needed for the configuration (e.g. for a PSI detector caldir, settingsdir, angconv, badchannels, hostname etc.). int dumpDetectorSetup (string const fname) Reads the parameters from the detector and writes them to file. int retrieveDetectorSetup (string const fname) Loads the detector setup from file. string getDetectorType () useful for data plotting etc. int setReceiverMode (int n=-1) sets the mode by which gui requests data from receiver void registerDataCallback (int(*userCallback)(detectorData *d, int f, int s, void *), void *pArg) register calbback for accessing detector final data void registerRawDataCallback (int(*userCallback)(double *p, int n, void *), void *pArg) register callback for accessing raw data - if the rawDataCallback is registered, no filewriting/postprocessing will be carried on automatically by the software - the raw data are deleted by the software virtual void initDataset (int refresh) function to initalize a set of measurements (reset binning if angular conversion, reset summing otherwise) - can be overcome by the user's functions thanks to the virtual property virtual void addFrame (double *data, double pos, double i0, double t, string fname, double var) adds frame to merging/summation - can be overcome by the user's functions thanks to the virtual property virtual void finalizeDataset (double *a, double *v, double *e, int &np) finalizes the data set returning the array of angles, values and errors to be used as final data - can be overcome by the user's functions thanks to the virtual property int enableDataStreamingFromReceiver (int i=-1)int64_t getModuleFirmwareVersion ()int64_t getModuleSerialNumber (int imod=-1)int64_t getDetectorFirmwareVersion ()int64_t getDetectorSerialNumber ()int64_t getDetectorSoftwareVersion ()int64_t getThisSoftwareVersion ()void registerAcquisitionFinishedCallback (int(*func)(double, int, void *), void *pArg) register calbback for accessing detector final data void registerGetPositionCallback (double(*func)(void *), void *arg) register calbback for reading detector position void registerConnectChannelsCallback (int(*func)(void *), void *arg) register callback for connecting to the epics channels void registerDisconnectChannelsCallback (int(*func)(void *), void *arg) register callback to disconnect the epics channels void registerGoToPositionCallback (int(*func)(double, void *), void *arg) register callback for moving the detector void registerGoToPositionNoWaitCallback (int(*func)(double, void *), void *arg) register callback for moving the detector without waiting void registerGetI0Callback (double(*func)(int, void *), void *arg) register calbback reading to I0 string putCommand (int narg, char *args[], int pos=-1) sets parameters in command interface http://www.psi.ch/detectors/UsersSupportEN/slsDetectorClientHowTo.pdf string getCommand (int narg, char *args[], int pos=-1) gets parameters in command interface http://www.psi.ch/detectors/UsersSupportEN/slsDetectorClientHowTo.pdf int setClockDivider (int value) sets clock divider of detector int getContinuousReadoutFlag () gets continuous readout flag void setContinuousReadoutFlag () sets continuous readout flag int getStoreInRamReadoutFlag () gets store in ram readout flag void setStoreInRamReadoutFlag () sets store in ram readout flag int getParallelReadoutFlag () gets parallel readout flag void setParallelReadoutFlag () sets parallel readout flag int getNonParallelReadoutFlag () gets non parallel readout flag void setNonParallelReadoutFlag () sets non parallel readout flag int getSafeReadoutFlag () gets safe readout flag void setSafeReadoutFlag () sets safe readout flag int setAllTrimbits (int val) sets all trimbits to value (only available for eiger) int setDAC (int id, int dacindex, int val) set dac value int getADC (int id, int adcindex) get adc value Static Public Member Functions static string runStatusType (int s) returns string from run status index static int getDetectorSettings (string s) returns detector settings string from index static string getDetectorSettings (int s) returns detector settings string from index static string getTimingMode (int f) returns external communication mode string from index static int getTimingMode (string s) returns external communication mode string from index
-
Detailed Description
-
Class for detector functionalitiesto embed the detector controls in the users custom interface e.g. EPICS, Lima etc.
-
The slsDetectorUsers class is a minimal interface class which should be instantiated by the users in their acquisition software (EPICS, spec etc.). More advanced configuration functions are not implemented and can be written in a configuration or parameters file that can be read/written.
-
-
Definition at line 85 of file slsDetectorUsers.h .
-
Constructor & Destructor Documentation
-
-
-
-
-
- slsDetectorUsers::slsDetectorUsers
- (
- int
- id = 0
- )
-
-
-
-
-
-
default constructor
-
-
-
-
-
-
-
-
- virtual slsDetectorUsers::~slsDetectorUsers
- (
- )
- [virtual]
-
-
-
-
-
virtual destructor
-
-
-
-
Member Function Documentation
-
-
-
-
-
- virtual void slsDetectorUsers::addFrame
- (
- double *
- data ,
-
-
- double
- pos ,
-
-
- double
- i0 ,
-
-
- double
- t ,
-
-
- string
- fname ,
-
-
- double
- var
-
-
- )
- [virtual]
-
-
-
-
-
adds frame to merging/summation - can be overcome by the user's functions thanks to the virtual property
-
Parameters:
-
- data pointer to the raw data pos encoder position i0 beam monitor readout for intensity normalization (if 0 not performed) t exposure time in seconds, required only if rate corrections fname file name (unused since filewriting would be performed by the user) var optional parameter - unused.
-
-
-
-
-
-
-
-
-
-
- int slsDetectorUsers::dumpDetectorSetup
- (
- string const
- fname
- )
-
-
-
-
-
-
Reads the parameters from the detector and writes them to file.
-
Parameters:
-
- fname file to write to
-
-
-
Returns: OK or FAIL
-
-
-
-
-
-
-
-
- int slsDetectorUsers::enableAngularConversion
- (
- int
- i = -1
- )
-
-
-
-
-
-
enable/disable angular conversion
-
Parameters:
-
- i 0 disables, 1 enables, -1 gets
-
-
-
Returns: 0 if angular conversion disabled, 1 if enabled
-
-
-
-
-
-
-
-
- int slsDetectorUsers::enableCountRateCorrection
- (
- int
- i = -1
- )
-
-
-
-
-
-
enable/disable count rate corrections
-
Parameters:
-
- i 0 disables, 1 enable, -1 gets
-
-
-
Returns: 0 if count corrections disabled, 1 if enabled
-
-
-
-
-
-
-
-
- int slsDetectorUsers::enableDataStreamingFromReceiver
- (
- int
- i = -1
- )
-
-
-
-
-
Enable data streaming from receiver (zmq)
-
Parameters:
-
- i 1 to set, 0 to reset and -1 to get
-
-
-
Returns: data streaming enable
-
-
-
-
-
-
-
-
- int slsDetectorUsers::enableFlatFieldCorrection
- (
- int
- i = -1
- )
-
-
-
-
-
-
enable/disable flat field corrections (without changing file name)
-
Parameters:
-
- i 0 disables, 1 enables, -1 gets
-
-
-
Returns: 0 if ff corrections disabled, 1 if enabled
-
-
-
-
-
-
-
-
- int slsDetectorUsers::enablePixelMaskCorrection
- (
- int
- i = -1
- )
-
-
-
-
-
-
enable/disable bad channel corrections
-
Parameters:
-
- i 0 disables, 1 enables, -1 gets
-
-
-
Returns: 0 if bad channels corrections disabled, 1 if enabled
-
-
-
-
-
-
-
-
- int slsDetectorUsers::enableWriteToFile
- (
- int
- i = -1
- )
-
-
-
-
-
Enable write file function included
-
-
-
-
-
-
-
-
- virtual void slsDetectorUsers::finalizeDataset
- (
- double *
- a ,
-
-
- double *
- v ,
-
-
- double *
- e ,
-
-
- int &
- np
-
-
- )
- [virtual]
-
-
-
-
-
finalizes the data set returning the array of angles, values and errors to be used as final data - can be overcome by the user's functions thanks to the virtual property
-
Parameters:
-
- a pointer to the array of angles - can be null if no angular coversion is required v pointer to the array of values e pointer to the array of errors np reference returning the number of points
-
-
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getADC
- (
- int
- id ,
-
-
- int
- adcindex
-
-
- )
-
-
-
-
-
-
get adc value
-
Parameters:
-
- id module index (-1 for all) adcindex adc index
-
-
-
See also: dacIndex
-
Returns: adc value
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getCommand
- (
- int
- narg ,
-
-
- char *
- args [],
-
-
- int
- pos = -1
-
-
- )
-
-
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getContinuousReadoutFlag
- (
- )
-
-
-
-
-
-
gets continuous readout flag
-
Returns: gets continuous readout flag
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getDetectorDeveloper
- (
- )
-
-
-
-
-
-
useful to define subset of working functions
-
Returns: "PSI" or "Dectris"
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::getDetectorFirmwareVersion
- (
- )
-
-
-
-
-
get get Detector Firmware Version
-
Returns: id
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::getDetectorSerialNumber
- (
- )
-
-
-
-
-
get get Detector Serial Number
-
Returns: id
-
-
-
-
-
-
-
-
- static string slsDetectorUsers::getDetectorSettings
- (
- int
- s
- )
- [inline, static]
-
-
-
-
-
returns detector settings string from index
-
Parameters:
-
-
-
-
Returns: standard, fast, highgain, dynamicgain, lowgain, mediumgain, veryhighgain, undefined when wrong index
-
-
Definition at line 682 of file slsDetectorUsers.h .
-
-
-
-
-
-
-
-
- static int slsDetectorUsers::getDetectorSettings
- (
- string
- s
- )
- [inline, static]
-
-
-
-
-
returns detector settings string from index
-
Parameters:
-
- s can be standard, fast, highgain, dynamicgain, lowgain, mediumgain, veryhighgain
-
-
-
Returns: setting index (-1 unknown string)
-
-
Definition at line 668 of file slsDetectorUsers.h .
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getDetectorSize
- (
- int &
- x0 ,
-
-
- int &
- y0 ,
-
-
- int &
- nx ,
-
-
- int &
- ny
-
-
- )
-
-
-
-
-
-
gets detector size
-
Parameters:
-
- x0 horizontal position origin in channel number y0 vertical position origin in channel number nx number of channels in horiziontal ny number of channels in vertical
-
-
-
Returns: OK/FAIL
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::getDetectorSoftwareVersion
- (
- )
-
-
-
-
-
get get Detector Software Version
-
Returns: id
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getDetectorStatus
- (
- )
-
-
-
-
-
-
get run status
-
Returns: status mask
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getDetectorType
- (
- )
-
-
-
-
-
-
useful for data plotting etc.
-
Returns: Mythen, Eiger, Gotthard etc.
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getFileIndex
- (
- )
-
-
-
-
-
Returns: the default output file index
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getFileName
- (
- )
-
-
-
-
-
Returns: the default output files root name
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getFilePath
- (
- )
-
-
-
-
-
-
returns the default output files path
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getFlatFieldCorrectionDir
- (
- )
-
-
-
-
-
-
get flat field corrections file directory
-
Returns: flat field correction file directory
-
-
-
-
-
-
-
-
- string slsDetectorUsers::getFlatFieldCorrectionFile
- (
- )
-
-
-
-
-
-
get flat field corrections file name
-
Returns: flat field correction file name
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getMaximumDetectorSize
- (
- int &
- nx ,
-
-
- int &
- ny
-
-
- )
-
-
-
-
-
-
setsthe maximum detector size
-
Parameters:
-
- x0 horizontal position origin in channel number y0 vertical position origin in channel number nx number of channels in horiziontal ny number of channels in vertical
-
-
-
Returns: OK/FAIL
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::getModuleFirmwareVersion
- (
- )
-
-
-
-
-
get get Module Firmware Version
-
Returns: id
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::getModuleSerialNumber
- (
- int
- imod = -1
- )
-
-
-
-
-
get get Module Serial Number
-
Parameters:
-
-
-
-
Returns: id
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getNonParallelReadoutFlag
- (
- )
-
-
-
-
-
-
gets non parallel readout flag
-
Returns: gets non parallel readout flag
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getParallelReadoutFlag
- (
- )
-
-
-
-
-
-
gets parallel readout flag
-
Returns: gets parallel readout flag
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getPositions
- (
- double *
- pos = NULL
- )
-
-
-
-
-
-
get positions for the acquisition
-
Parameters:
-
- pos array which will contain the encoder positions
-
-
-
Returns: number of positions
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getSafeReadoutFlag
- (
- )
-
-
-
-
-
-
gets safe readout flag
-
Returns: gets safe readout flag
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getStoreInRamReadoutFlag
- (
- )
-
-
-
-
-
-
gets store in ram readout flag
-
Returns: gets store in ram readout flag
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::getThisSoftwareVersion
- (
- )
-
-
-
-
-
get this Software Version
-
Returns: id
-
-
-
-
-
-
-
-
- int slsDetectorUsers::getThresholdEnergy
- (
- )
-
-
-
-
-
-
get threshold energy
-
Returns: current threshold value for imod in ev (-1 failed)
-
-
-
-
-
-
-
-
- static int slsDetectorUsers::getTimingMode
- (
- string
- s
- )
- [inline, static]
-
-
-
-
-
returns external communication mode string from index
-
Parameters:
-
- f index for communication mode
-
-
-
Returns: auto, trigger, ro_trigger, gating, triggered_gating, unknown when wrong mode
-
-
Definition at line 718 of file slsDetectorUsers.h .
-
-
-
-
-
-
-
-
- static string slsDetectorUsers::getTimingMode
- (
- int
- f
- )
- [inline, static]
-
-
-
-
-
returns external communication mode string from index
-
Parameters:
-
- f index for communication mode
-
-
-
Returns: auto, trigger, ro_trigger, gating, triggered_gating, unknown when wrong mode
-
-
Definition at line 702 of file slsDetectorUsers.h .
-
-
-
-
-
-
-
-
- virtual void slsDetectorUsers::initDataset
- (
- int
- refresh
- )
- [virtual]
-
-
-
-
-
function to initalize a set of measurements (reset binning if angular conversion, reset summing otherwise) - can be overcome by the user's functions thanks to the virtual property
-
Parameters:
-
- refresh if 1, all parameters like ffcoefficients, badchannels, ratecorrections etc. are reset (should be called at least onece with this option), if 0 simply reset merging/ summation
-
-
-
-
-
-
-
-
-
-
- string slsDetectorUsers::putCommand
- (
- int
- narg ,
-
-
- char *
- args [],
-
-
- int
- pos = -1
-
-
- )
-
-
-
-
-
-
-
-
-
-
- int slsDetectorUsers::readConfigurationFile
- (
- string const
- fname
- )
-
-
-
-
-
-
Reads the configuration file -- will contain all the informations needed for the configuration (e.g. for a PSI detector caldir, settingsdir, angconv, badchannels, hostname etc.).
-
Parameters:
-
-
-
-
Returns: OK or FAIL
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerAcquisitionFinishedCallback
- (
- int(*)(double, int, void *)
- func ,
-
-
- void *
- pArg
-
-
- )
-
-
-
-
-
-
register calbback for accessing detector final data
-
Parameters:
-
- func function to be called at the end of the acquisition. gets detector status and progress index as arguments
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerConnectChannelsCallback
- (
- int(*)(void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
-
register callback for connecting to the epics channels
-
Parameters:
-
- func function for connecting to the epics channels
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerDataCallback
- (
- int(*)(detectorData *d, int f, int s, void *)
- userCallback ,
-
-
- void *
- pArg
-
-
- )
-
-
-
-
-
-
register calbback for accessing detector final data
-
Parameters:
-
- userCallback function for plotting/analyzing the data. Its arguments are the data structure d and the frame number f, s is for subframe number for eiger for 32 bit mode
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerDisconnectChannelsCallback
- (
- int(*)(void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
-
register callback to disconnect the epics channels
-
Parameters:
-
- func function to disconnect the epics channels
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerGetI0Callback
- (
- double(*)(int, void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
-
register calbback reading to I0
-
Parameters:
-
- func function for reading the I0 (called with parameter 0 before the acquisition, 1 after and the return value used as I0)
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerGetPositionCallback
- (
- double(*)(void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
-
register calbback for reading detector position
-
Parameters:
-
- func function for reading the detector position
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerGoToPositionCallback
- (
- int(*)(double, void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
-
register callback for moving the detector
-
Parameters:
-
- func function for moving the detector
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerGoToPositionNoWaitCallback
- (
- int(*)(double, void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
-
register callback for moving the detector without waiting
-
Parameters:
-
- func function for moving the detector
-
-
-
-
-
-
-
-
-
-
- void slsDetectorUsers::registerRawDataCallback
- (
- int(*)(double *p, int n, void *)
- userCallback ,
-
-
- void *
- pArg
-
-
- )
-
-
-
-
-
-
register callback for accessing raw data - if the rawDataCallback is registered, no filewriting/postprocessing will be carried on automatically by the software - the raw data are deleted by the software
-
Parameters:
-
- userCallback function for postprocessing and saving the data - p is the pointer to the data, n is the number of channels
-
-
-
-
-
-
-
-
-
-
- int slsDetectorUsers::retrieveDetectorSetup
- (
- string const
- fname
- )
-
-
-
-
-
-
Loads the detector setup from file.
-
Parameters:
-
- fname file to read from
-
-
-
Returns: OK or FAIL
-
-
-
-
-
-
-
-
- static string slsDetectorUsers::runStatusType
- (
- int
- s
- )
- [inline, static]
-
-
-
-
-
returns string from run status index
-
Parameters:
-
-
-
-
Returns: string error, waiting, running, data, finished or unknown when wrong index
-
-
Definition at line 650 of file slsDetectorUsers.h .
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setAllTrimbits
- (
- int
- val
- )
-
-
-
-
-
-
sets all trimbits to value (only available for eiger)
-
Parameters:
-
- val value to be set (-1 gets)
-
-
-
Returns: value set
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setBitDepth
- (
- int
- i = -1
- )
-
-
-
-
-
-
set/get dynamic range
-
Parameters:
-
- i dynamic range (-1 get)
-
-
-
Returns: current dynamic range
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setClockDivider
- (
- int
- value
- )
-
-
-
-
-
-
sets clock divider of detector
-
Parameters:
-
- value value to be set (-1 gets)
-
-
-
Returns: speed of detector
-
-
-
-
-
-
-
-
- void slsDetectorUsers::setContinuousReadoutFlag
- (
- )
-
-
-
-
-
-
sets continuous readout flag
-
Returns: OK if successful, else false
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setDAC
- (
- int
- id ,
-
-
- int
- dacindex ,
-
-
- int
- val
-
-
- )
-
-
-
-
-
-
set dac value
-
Parameters:
-
- id module index (-1 for all) dacindex dac index
-
-
-
See also: dacIndex
-
Parameters:
-
- val value to be set (-1 gets)
-
-
-
Returns: dac value
-
-
-
-
-
-
-
-
- double slsDetectorUsers::setDelayAfterTrigger
- (
- double
- t = -1,
-
-
- bool
- inseconds = false
-
-
- )
-
-
-
-
-
-
set/get delay after trigger
-
Parameters:
-
- t time in ns (-1 gets) inseconds true if the value is in s, else ns
-
-
-
Returns: timer set value in ns, or s if specified
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setDetectorSize
- (
- int
- x0 = -1,
-
-
- int
- y0 = -1,
-
-
- int
- nx = -1,
-
-
- int
- ny = -1
-
-
- )
-
-
-
-
-
-
sets the detector size
-
Parameters:
-
- x0 horizontal position origin in channel number (-1 unchanged) y0 vertical position origin in channel number (-1 unchanged) nx number of channels in horiziontal (-1 unchanged) ny number of channels in vertical (-1 unchanged)
-
-
-
Returns: OK/FAIL
-
-
-
-
-
-
-
-
- double slsDetectorUsers::setExposurePeriod
- (
- double
- t = -1,
-
-
- bool
- inseconds = false
-
-
- )
-
-
-
-
-
-
set/get exposure period
-
Parameters:
-
- t time in ns (-1 gets) inseconds true if the value is in s, else ns
-
-
-
Returns: timer set value in ns, or s if specified
-
-
-
-
-
-
-
-
- double slsDetectorUsers::setExposureTime
- (
- double
- t = -1,
-
-
- bool
- inseconds = false
-
-
- )
-
-
-
-
-
-
set/get exposure time value
-
Parameters:
-
- t time in sn (-1 gets) inseconds true if the value is in s, else ns
-
-
-
Returns: timer set value in ns, or s if specified
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setFileIndex
- (
- int
- i
- )
-
-
-
-
-
-
sets the default output file index
-
Parameters:
-
-
-
-
Returns: the default output file index
-
-
-
-
-
-
-
-
- string slsDetectorUsers::setFileName
- (
- string
- s
- )
-
-
-
-
-
-
sets the default output files path
-
Parameters:
-
-
-
-
Returns: the default output files root name
-
-
-
-
-
-
-
-
- string slsDetectorUsers::setFilePath
- (
- string
- s
- )
-
-
-
-
-
-
sets the default output files path
-
Parameters:
-
-
-
-
Returns: file path
-
-
-
-
-
-
-
-
- string slsDetectorUsers::setFlatFieldCorrectionDir
- (
- string
- dir
- )
-
-
-
-
-
-
set flat field corrections file directory
-
Parameters:
-
- dir flat field correction file directory
-
-
-
Returns: flat field correction file directory
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setFlatFieldCorrectionFile
- (
- string
- fname = ""
- )
-
-
-
-
-
-
set flat field correction file
-
Parameters:
-
- fname name of the flat field file (or "" if disable)
-
-
-
Returns: 0 if disable (or file could not be read), >0 otherwise
-
-
-
-
-
-
-
-
- void slsDetectorUsers::setNonParallelReadoutFlag
- (
- )
-
-
-
-
-
-
sets non parallel readout flag
-
Returns: OK if successful, else false
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::setNumberOfCycles
- (
- int64_t
- t = -1
- )
-
-
-
-
-
-
set/get number of cycles i.e. number of triggers
-
Parameters:
-
- t number of frames (-1 gets)
-
-
-
Returns: number of frames
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::setNumberOfFrames
- (
- int64_t
- t = -1
- )
-
-
-
-
-
-
set/get number of frames i.e. number of exposure per trigger
-
Parameters:
-
- t number of frames (-1 gets)
-
-
-
Returns: number of frames
-
-
-
-
-
-
-
-
- int64_t slsDetectorUsers::setNumberOfGates
- (
- int64_t
- t = -1
- )
-
-
-
-
-
-
set/get number of gates
-
Parameters:
-
- t number of gates (-1 gets)
-
-
-
Returns: number of gates
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setOnline
- (
- int const
- online = -1
- )
-
-
-
-
-
-
sets the onlineFlag
-
Parameters:
-
- online can be: -1 returns wether the detector is in online (1) or offline (0) state; 0 detector in offline state; 1 detector in online state
-
-
-
Returns: 0 (offline) or 1 (online)
-
-
-
-
-
-
-
-
- void slsDetectorUsers::setParallelReadoutFlag
- (
- )
-
-
-
-
-
-
sets parallel readout flag
-
Returns: OK if successful, else false
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setPositions
- (
- int
- nPos ,
-
-
- double *
- pos
-
-
- )
-
-
-
-
-
-
set positions for the acquisition
-
Parameters:
-
- nPos number of positions pos array with the encoder positions
-
-
-
Returns: number of positions
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setReceiverMode
- (
- int
- n = -1
- )
-
-
-
-
-
-
sets the mode by which gui requests data from receiver
-
Parameters:
-
- n is 0 for random requests for fast acquisitions and greater than 0 for nth read requests
-
-
-
Returns: the mode set in the receiver
-
-
-
-
-
-
-
-
- void slsDetectorUsers::setSafeReadoutFlag
- (
- )
-
-
-
-
-
-
sets safe readout flag
-
Returns: OK if successful, else false
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setSettings
- (
- int
- isettings = -1
- )
-
-
-
-
-
-
set detector settings
-
Parameters:
-
- isettings settings index (-1 gets)
-
-
-
Returns: current settings
-
-
-
-
-
-
-
-
- void slsDetectorUsers::setStoreInRamReadoutFlag
- (
- )
-
-
-
-
-
-
sets store in ram readout flag
-
Returns: OK if successful, else false
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setThresholdEnergy
- (
- int
- e_eV
- )
-
-
-
-
-
-
set threshold energy
-
Parameters:
-
-
-
-
Returns: current threshold value for imod in ev (-1 failed)
-
-
-
-
-
-
-
-
- int slsDetectorUsers::setTimingMode
- (
- int
- pol = -1
- )
-
-
-
-
-
-
set/get the external communication mode
-
Parameters:
-
-
-
-
See also: getTimingMode
-
Returns: current external communication mode
-
-
-
-
-
-
-
-
- void slsDetectorUsers::startMeasurement
- (
- )
-
-
-
-
-
-
start measurement and acquires
-
Returns: OK/FAIL
-
-
-
-
-
-
-
-
- int slsDetectorUsers::stopMeasurement
- (
- )
-
-
-
-
-
-
stop measurement
-
Returns: OK/FAIL
-
-
-
-
The documentation for this class was generated from the following file:
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Member List
-
-
slsReceiverUsers Member List This is the complete list of members for
slsReceiverUsers , including all inherited members.
- getReceiverVersion ()slsReceiverUsers receiver slsReceiverUsers registerCallBackAcquisitionFinished (void(*func)(uint64_t nf, void *), void *arg)slsReceiverUsers registerCallBackRawDataReady (void(*func)(uint64_t frameNumber, uint32_t expLength, uint32_t packetNumber, uint64_t bunchId, uint64_t timestamp, uint16_t modId, uint16_t xCoord, uint16_t yCoord, uint16_t zCoord, uint32_t debug, uint16_t roundRNumber, uint8_t detType, uint8_t version, char *datapointer, uint32_t datasize, void *), void *arg)slsReceiverUsers registerCallBackStartAcquisition (int(*func)(char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *), void *arg)slsReceiverUsers slsReceiverUsers (int argc, char *argv[], int &success)slsReceiverUsers start ()slsReceiverUsers stop ()slsReceiverUsers ~slsReceiverUsers ()slsReceiverUsers
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 slsReceiverUsers Class Reference
-
-
slsReceiverUsers Class Reference
-
Class for implementing the SLS data receiver in the users application. Callbacks can be defined for processing and/or saving data.
-More...
-
-
#include <slsReceiverUsers.h >
-
-
List of all members.
-
-Public Member Functions slsReceiverUsers (int argc, char *argv[], int &success) ~slsReceiverUsers ()int start ()void stop ()int64_t getReceiverVersion ()void registerCallBackStartAcquisition (int(*func)(char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *), void *arg)void registerCallBackAcquisitionFinished (void(*func)(uint64_t nf, void *), void *arg)void registerCallBackRawDataReady (void(*func)(uint64_t frameNumber, uint32_t expLength, uint32_t packetNumber, uint64_t bunchId, uint64_t timestamp, uint16_t modId, uint16_t xCoord, uint16_t yCoord, uint16_t zCoord, uint32_t debug, uint16_t roundRNumber, uint8_t detType, uint8_t version, char *datapointer, uint32_t datasize, void *), void *arg)Public Attributes slsReceiver * receiver
-
Detailed Description
-
Class for implementing the SLS data receiver in the users application. Callbacks can be defined for processing and/or saving data.
-
slsReceiverUsers is a class that can be instantiated in the users software to receive the data from the detectors. Callbacks can be defined for processing and/or saving data
-
-
Definition at line 16 of file slsReceiverUsers.h .
-
Constructor & Destructor Documentation
-
-
-
-
-
- slsReceiverUsers::slsReceiverUsers
- (
- int
- argc ,
-
-
- char *
- argv [],
-
-
- int &
- success
-
-
- )
-
-
-
-
-
Constructor reads config file, creates socket, assigns function table
-
Parameters:
-
- argc from command line argv from command line succecc socket creation was successfull
-
-
-
-
-
-
-
-
-
-
- slsReceiverUsers::~slsReceiverUsers
- (
- )
-
-
-
-
-
-
Member Function Documentation
-
-
-
-
-
- int64_t slsReceiverUsers::getReceiverVersion
- (
- )
-
-
-
-
-
get get Receiver Version
-
Returns: id
-
-
-
-
-
-
-
-
- void slsReceiverUsers::registerCallBackAcquisitionFinished
- (
- void(*)(uint64_t nf, void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
register callback for end of acquisition
-
Parameters:
-
- func end of acquisition callback. Argument nf is total frames caught
-
-
-
Returns: nothing
-
-
-
-
-
-
-
-
- void slsReceiverUsers::registerCallBackRawDataReady
- (
- void(*)(uint64_t frameNumber, uint32_t expLength, uint32_t packetNumber, uint64_t bunchId, uint64_t timestamp, uint16_t modId, uint16_t xCoord, uint16_t yCoord, uint16_t zCoord, uint32_t debug, uint16_t roundRNumber, uint8_t detType, uint8_t version, char *datapointer, uint32_t datasize, void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
register callback to be called when data are available (to process and/or save the data).
-
Parameters:
-
- func raw data ready callback. arguments are frameNumber, expLength, packetNumber, bunchId, timestamp, modId, xCoord, yCoord, zCoord, debug, roundRNumber, detType, version, dataPointer, dataSize
-
-
-
Returns: nothing
-
-
-
-
-
-
-
-
- void slsReceiverUsers::registerCallBackStartAcquisition
- (
- int(*)(char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *)
- func ,
-
-
- void *
- arg
-
-
- )
-
-
-
-
-
register calbback for starting the acquisition
-
Parameters:
-
- func callback to be called when starting the acquisition. Its arguments are filepath, filename, fileindex, datasize
-
-
-
Returns: value is insignificant at the moment, we write depending on file write enable, users get data to write depending on call backs registered
-
-
-
-
-
-
-
-
- int slsReceiverUsers::start
- (
- )
-
-
-
-
-
starts listening on the TCP port for client comminication
-
Returns: 0 for success or 1 for FAIL in creating TCP server
-
-
-
-
-
-
-
-
- void slsReceiverUsers::stop
- (
- )
-
-
-
-
-
stops listening to the TCP & UDP port and exit receiver program
-
-
-
-
Member Data Documentation
-
-
-
The documentation for this class was generated from the following file:
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 detectorData.h File Reference
-
-
detectorData.h File Reference #include <unistd.h>
-
#include <cstring>
-
-
Go to the source code of this file.
-
-Classes class detectorData data structure to hold the detector data after postprocessing (e.g. to plot, store in a root tree etc.) More...
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 detectorData.h Source File
-
-
-
-
detectorData.h Go to the documentation of this file. #include <unistd.h>
-#include <cstring>
-#ifndef DETECTOR_DATA_H
-#define DETECTOR_DATA_H
-00009 class detectorData {
-public :
-00020 detectorData (double *val=NULL, double *err=NULL, double *ang=NULL, double p_ind=-1, const char *fname="" , int np=-1, int ny=1) : values (val), errors (err), angles (ang), progressIndex (p_ind), npoints (np), npy (ny){
-fileName ,fname);
-00027 ~detectorData () {if (values ) delete [] values ; if (errors ) delete [] errors ; if (angles ) delete [] angles ;};
-double *values ;
-00030 double *errors ;
-00031 double *angles ;
-00032 double progressIndex ;
-00033 char fileName [1000];
-00034 int npoints ;
-00035 int npy ;
-#endif
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 File Index
-
-
File List Here is a list of all files with brief descriptions:
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members
-
-Here is a list of all class members with links to the classes they belong to:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members - Functions
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members - Variables
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members
-
-Here is a list of all file members with links to the files they belong to:
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Class Members
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Main Page
-
-
API for SLS detectors data acquisition
-
-
Although the SLS detectors group delvelops several types of detectors (1/2D, counting/integrating etc.) it is common interest of the group to use a common platfor for data acquisition
-
The architecture of the acquisitions system is intended as follows:
-
-A socket server running on the detector (or more than one in some special cases)
-C++ classes common to all detectors for client-server communication. These can be supplied to users as libraries and embedded also in acquisition systems which are not developed by the SLS
-the possibility of using a Qt-based graphical user interface (with eventually root analisys capabilities)
-the possibility of running all commands from command line. In order to ensure a fast operation of this so called "text client" the detector parameters should not be re-initialized everytime. For this reason a shared memory block is allocated where the main detector flags and parameters are stored
-a Root library for data postprocessing and detector calibration (energy, angle).
-
-
slsDetectorUsers is a class to control the detector which should be instantiated by the users in their acquisition software (EPICS, spec etc.). A callback for dislaying the data can be registered. More advanced configuration functions are not implemented and can be written in a configuration file tha can be read/written.
-
slsReceiverUsers is a class to receive the data for detectors with external data receiver (e.g. GOTTHARD). Callbacks can be registered to process the data or save them in specific formats.
-
detectorData is a structure containing the data and additional information which is used to return the data e.g. to the GUI for displaying them.
-
You can find examples of how this classes can be instatiated in mainClient.cpp and mainReceiver.cpp
-
Authors: Anna Bergamaschi , Dhanya Thattil
-
Version: 3.0 Currently supported detectors
-
-
-MYTHEN
-GOTTHARD controls
-GOTTHARD data receiver
-EIGER
-JUNGFRAU
-
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 ; s/[ \t\n]*$//g ; $subst{"_doc"} = $_;
- $_= ; s/[ \t\n]*$//g ; $subst{"_cgi"} = $_;
-}
-
-while ( @ARGV ) {
- $_ = shift @ARGV;
- if ( s/^-// ) {
- if ( /^l(.*)/ ) {
- $v = ($1 eq "") ? shift @ARGV : $1;
- ($v =~ /\/$/) || ($v .= "/");
- $_ = $v;
- if ( /(.+)\@(.+)/ ) {
- if ( exists $subst{$1} ) {
- $subst{$1} = $2;
- } else {
- print STDERR "Unknown tag file $1 given with option -l\n";
- &usage();
- }
- } else {
- print STDERR "Argument $_ is invalid for option -l\n";
- &usage();
- }
- }
- elsif ( /^q/ ) {
- $quiet = 1;
- }
- elsif ( /^\?|^h/ ) {
- &usage();
- }
- else {
- print STDERR "Illegal option -$_\n";
- &usage();
- }
- }
- else {
- push (@files, $_ );
- }
-}
-
-foreach $sub (keys %subst)
-{
- if ( $subst{$sub} eq "" )
- {
- print STDERR "No substitute given for tag file `$sub'\n";
- &usage();
- }
- elsif ( ! $quiet && $sub ne "_doc" && $sub ne "_cgi" )
- {
- print "Substituting $subst{$sub} for each occurence of tag file $sub\n";
- }
-}
-
-if ( ! @files ) {
- if (opendir(D,".")) {
- foreach $file ( readdir(D) ) {
- $match = ".html";
- next if ( $file =~ /^\.\.?$/ );
- ($file =~ /$match/) && (push @files, $file);
- ($file =~ "tree.js") && (push @files, $file);
- }
- closedir(D);
- }
-}
-
-if ( ! @files ) {
- print STDERR "Warning: No input files given and none found!\n";
-}
-
-foreach $f (@files)
-{
- if ( ! $quiet ) {
- print "Editing: $f...\n";
- }
- $oldf = $f;
- $f .= ".bak";
- unless (rename $oldf,$f) {
- print STDERR "Error: cannot rename file $oldf\n";
- exit 1;
- }
- if (open(F,"<$f")) {
- unless (open(G,">$oldf")) {
- print STDERR "Error: opening file $oldf for writing\n";
- exit 1;
- }
- if ($oldf ne "tree.js") {
- while () {
- s/doxygen\=\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\" (href|src)=\"\2/doxygen\=\"$1:$subst{$1}\" \3=\"$subst{$1}/g;
- print G "$_";
- }
- }
- else {
- while () {
- s/\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\", \"\2/\"$1:$subst{$1}\" ,\"$subst{$1}/g;
- print G "$_";
- }
- }
- }
- else {
- print STDERR "Warning file $f does not exist\n";
- }
- unlink $f;
-}
-
-sub usage {
- print STDERR "Usage: installdox [options] [html-file [html-file ...]]\n";
- print STDERR "Options:\n";
- print STDERR " -l tagfile\@linkName tag file + URL or directory \n";
- print STDERR " -q Quiet mode\n\n";
- exit 1;
-}
diff --git a/manual/docs/html/slsDetectorUsersDocs/mainClient_8cpp.html b/manual/docs/html/slsDetectorUsersDocs/mainClient_8cpp.html
deleted file mode 100644
index 4d2ef5239..000000000
--- a/manual/docs/html/slsDetectorUsersDocs/mainClient_8cpp.html
+++ /dev/null
@@ -1,207 +0,0 @@
-
-
-
-
-mainClient.cpp File Reference
-
-
mainClient.cpp File Reference #include "slsDetectorUsers.h "
-
#include "detectorData.h "
-
#include <iostream>
-
#include <cstdlib>
-
-
Go to the source code of this file.
-
-
Detailed Description
-
This file is an example of how to implement the slsDetectorUsers class You can compile it linking it to the slsDetector library
-
g++ mainClient.cpp -L lib -lSlsDetector -L/usr/lib64/ -L lib2 -lzmq -pthread -lrt -lm -lstdc++
-
where,
-
lib is the location of libSlsDetector.so
-
lib2 is the location of the libzmq.a. [ libzmq.a is required only when using data call backs and enabling data streaming from receiver to client. It is linked in manual/manual-api from slsReceiverSoftware/include ]
-
-
Definition in file mainClient.cpp .
-
Function Documentation
-
-
-
-
-
- int dataCallback
- (
- detectorData * pData ,
-
-
- int
- iframe ,
-
-
- int
- isubframe ,
-
-
- void *
- pArg
-
-
- )
-
-
-
-
-
Data Call back function defined
-
Parameters:
-
- pData pointer to data structure received from the call back iframe frame number of data passed isubframe sub frame number of data passed ( only valid for EIGER in 32 bit mode) pArg pointer to object
-
-
-
Returns: integer that is currently ignored
-
-
Definition at line 32 of file mainClient.cpp .
-
-
-
-
-
-
-
-
- int main
- (
- int
- argc ,
-
-
- char **
- argv
-
-
- )
-
-
-
-
-
Example of a main program using the slsDetectorUsers class
-
-Arguments are optional
-argv[1] : Configuration File
-argv[2] : Measurement Setup File
-argv[3] : Detector Id (default is zero)
-
-
-
-
-
-if specified, set ID from argv[3]
-
-
-
-if specified, load configuration file (necessary at least the first time it is called to properly configure advanced settings in the shared memory)
-
-
-registering data callback
-
-
-if receiver exists, enable data streaming from receiver to get the data
-
-
-ensuring detector status is idle before starting acquisition. exiting if not idle
-
-
-if provided, load detector settings
-
-
-
-returning when acquisition is finished or data are avilable
-
-
-
-
-
Definition at line 46 of file mainClient.cpp .
-
-
-
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 mainClient.cpp Source File
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 mainReceiver.cpp File Reference
-
-
mainReceiver.cpp File Reference #include "sls_receiver_defs.h"
-
#include "slsReceiverUsers.h "
-
#include <iostream>
-
#include <string.h>
-
#include <signal.h>
-
#include <cstdlib>
-
#include <sys/types.h>
-
#include <sys/wait.h>
-
#include <string>
-
#include <unistd.h>
-
#include <errno.h>
-
#include <syscall.h>
-
-
Go to the source code of this file.
-
-Defines #define PRINT_IN_COLOR (c, f,...) printf ("\033[%dm" f RESET, 30 + c+1, ##__VA_ARGS__)Functions void sigInterruptHandler (int p)void printHelp ()int StartAcq (char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *p)void AcquisitionFinished (uint64_t frames, void *p)void GetData (uint64_t frameNumber, uint32_t expLength, uint32_t packetNumber, uint64_t bunchId, uint64_t timestamp, uint16_t modId, uint16_t xCoord, uint16_t yCoord, uint16_t zCoord, uint32_t debug, uint16_t roundRNumber, uint8_t detType, uint8_t version, char *datapointer, uint32_t datasize, void *p)int main (int argc, char *argv[])Variables bool keeprunning
-
Detailed Description
-
This file is an example of how to implement the slsReceiverUsers class You can compile it linking it to the slsReceiver library
-
g++ mainReceiver.cpp -L lib -lSlsReceiver -L/usr/lib64/ -L lib2 -lzmq -pthread -lrt -lm -lstdc++
-
where,
-
lib is the location of lSlsReceiver.so
-
lib2 is the location of the libzmq.a. [ libzmq.a is required only when using data call backs and enabling data streaming from receiver to client. It is linked in manual/manual-api from slsReceiverSoftware/include ]
-
-
Definition in file mainReceiver.cpp .
-
Define Documentation
-
-
-
-
-
- #define PRINT_IN_COLOR
- (
- c,
-
-
- f,
-
-
- ...
- )
- printf ("\033[%dm" f RESET, 30 + c+1, ##__VA_ARGS__)
-
-
-
-
-
Define Colors to print data call back in different colors for different recievers
-
-
Definition at line 38 of file mainReceiver.cpp .
-
-
-
-
Function Documentation
-
-
-
-
-
- void AcquisitionFinished
- (
- uint64_t
- frames ,
-
-
- void *
- p
-
-
- )
-
-
-
-
-
Acquisition Finished Call back
-
Parameters:
-
- frames Number of frames caught p pointer to object
-
-
-
-
Definition at line 86 of file mainReceiver.cpp .
-
-
-
-
-
-
-
-
- void GetData
- (
- uint64_t
- frameNumber ,
-
-
- uint32_t
- expLength ,
-
-
- uint32_t
- packetNumber ,
-
-
- uint64_t
- bunchId ,
-
-
- uint64_t
- timestamp ,
-
-
- uint16_t
- modId ,
-
-
- uint16_t
- xCoord ,
-
-
- uint16_t
- yCoord ,
-
-
- uint16_t
- zCoord ,
-
-
- uint32_t
- debug ,
-
-
- uint16_t
- roundRNumber ,
-
-
- uint8_t
- detType ,
-
-
- uint8_t
- version ,
-
-
- char *
- datapointer ,
-
-
- uint32_t
- datasize ,
-
-
- void *
- p
-
-
- )
-
-
-
-
-
Get Receiver Data Call back Prints in different colors(for each receiver process) the different headers for each image call back.
-
Parameters:
-
- frameNumber frame number expLength real time exposure length (in 100ns) or sub frame number (Eiger 32 bit mode only) packetNumber number of packets caught for this frame bunchId bunch id from beamline timestamp time stamp in 10MHz clock (not implemented for most) modId module id (not implemented for most) xCoord x coordinates (detector id in 1D) yCoord y coordinates (not implemented) zCoord z coordinates (not implemented) debug debug values if any roundRNumber (not implemented) detType detector type see :: detectorType version version of standard header (structure format) datapointer pointer to data datasize data size in bytes p pointer to object
-
-
-
-
Definition at line 110 of file mainReceiver.cpp .
-
-
-
-
-
-
-
-
- int main
- (
- int
- argc ,
-
-
- char *
- argv []
-
-
- )
-
-
-
-
-
Example of main program using the slsReceiverUsers class
-
-Defines in file for:
-Default Number of receivers is 1
-Default Start TCP port is 1954
-
-
-
-
-
-
-get number of receivers and start tcp port from command line arguments
-
-
-Catch signal SIGINT to close files and call destructors properly
-
-
-Ignore SIG_PIPE, prevents global signal handler, handle locally, instead of a server crashing due to client crash when writing, it just gives error
-
-
-loop over number of receivers
-
-
-fork process to create child process
-
-
-if fork failed, raise SIGINT and properly destroy all child processes
-
-
-
-
-register callbacks. remember to set file write enable to 0 (using the client) if we should not write files and you will write data using the callbacks
-
-
-Call back for start acquisition
-
-
-Call back for acquisition finished
-
-
-start tcp server thread
-
-
-as long as keeprunning is true (changes with Ctrl+C)
-
-
-
-Parent process ignores SIGINT (exits only when all child process exits)
-
-
-Print Ready and Instructions how to exit
-
-
-Parent process waits for all child processes to exit
-
-
-
-
Definition at line 133 of file mainReceiver.cpp .
-
-
-
-
-
-
-
-
- void printHelp
- (
- )
-
-
-
-
-
prints usage of this example program
-
-
Definition at line 55 of file mainReceiver.cpp .
-
-
-
-
-
-
-
-
- void sigInterruptHandler
- (
- int
- p
- )
-
-
-
-
-
Control+C Interrupt Handler Sets the variable keeprunning to false, to let all the processes know to exit properly
-
-
Definition at line 48 of file mainReceiver.cpp .
-
-
-
-
-
-
-
-
- int StartAcq
- (
- char *
- filepath ,
-
-
- char *
- filename ,
-
-
- uint64_t
- fileindex ,
-
-
- uint32_t
- datasize ,
-
-
- void *
- p
-
-
- )
-
-
-
-
-
Start Acquisition Call back slsReceiver writes data if file write enabled. Users get data to write using call back if registerCallBackRawDataReady is registered.
-
Parameters:
-
- filepath file path filename file name fileindex file index datasize data size in bytes p pointer to object
-
-
-
Returns: ignored
-
-
Definition at line 73 of file mainReceiver.cpp .
-
-
-
-
Variable Documentation
-
-
-
-
-
Variable is true to continue running, set to false upon interrupt
-
-
Definition at line 42 of file mainReceiver.cpp .
-
-
-
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 mainReceiver.cpp Source File
-
-
-
-
mainReceiver.cpp Go to the documentation of this file. #include "sls_receiver_defs.h"
-#include "slsReceiverUsers.h "
-#include <iostream>
-#include <string.h>
-#include <signal.h>
-#include <cstdlib>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <string>
-#include <unistd.h>
-#include <errno.h>
-#include <syscall.h>
-using namespace std;
-00038 #define PRINT_IN_COLOR(c,f, ...) printf ("\033[%dm" f RESET, 30 + c+1, ##__VA_ARGS__)
-00042 bool keeprunning ;
-00048 void sigInterruptHandler (int p){
-keeprunning = false ;
-00055 void printHelp () {
-"Usage:\n"
-"./detReceiver\n"
-"or ./detReceiver [start_tcp_port] [num_receivers]\n"
-"Default values: start_tcp_port - 1954, num_receivers - 1\n\n" );
-00073 int StartAcq (char * filepath, char * filename, uint64_t fileindex, uint32_t datasize, void *p){
-"#### StartAcq: filepath:%s filename:%s fileindex:%llu datasize:%u ####\n" ,
-"--StartAcq: returning 0\n" );
-return 0;
-00086 void AcquisitionFinished (uint64_t frames, void *p){
-"#### AcquisitionFinished: frames:%llu ####\n" ,frames);
-00110 void GetData (uint64_t frameNumber, uint32_t expLength, uint32_t packetNumber, uint64_t bunchId, uint64_t timestamp,
-char * datapointer, uint32_t datasize, void * p){
-PRINT_IN_COLOR (xCoord,
-"#### %d GetData: ####\n"
-"frameNumber: %llu\t\texpLength: %u\t\tpacketNumber: %u\t\tbunchId: %llu\t\ttimestamp: %llu\t\tmodId: %u\t\t"
-"xCoord: %u\t\tyCoord: %u\t\tzCoord: %u\t\tdebug: %u\t\troundRNumber: %u\t\tdetType: %u\t\t"
-"version: %u\t\tfirstbytedata: 0x%x\t\tdatsize: %u\n\n" ,
-00133 int main (int argc, char *argv[]) {
-int numReceivers = 1;
-int startTCPPort = 1954;
-keeprunning = true ;
-if (argc > 1 && ((argc < 3) || (!sscanf(argv[1],"%d" , &startTCPPort)) || (!sscanf(argv[2],"%d" , &numReceivers)) ))
-printHelp ();
-"Parent Process Created [ Tid: %ld ]\n" , (long )syscall(SYS_gettid));
-"Number of Receivers: %d\n" , numReceivers);
-"Start TCP Port: %d\n" , startTCPPort);
-struct sigaction sa;
-sigInterruptHandler ;
-if (sigaction(SIGINT, &sa, NULL) == -1) {
-"Could not set handler function for SIGINT\n" );
-struct sigaction asa;
-if (sigaction(SIGPIPE, &asa, NULL) == -1) {
-"Could not set handler function for SIGPIPE\n" );
-for (int i = 0; i < numReceivers; ++i) {
-if (pid < 0) {
-"fork() failed. Killing all the receiver objects\n" );
-raise (SIGINT);
-else if (pid == 0) {
-"Child process %d [ Tid: %ld ]\n" , i, (long )syscall(SYS_gettid));
-char temp[10];
-"%d" ,startTCPPort + i);
-char * args[] = {(char *)"ignored" , (char *)"--rx_tcpport" , temp};
-int ret = slsReceiverDefs::OK;
-slsReceiverUsers *receiver = new slsReceiverUsers (3, args, ret);
-if (ret==slsReceiverDefs::FAIL){
-delete receiver;
-"Registering StartAcq()\n" );
-registerCallBackStartAcquisition (StartAcq , NULL);
-"Registering AcquisitionFinished()\n" );
-registerCallBackAcquisitionFinished (AcquisitionFinished , NULL);
-"Registering GetData() \n" );
-registerCallBackRawDataReady (GetData ,NULL);
-if (receiver->start () == slsReceiverDefs::FAIL){
-delete receiver;
-"Exiting Child Process [ Tid: %ld ]\n" , (long )syscall(SYS_gettid));
-while (keeprunning )
-delete receiver;
-"Exiting Child Process [ Tid: %ld ]\n" , (long )syscall(SYS_gettid));
-break ;
-if (sigaction(SIGINT, &sa, NULL) == -1) {
-"Could not set handler function for SIGINT\n" );
-"Ready ... " << endl;
-"\n[ Press \'Ctrl+c\' to exit ]\n" );
-for (;;) {
-if (childPid == -1) {
-if (errno == ECHILD) {
-"All Child Processes have been closed\n" );
-break ;
-else {
-"Unexpected error from waitpid(): (%s)\n" ,strerror(errno));
-break ;
-"Exiting Child Process [ Tid: %ld ]\n" , (long int ) childPid);
-"Goodbye!" << endl;
-return 0;
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1
-
Loading...
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
getADC
-
slsDetectorUsers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
-
-
setDAC
-
slsDetectorUsers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
start
-
slsReceiverUsers
-
-
-
-
-
-
-
stop
-
slsReceiverUsers
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
getADC
-
slsDetectorUsers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
-
-
-
setDAC
-
slsDetectorUsers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
start
-
slsReceiverUsers
-
-
-
-
-
-
-
stop
-
slsReceiverUsers
-
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
-
Searching...
-
No Matches
-
-
do a search
- {
- this.Search();
- }
- }
-
- this.OnSearchSelectKey = function(evt)
- {
- var e = (evt) ? evt : window.event; // for IE
- if (e.keyCode==40 && this.searchIndex0) // Up
- {
- this.searchIndex--;
- this.OnSelectItem(this.searchIndex);
- }
- else if (e.keyCode==13 || e.keyCode==27)
- {
- this.OnSelectItem(this.searchIndex);
- this.CloseSelectionWindow();
- this.DOMSearchField().focus();
- }
- return false;
- }
-
- // --------- Actions
-
- // Closes the results window.
- this.CloseResultsWindow = function()
- {
- this.DOMPopupSearchResultsWindow().style.display = 'none';
- this.DOMSearchClose().style.display = 'none';
- this.Activate(false);
- }
-
- this.CloseSelectionWindow = function()
- {
- this.DOMSearchSelectWindow().style.display = 'none';
- }
-
- // Performs a search.
- this.Search = function()
- {
- this.keyTimeout = 0;
-
- // strip leading whitespace
- var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
-
- var code = searchValue.toLowerCase().charCodeAt(0);
- var hexCode;
- if (code<16)
- {
- hexCode="0"+code.toString(16);
- }
- else
- {
- hexCode=code.toString(16);
- }
-
- var resultsPage;
- var resultsPageWithSearch;
- var hasResultsPage;
-
- if (indexSectionsWithContent[this.searchIndex].charAt(code-32) == '1')
- {
- resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
- resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
- hasResultsPage = true;
- }
- else // nothing available for this search term
- {
- resultsPage = this.resultsPath + '/nomatches.html';
- resultsPageWithSearch = resultsPage;
- hasResultsPage = false;
- }
-
- window.frames.MSearchResults.location.href = resultsPageWithSearch;
- var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
-
- if (domPopupSearchResultsWindow.style.display!='block')
- {
- var domSearchBox = this.DOMSearchBox();
- this.DOMSearchClose().style.display = 'inline';
- if (this.insideFrame)
- {
- var domPopupSearchResults = this.DOMPopupSearchResults();
- domPopupSearchResultsWindow.style.position = 'relative';
- domPopupSearchResultsWindow.style.display = 'block';
- var width = document.body.clientWidth - 8; // the -8 is for IE :-(
- domPopupSearchResultsWindow.style.width = width + 'px';
- domPopupSearchResults.style.width = width + 'px';
- }
- else
- {
- var domPopupSearchResults = this.DOMPopupSearchResults();
- var left = getXPos(domSearchBox) + domSearchBox.offsetWidth;
- var top = getYPos(domSearchBox) + domSearchBox.offsetHeight + 1;
- domPopupSearchResultsWindow.style.display = 'block';
- left -= domPopupSearchResults.offsetWidth;
- domPopupSearchResultsWindow.style.top = top + 'px';
- domPopupSearchResultsWindow.style.left = left + 'px';
- }
- }
-
- this.lastSearchValue = searchValue;
- this.lastResultsPage = resultsPage;
- }
-
- // -------- Activation Functions
-
- // Activates or deactivates the search panel, resetting things to
- // their default values if necessary.
- this.Activate = function(isActive)
- {
- if (isActive || // open it
- this.DOMPopupSearchResultsWindow().style.display == 'block'
- )
- {
- this.DOMSearchBox().className = 'MSearchBoxActive';
-
- var searchField = this.DOMSearchField();
-
- if (searchField.value == this.searchLabel) // clear "Search" term upon entry
- {
- searchField.value = '';
- this.searchActive = true;
- }
- }
- else if (!isActive) // directly remove the panel
- {
- this.DOMSearchBox().className = 'MSearchBoxInactive';
- this.DOMSearchField().value = this.searchLabel;
- this.searchActive = false;
- this.lastSearchValue = ''
- this.lastResultsPage = '';
- }
- }
-}
-
-// -----------------------------------------------------------------------
-
-// The class that handles everything on the search results page.
-function SearchResults(name)
-{
- // The number of matches from the last run of .
- this.lastMatchCount = 0;
- this.lastKey = 0;
- this.repeatOn = false;
-
- // Toggles the visibility of the passed element ID.
- this.FindChildElement = function(id)
- {
- var parentElement = document.getElementById(id);
- var element = parentElement.firstChild;
-
- while (element && element!=parentElement)
- {
- if (element.nodeName == 'DIV' && element.className == 'SRChildren')
- {
- return element;
- }
-
- if (element.nodeName == 'DIV' && element.hasChildNodes())
- {
- element = element.firstChild;
- }
- else if (element.nextSibling)
- {
- element = element.nextSibling;
- }
- else
- {
- do
- {
- element = element.parentNode;
- }
- while (element && element!=parentElement && !element.nextSibling);
-
- if (element && element!=parentElement)
- {
- element = element.nextSibling;
- }
- }
- }
- }
-
- this.Toggle = function(id)
- {
- var element = this.FindChildElement(id);
- if (element)
- {
- if (element.style.display == 'block')
- {
- element.style.display = 'none';
- }
- else
- {
- element.style.display = 'block';
- }
- }
- }
-
- // Searches for the passed string. If there is no parameter,
- // it takes it from the URL query.
- //
- // Always returns true, since other documents may try to call it
- // and that may or may not be possible.
- this.Search = function(search)
- {
- if (!search) // get search word from URL
- {
- search = window.location.search;
- search = search.substring(1); // Remove the leading '?'
- search = unescape(search);
- }
-
- search = search.replace(/^ +/, ""); // strip leading spaces
- search = search.replace(/ +$/, ""); // strip trailing spaces
- search = search.toLowerCase();
- search = convertToId(search);
-
- var resultRows = document.getElementsByTagName("div");
- var matches = 0;
-
- var i = 0;
- while (i < resultRows.length)
- {
- var row = resultRows.item(i);
- if (row.className == "SRResult")
- {
- var rowMatchName = row.id.toLowerCase();
- rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
-
- if (search.length<=rowMatchName.length &&
- rowMatchName.substr(0, search.length)==search)
- {
- row.style.display = 'block';
- matches++;
- }
- else
- {
- row.style.display = 'none';
- }
- }
- i++;
- }
- document.getElementById("Searching").style.display='none';
- if (matches == 0) // no results
- {
- document.getElementById("NoMatches").style.display='block';
- }
- else // at least one result
- {
- document.getElementById("NoMatches").style.display='none';
- }
- this.lastMatchCount = matches;
- return true;
- }
-
- // return the first item with index index or higher that is visible
- this.NavNext = function(index)
- {
- var focusItem;
- while (1)
- {
- var focusName = 'Item'+index;
- focusItem = document.getElementById(focusName);
- if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
- {
- break;
- }
- else if (!focusItem) // last element
- {
- break;
- }
- focusItem=null;
- index++;
- }
- return focusItem;
- }
-
- this.NavPrev = function(index)
- {
- var focusItem;
- while (1)
- {
- var focusName = 'Item'+index;
- focusItem = document.getElementById(focusName);
- if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
- {
- break;
- }
- else if (!focusItem) // last element
- {
- break;
- }
- focusItem=null;
- index--;
- }
- return focusItem;
- }
-
- this.ProcessKeys = function(e)
- {
- if (e.type == "keydown")
- {
- this.repeatOn = false;
- this.lastKey = e.keyCode;
- }
- else if (e.type == "keypress")
- {
- if (!this.repeatOn)
- {
- if (this.lastKey) this.repeatOn = true;
- return false; // ignore first keypress after keydown
- }
- }
- else if (e.type == "keyup")
- {
- this.lastKey = 0;
- this.repeatOn = false;
- }
- return this.lastKey!=0;
- }
-
- this.Nav = function(evt,itemIndex)
- {
- var e = (evt) ? evt : window.event; // for IE
- if (e.keyCode==13) return true;
- if (!this.ProcessKeys(e)) return false;
-
- if (this.lastKey==38) // Up
- {
- var newIndex = itemIndex-1;
- var focusItem = this.NavPrev(newIndex);
- if (focusItem)
- {
- var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
- if (child && child.style.display == 'block') // children visible
- {
- var n=0;
- var tmpElem;
- while (1) // search for last child
- {
- tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
- if (tmpElem)
- {
- focusItem = tmpElem;
- }
- else // found it!
- {
- break;
- }
- n++;
- }
- }
- }
- if (focusItem)
- {
- focusItem.focus();
- }
- else // return focus to search field
- {
- parent.document.getElementById("MSearchField").focus();
- }
- }
- else if (this.lastKey==40) // Down
- {
- var newIndex = itemIndex+1;
- var focusItem;
- var item = document.getElementById('Item'+itemIndex);
- var elem = this.FindChildElement(item.parentNode.parentNode.id);
- if (elem && elem.style.display == 'block') // children visible
- {
- focusItem = document.getElementById('Item'+itemIndex+'_c0');
- }
- if (!focusItem) focusItem = this.NavNext(newIndex);
- if (focusItem) focusItem.focus();
- }
- else if (this.lastKey==39) // Right
- {
- var item = document.getElementById('Item'+itemIndex);
- var elem = this.FindChildElement(item.parentNode.parentNode.id);
- if (elem) elem.style.display = 'block';
- }
- else if (this.lastKey==37) // Left
- {
- var item = document.getElementById('Item'+itemIndex);
- var elem = this.FindChildElement(item.parentNode.parentNode.id);
- if (elem) elem.style.display = 'none';
- }
- else if (this.lastKey==27) // Escape
- {
- parent.searchBox.CloseResultsWindow();
- parent.document.getElementById("MSearchField").focus();
- }
- else if (this.lastKey==13) // Enter
- {
- return true;
- }
- return false;
- }
-
- this.NavChild = function(evt,itemIndex,childIndex)
- {
- var e = (evt) ? evt : window.event; // for IE
- if (e.keyCode==13) return true;
- if (!this.ProcessKeys(e)) return false;
-
- if (this.lastKey==38) // Up
- {
- if (childIndex>0)
- {
- var newIndex = childIndex-1;
- document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
- }
- else // already at first child, jump to parent
- {
- document.getElementById('Item'+itemIndex).focus();
- }
- }
- else if (this.lastKey==40) // Down
- {
- var newIndex = childIndex+1;
- var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
- if (!elem) // last child, jump to parent next parent
- {
- elem = this.NavNext(itemIndex+1);
- }
- if (elem)
- {
- elem.focus();
- }
- }
- else if (this.lastKey==27) // Escape
- {
- parent.searchBox.CloseResultsWindow();
- parent.document.getElementById("MSearchField").focus();
- }
- else if (this.lastKey==13) // Enter
- {
- return true;
- }
- return false;
- }
-}
diff --git a/manual/docs/html/slsDetectorUsersDocs/search/search.png b/manual/docs/html/slsDetectorUsersDocs/search/search.png
deleted file mode 100644
index 9dd2396db..000000000
Binary files a/manual/docs/html/slsDetectorUsersDocs/search/search.png and /dev/null differ
diff --git a/manual/docs/html/slsDetectorUsersDocs/search/variables_61.html b/manual/docs/html/slsDetectorUsersDocs/search/variables_61.html
deleted file mode 100644
index 1ed70dee0..000000000
--- a/manual/docs/html/slsDetectorUsersDocs/search/variables_61.html
+++ /dev/null
@@ -1,26 +0,0 @@
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
-
Loading...
-
-
Searching...
-
No Matches
-
-
slsDetectorUsers.h File Reference
-
-
slsDetectorUsers.h File Reference #include <stdint.h>
-
#include <string>
-
-
Go to the source code of this file.
-
-Classes class slsDetectorUsers Class for detector functionalitiesto embed the detector controls in the users custom interface e.g. EPICS, Lima etc. More...
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 slsDetectorUsers.h Source File
-
-
-
-
slsDetectorUsers.h Go to the documentation of this file. #ifndef SLS_DETECTOR_USERS_H
-#define SLS_DETECTOR_USERS_H
-class detectorData ;
-class multiSlsDetector;
-class multiSlsDetectorCommand;
-#include <stdint.h>
-#include <string>
-using namespace std;
-00085 class slsDetectorUsers
-public :
-slsDetectorUsers (int id =0);
-virtual ~slsDetectorUsers ();
-string getDetectorDeveloper ();
-int setOnline (int const online=-1);
-void startMeasurement ();
-int stopMeasurement ();
-int getDetectorStatus ();
-string getFilePath ();
-string setFilePath (string s);
-string getFileName ();
-string setFileName (string s);
-int getFileIndex ();
-int setFileIndex (int i);
-string getFlatFieldCorrectionDir ();
-string setFlatFieldCorrectionDir (string dir);
-string getFlatFieldCorrectionFile ();
-int setFlatFieldCorrectionFile (string fname="" );
-int enableFlatFieldCorrection (int i=-1);
-int enableCountRateCorrection (int i=-1);
-int enablePixelMaskCorrection (int i=-1);
-int enableAngularConversion (int i=-1);
-int enableWriteToFile (int i=-1);
-int setPositions (int nPos, double *pos);
-int getPositions (double *pos=NULL);
-int setDetectorSize (int x0=-1, int y0=-1, int nx=-1, int ny=-1);
-int getDetectorSize (int &x0, int &y0, int &nx, int &ny);
-int getMaximumDetectorSize (int &nx, int &ny);
-int setBitDepth (int i=-1);
-int setSettings (int isettings=-1);
-int getThresholdEnergy ();
-int setThresholdEnergy (int e_eV);
-double setExposureTime (double t=-1, bool inseconds=false );
-double setExposurePeriod (double t=-1, bool inseconds=false );
-double setDelayAfterTrigger (double t=-1, bool inseconds=false );
-setNumberOfGates (int64_t t=-1);
-setNumberOfFrames (int64_t t=-1);
-setNumberOfCycles (int64_t t=-1);
-int setTimingMode (int pol=-1);
-int readConfigurationFile (string const fname);
-int dumpDetectorSetup (string const fname);
-int retrieveDetectorSetup (string const fname);
-string getDetectorType ();
-int setReceiverMode (int n=-1);
-void registerDataCallback (int ( *userCallback)(detectorData * d, int f, int s, void *), void *pArg);
-void registerRawDataCallback (int ( *userCallback)(double * p, int n, void *), void *pArg);
-virtual void initDataset (int refresh);
-virtual void addFrame (double *data, double pos, double i0, double t, string fname, double var);
-virtual void finalizeDataset (double *a, double *v, double *e, int &np);
-int enableDataStreamingFromReceiver (int i=-1);
-getModuleFirmwareVersion ();
-getModuleSerialNumber (int imod=-1);
-getDetectorFirmwareVersion ();
-getDetectorSerialNumber ();
-getDetectorSoftwareVersion ();
-getThisSoftwareVersion ();
-void registerAcquisitionFinishedCallback (int ( *func)(double ,int , void *), void *pArg);
-void registerGetPositionCallback ( double (*func)(void *),void *arg);
-void registerConnectChannelsCallback ( int (*func)(void *),void *arg);
-void registerDisconnectChannelsCallback ( int (*func)(void *),void *arg);
-void registerGoToPositionCallback ( int (*func)(double ,void *),void *arg);
-void registerGoToPositionNoWaitCallback ( int (*func)(double ,void *),void *arg);
-void registerGetI0Callback ( double (*func)(int ,void *),void *arg);
-string putCommand (int narg, char *args[], int pos=-1);
-string getCommand (int narg, char *args[], int pos=-1);
-int setClockDivider (int value);
-int getContinuousReadoutFlag ();
-void setContinuousReadoutFlag ();
-int getStoreInRamReadoutFlag ();
-void setStoreInRamReadoutFlag ();
-int getParallelReadoutFlag ();
-void setParallelReadoutFlag ();
-int getNonParallelReadoutFlag ();
-void setNonParallelReadoutFlag ();
-int getSafeReadoutFlag ();
-void setSafeReadoutFlag ();
-int setAllTrimbits (int val);
-int setDAC (int id , int dacindex, int val);
-int getADC (int id , int adcindex);
-00650 static string runStatusType (int s){ \
-switch (s) { \
-case 0: return string("idle" ); \
-case 1: return string("error" ); \
-case 2: return string("waiting" ); \
-case 3: return string("finished" ); \
-case 4: return string("data" ); \
-case 5: return string("running" ); \
-default : return string("unknown" ); \
-00668 static int getDetectorSettings (string s){ \
-if (s=="standard" ) return 0; \
-if (s=="fast" ) return 1; \
-if (s=="highgain" ) return 2; \
-if (s=="dynamicgain" ) return 3; \
-if (s=="lowgain" ) return 4; \
-if (s=="mediumgain" ) return 5; \
-if (s=="veryhighgain" ) return 6; \
-return -1; };
-00682 static string getDetectorSettings (int s){\
-switch (s) { \
-case 0: return string("standard" );\
-case 1: return string("fast" );\
-case 2: return string("highgain" );\
-case 3: return string("dynamicgain" ); \
-case 4: return string("lowgain" ); \
-case 5: return string("mediumgain" ); \
-case 6: return string("veryhighgain" ); \
-default : return string("undefined" ); \
-00702 static string getTimingMode (int f){ \
-switch (f) { \
-case 0: return string( "auto" ); \
-case 1: return string("trigger" ); \
-case 2: return string("ro_trigger" ); \
-case 3: return string("gating" ); \
-case 4: return string("triggered_gating" ); \
-default : return string( "unknown" ); \
-00718 static int getTimingMode (string s){ \
-if (s== "auto" ) return 0; \
-if (s== "trigger" ) return 1; \
-if (s== "ro_trigger" ) return 2; \
-if (s== "gating" ) return 3; \
-if (s== "triggered_gating" ) return 4; \
-return -1; };
-private :
-#endif
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 slsReceiverUsers.h File Reference
-
-
slsReceiverUsers.h File Reference #include <stdio.h>
-
#include <stdint.h>
-
-
Go to the source code of this file.
-
-Classes class slsReceiverUsers Class for implementing the SLS data receiver in the users application. Callbacks can be defined for processing and/or saving data. More...
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 slsReceiverUsers.h Source File
-
-
-
-
slsReceiverUsers.h Go to the documentation of this file. #pragma once
-#include <stdio.h>
-#include <stdint.h>
-class slsReceiver;
-00016 class slsReceiverUsers {
-public :
-slsReceiverUsers (int argc, char *argv[], int &success);
-~slsReceiverUsers ();
-int start ();
-void stop ();
-getReceiverVersion ();
-void registerCallBackStartAcquisition (int (*func)(char * filepath, char * filename, uint64_t fileindex, uint32_t datasize, void *),void *arg);
-void registerCallBackAcquisitionFinished (void (*func)(uint64_t nf, void *),void *arg);
-void registerCallBackRawDataReady (void (*func)(uint64_t frameNumber, uint32_t expLength, uint32_t packetNumber, uint64_t bunchId, uint64_t timestamp,
-char * datapointer, uint32_t datasize, void *),void *arg);
-00075 slsReceiver* receiver ;
-
-
-
-
-Generated on 19 Sep 2017 by
-
- 1.6.1 Anna Bergamaschi
-Date: September 27, 2017
+Date: November 28, 2017
Thattil Dhanya
-2017-09-27
+2017-11-28
-
-
-
-
-
-angle, an accurate angular calibration of the detector must be performed (for details see the paper Bergamaschi, A. et al. (2010). J. Synchrotron Rad. 17, 653-668).
-
in channel number for each of the acquired patterns.
-
, the encoder position 
is fitted as a function of the peak position 
is the angular offset with respect to the diffractometer zero position,
-
is the central channel and 
is the distance of the module 
is the strip pitch of the detector.
-
sample in a 300 
m capillary with the detector shifted in 5 mdeg steps between 30.4 and 36.5 degrees. The 16 peaks acquired have been fitted with a Gaussian function plus background and the fluctuations on the fitted parameters have been calculated. The resulting average resolutions are 0.63
0.06 mdeg for the peak center and 0.22
and error, offset 
-
-
is given by the difference between the number of counts and the number of X-rays whose charge is completely collected by the strip (shown by the dotted line).
-
-
.
-
as a function of the threshold energy 
and the counts originating from photons 
:
-
is the fraction of photons which produce a charge cloud which is shared between neighboring strips (
).
-
, the number of noise counts in the acquisition time 
can be approximated as:
-
away from both the fluorescent energy level and the X-ray energy in order to remove the fluorescence background while efficiently count the diffracted photons.
-
-
and gain 
in order to correctly set its comparator threshold 
at the desired energy 
. The curves obtained for one of the detector modules at three energies are shown in figure 4. The experimental data are then fitted according to equation 1 and for each module a linear relation is found between the X-ray energy and the estimated inflection point, as shown in the inset of figure 4. The resulting offset 
and gain 
are used as a conversion factor between the threshold level and the energy.
-
-![\includegraphics[width=\textwidth]{fig4.eps}](img33.png)
![\includegraphics[width=\textwidth]{fig5.eps}](img34.png)
![\includegraphics[width=\textwidth]{fig7.eps}](img35.png)
![\includegraphics[width=\textwidth]{fig8.eps}](img36.png)
![\includegraphics[width=\textwidth]{angleFit.eps}](img18.png)
). The dotted line represents the number of photons whose charge is completely collected by a single strip.![\includegraphics[width=\textwidth]{GUI_Advanced.eps}](img37.png)
![\includegraphics[width=\textwidth]{GUI_ThresholdScan.eps}](img38.png)
![\includegraphics[width=\textwidth]{addEnergy.eps}](img39.png)
![\includegraphics[width=\textwidth]{calibrateModule.eps}](img40.png)
-
- 
- 
1.6.1
-
-
diff --git a/manual/docs/html/slsDetectorClientDocs/actions.html b/manual/docs/html/slsDetectorClientDocs/actions.html
deleted file mode 100644
index 8d962b6c3..000000000
--- a/manual/docs/html/slsDetectorClientDocs/actions.html
+++ /dev/null
@@ -1,136 +0,0 @@
-
-
-
-
-
-![[*]](file:/usr/share/latex2html/icons/crossref.png){kind=icon}
).
-