update documentation

- add option `filter` to the documentation - update `TBG_macros.cfg`
ComputationalRadiationPhysics · Apr 4, 2018 · 6d79787 · 6d79787
1 parent f307399
commit 6d79787
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/TBG_macros.cfg b/docs/TBG_macros.cfg
@@ -242,7 +242,7 @@ TBG_chargeConservation="--chargeConservation.period 100"
 # Particle calorimeter: (virtually) propagates and collects particles to infinite distance
 TBG_<species>_calorimeter="--<species>_calorimeter.period 100 --<species>_calorimeter.openingYaw 90 --<species>_calorimeter.openingPitch 30
                         --<species>_calorimeter.numBinsEnergy 32 --<species>_calorimeter.minEnergy 10 --<species>_calorimeter.maxEnergy 1000
-                        --<species>_calorimeter.logScale 1 --<species>_calorimeter.file filePrefix"
+                        --<species>_calorimeter.logScale 1 --<species>_calorimeter.file filePrefix --<species>_calorimeter.filter all"
 
 # Resource log: log resource information to streams or files
 # set the resources to log by --resourceLog.properties [rank, position, currentStep, particleCount, cellCount]

diff --git a/docs/source/usage/plugins/particleCalorimeter.rst b/docs/source/usage/plugins/particleCalorimeter.rst
@@ -32,6 +32,7 @@ PIConGPU command line option       Description
 ``--ph_calorimeter.period``        The ouput periodicity of the plugin.
                                    A value of ``100`` would mean an output at simulation time step *0, 100, 200, ...*.
 ``--ph_calorimeter.file``          Output file prefix. Files will be stored in the folder ``ph_calorimeter``
+``--ph_energy.filter``             Use filtered particles. All available filters will be shown with ``picongpu --help``
 ``--ph_calorimeter.numBinsYaw``    Specifies the number of bins used for the yaw axis of the calorimeter.
                                    Defaults to ``64``.
 ``--ph_calorimeter.numBinsPitch``  Specifies the number of bins used for the pitch axis of the calorimeter.
@@ -91,7 +92,7 @@ as on accelerator.
 Output
 ^^^^^^
 
-The calorimeters are stored in hdf5-files in the ``simOutput/<species>_calorimeter`` directory.
+The calorimeters are stored in hdf5-files in the ``simOutput/<species>_calorimeter/<filter>/`` directory.
 The dataset within the hdf5-file is located at ``/data/<timestep>/calorimeter``.
 Depending on whether energy binning is enabled the dataset is two or three dimensional.
 The dataset has the following attributes: