From 9e2b765530652116b0e0592c91778715d4592a1f Mon Sep 17 00:00:00 2001
From: Rafael Gort <rafael.gort@xfel.eu>
Date: Fri, 2 Oct 2020 15:11:30 +0200
Subject: [PATCH] Updated version, removed outdated documentation.
---
VERSION | 2 +-
doc/bunch_pattern_decoding.rst | 2 +-
doc/dssc/DSSCBinner.rst | 50 ++++++----------------------------
doc/index.rst | 2 --
4 files changed, 11 insertions(+), 45 deletions(-)
diff --git a/VERSION b/VERSION
index 9686a2d..e08b7ca 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.1a3
+1.1rc1
diff --git a/doc/bunch_pattern_decoding.rst b/doc/bunch_pattern_decoding.rst
index 720e00e..48b3687 100644
--- a/doc/bunch_pattern_decoding.rst
+++ b/doc/bunch_pattern_decoding.rst
@@ -27,4 +27,4 @@
mnemonic = tb.mnemonics["bunchPatternTable"]
bpt = run.get_array(*mnemonic.values())
- bpt_is_laser = tbm.is_ppl(BPT)
+ bpt_is_laser = tbm.is_ppl(bpt)
diff --git a/doc/dssc/DSSCBinner.rst b/doc/dssc/DSSCBinner.rst
index 73cab2f..de3bee5 100644
--- a/doc/dssc/DSSCBinner.rst
+++ b/doc/dssc/DSSCBinner.rst
@@ -26,7 +26,7 @@ Bin static run
import toolbox_scs as tb
import toolbox_scs.detectors as tbdet
import toolbox_scs.detectors.dssc_plot as dssc_plot
-
+
#logging.basicConfig(level=logging.INFO)
.. code:: ipython3
@@ -77,27 +77,22 @@ Bin static run
bin_obj.get_info()
-
-
.. parsed-literal::
Frozen(SortedKeysDict({'trainId': 1, 'pulse': 2, 'x': 128, 'y': 512}))
-
.. code:: ipython3
- # bin 2 modules using the joblib module to precess the two modules
- # in parallel.
+ # bin 2 modules in parallel
mod_list = [0,15]
- binned_data = bin_obj.bin_data(chunksize=248, modules=mod_list)
+ bin_obj.bin_data(chunksize=248, modules=mod_list, filepath='./')
.. code:: ipython3
- # Save data for module 0 and 1 into
+ # Save metadata into file
fname = 'testfile.h5'
- tbdet.save_xarray(fname, binned_data, mode='w')
tbdet.save_xarray(fname, binnertrain, group='binner1', mode='a')
tbdet.save_xarray(fname, binnerpulse, group='binner2', mode='a')
@@ -109,7 +104,7 @@ bin pump-probe data
.. code:: ipython3
- # settings that change infrequently.
+ # run settings
proposal_nb = 2212
run_nb = 235
@@ -121,20 +116,11 @@ bin pump-probe data
.. code:: ipython3
- bin_obj = tbdet.DSSCBinner(proposal_nb, run_nb, use_xgm=True)
-
-.. code:: ipython3
-
- # optional: plot xgm statistics.
- dssc_plot.plot_xgm_threshold(bin_obj.xgm,run_nr=run_nb)
-
-
-.. image:: xgm_threshold.png
-
+ bin_obj = tbdet.DSSCBinner(proposal_nb, run_nb)
.. code:: ipython3
- # define bins (buckets)
+ # define buckets
buckets_trainId = (tb.get_array(run_obj, 'PP800_PhaseShifter', 0.03)).values
buckets_pulse = ['pumped', 'unpumped'] * 10
@@ -151,21 +137,6 @@ bin pump-probe data
bin_obj.add_binner('trainId', binnerTrain)
bin_obj.add_binner('pulse', binnerPulse)
-.. code:: ipython3
-
- # plot binner statistics. Note that the number apply to one binner only.
-
- dssc_plot.plot_binner(binnerTrain, xname='trainId', yname='buckets train (delay positions)', run_nr=run_nb)
- dssc_plot.plot_binner_hist(binnerTrain, dname='buckets train (delay positions)', run_nr=run_nb)
-
-
-
-.. image:: plot1D.png
-
-
-
-.. image:: hist1D.png
-
.. code:: ipython3
@@ -173,17 +144,14 @@ bin pump-probe data
bin_obj.get_info()
-
-
.. parsed-literal::
Frozen(SortedKeysDict({'trainId': 271, 'pulse': 2, 'x': 128, 'y': 512}))
-
.. code:: ipython3
# bin 2 modules using the joblib module to precess the two modules
# in parallel.
-
- binned_data = bin_obj.bin_data(chunksize=248, modules=[0 1])
+
+ bin_obj.bin_data(chunksize=248, modules=mod_list, filepath='./')
diff --git a/doc/index.rst b/doc/index.rst
index 503a9bf..40949ac 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -31,8 +31,6 @@ Module index
**detectors**: detector specific routines
-**plot**: Collected plotting routines
-
**routines**: Automatized evaluations involving several instruments
**misc**: Various sub-routines and helper functions
--
GitLab