plugin: update PhaseSpace documentation

add option `.filter`
ComputationalRadiationPhysics · Dec 11, 2017 · 6aa6b80 · 6aa6b80
1 parent 0c0be8f
commit 6aa6b80
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 14 deletions.
diff --git a/docs/TBG_macros.cfg b/docs/TBG_macros.cfg
@@ -141,11 +141,11 @@ TBG_<species>_histogram="--<species>_energyHistogram.period 500 --<species>_ener
 # Calculate a 2D phase space
 # - requires parallel libSplash for HDF5 output
 # - momentum range in m_<species> c
-TBG_<species>_PSxpx="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space x --<species>_phaseSpace.momentum px --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
-TBG_<species>_PSxpz="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space x --<species>_phaseSpace.momentum pz --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
-TBG_<species>_PSypx="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space y --<species>_phaseSpace.momentum px --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
-TBG_<species>_PSypy="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space y --<species>_phaseSpace.momentum py --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
-TBG_<species>_PSypz="--<species>_phaseSpace.period 10 --<species>_phaseSpace.space y --<species>_phaseSpace.momentum pz --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSxpx="--<species>_phaseSpace.period 10 --<species>_phaseSpace.filter all --<species>_phaseSpace.space x --<species>_phaseSpace.momentum px --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSxpz="--<species>_phaseSpace.period 10 --<species>_phaseSpace.filter all --<species>_phaseSpace.space x --<species>_phaseSpace.momentum pz --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSypx="--<species>_phaseSpace.period 10 --<species>_phaseSpace.filter all --<species>_phaseSpace.space y --<species>_phaseSpace.momentum px --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSypy="--<species>_phaseSpace.period 10 --<species>_phaseSpace.filter all --<species>_phaseSpace.space y --<species>_phaseSpace.momentum py --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
+TBG_<species>_PSypz="--<species>_phaseSpace.period 10 --<species>_phaseSpace.filter all --<species>_phaseSpace.space y --<species>_phaseSpace.momentum pz --<species>_phaseSpace.min -1.0 --<species>_phaseSpace.max 1.0"
 
 # Write out slices of field data for every .period step
 TBG_EField_slice="--E_slice.period 100 --E_slice.fileName sliceE --E_slice.plane 2 --E_slice.slicePoint 0.5"

diff --git a/docs/source/usage/plugins/phaseSpace.rst b/docs/source/usage/plugins/phaseSpace.rst
@@ -24,15 +24,17 @@ Example for *y-pz* phase space for the *electron* species (``.cfg`` file macro):
 
 The distinct options are (assuming a species ``e`` for electrons):
 
-====================================== ========================================= ============================
+====================================== ======================================================== ============================
 Option                                 Usage                                     Unit
-====================================== ========================================= ============================
-``--e_phaseSpace.period <N>``          calculate each N steps                    *none*
-``--e_phaseSpace.space <x/y/z>``       spatial coordinate of the 2D phase space  *none*
-``--e_phaseSpace.momentum <px/py/pz>`` momentum coordinate of the 2D phase space *none*
-``--e_phaseSpace.min <ValL>``          minimum of the momentum range             :math:`m_\mathrm{species} c`
-``--e_phaseSpace.max <ValR>``          maximum of the momentum range             :math:`m_\mathrm{species} c`
-====================================== ========================================= ============================
+====================================== ======================================================== ============================
+``--e_phaseSpace.period <N>``          calculate each N steps                                   *none*
+``--e_energy.filter``                  Use filtered particles. Available filters are set up in  *none*
+                                       :ref:`particleFilters.param <usage-params-core>`.
+``--e_phaseSpace.space <x/y/z>``       spatial coordinate of the 2D phase space                 *none*
+``--e_phaseSpace.momentum <px/py/pz>`` momentum coordinate of the 2D phase space                *none*
+``--e_phaseSpace.min <ValL>``          minimum of the momentum range                            :math:`m_\mathrm{species} c`
+``--e_phaseSpace.max <ValR>``          maximum of the momentum range                            :math:`m_\mathrm{species} c`
+====================================== ======================================================== ============================
 
 Output
 ^^^^^^
@@ -58,7 +60,7 @@ The easiest way is to load the data in Python:
 
    # load data
    phase_space = PhaseSpace('/home/axel/runs/foil_001')
-   e_ps, e_ps_meta = phase_space.get('e', ps='ypy', iteration=1000)
+   e_ps, e_ps_meta = phase_space.get('e_all', ps='ypy', iteration=1000)
 
    # unit conversion from SI
    mu = 1.e6  # meters to microns