Skip to content

Commit

Permalink
Reorder optional and mandatory root parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Feb 16, 2015
1 parent 9139025 commit 6f24a19
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/phdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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``):

Expand All @@ -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,
Expand Down

0 comments on commit 6f24a19

Please sign in to comment.