From 6f24a19c4637fd373a14c29efac3087bd936f3aa Mon Sep 17 00:00:00 2001 From: Antonino Ingargiola Date: Mon, 16 Feb 2015 15:06:39 -0800 Subject: [PATCH] Reorder optional and mandatory root parameters --- docs/phdata.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/phdata.rst b/docs/phdata.rst index e7c7e84..a38e623 100644 --- a/docs/phdata.rst +++ b/docs/phdata.rst @@ -41,9 +41,6 @@ Mandatory parameters - **num_detectors**: (integer) Total number of detector pixels used in the measurement. -- **acquisition_time**: (float) - Measurement duration in seconds. - - **alex**: (boolean) if True (i.e. = 1), the measurements uses alternated excitation. @@ -62,13 +59,9 @@ Mandatory parameters (``alex_period_acceptor``) that selects all the photons (i.e. ``(0, alex_period)``). -Optional parameters -^^^^^^^^^^^^^^^^^^^ - -Currently, optional parameters include information necessary to +Other parameters include information necessary to interpret data acquired with alternating laser excitation (ALEX), whether μs-ALEX or ns-ALEX (aka PIE, or pulsed-interleaved excitation). -Some of those parameters are mandatory, some other are optional. **Mandatory** for μs-ALEX data (``alex == True``, ``lifetime == False``): @@ -85,6 +78,12 @@ Some of those parameters are mandatory, some other are optional. ``alex_period * tcspc_unit``. +Optional parameters +^^^^^^^^^^^^^^^^^^^ + +- **acquisition_time**: (float) + Measurement duration in seconds. + **Optional** for ALEX data: - **alex_period_donor**: (array with an even-number of elements,