Commit bcce377e67494baa5a0174c0309599628e501f9e
Committed by
Jürgen Knödlseder
1 parent
1ba84dfa
Update help file to include/exclude new/removed parameters (#2713)
Showing
1 changed file
with
14 additions
and
3 deletions
doc/source/users/reference_manual/ctfindvar.rst
| @@ -55,8 +55,16 @@ General parameters | @@ -55,8 +55,16 @@ General parameters | ||
| 55 | ``(inmodel = NONE) [file]`` | 55 | ``(inmodel = NONE) [file]`` |
| 56 | Input model definition file for extracting source positions. | 56 | Input model definition file for extracting source positions. |
| 57 | 57 | ||
| 58 | -``histtype [string]`` | ||
| 59 | - File type for storing the individual source histograms. | 58 | +``(outcube = NONE) [file]`` |
| 59 | + Filename for saving counts cube, NONE will result in no cube being saved. | ||
| 60 | + | ||
| 61 | +``caldb [string]`` | ||
| 62 | + Calibration database (only required for IRF background subtraction if no | ||
| 63 | + response information is provided by ``inobs``). | ||
| 64 | + | ||
| 65 | +``irf [string]`` | ||
| 66 | + Instrument response function (only required for IRF background subtraction | ||
| 67 | + if no response information is provided by ``inobs``). | ||
| 60 | 68 | ||
| 61 | ``prefix [string]`` | 69 | ``prefix [string]`` |
| 62 | Output file prefix. The method will save two files: | 70 | Output file prefix. The method will save two files: |
| @@ -64,7 +72,7 @@ General parameters | @@ -64,7 +72,7 @@ General parameters | ||
| 64 | - File containing the significance as a function of time interval for each | 72 | - File containing the significance as a function of time interval for each |
| 65 | source | 73 | source |
| 66 | 74 | ||
| 67 | -``minoff [real]`` | 75 | +``(minoff = 0) [real]`` |
| 68 | Minimum number of off counts to compute the significance | 76 | Minimum number of off counts to compute the significance |
| 69 | 77 | ||
| 70 | ``emin [real]`` | 78 | ``emin [real]`` |
| @@ -75,6 +83,9 @@ General parameters | @@ -75,6 +83,9 @@ General parameters | ||
| 75 | Maximum energy (TeV) for extracting events. A value of 0 results in no cut | 83 | Maximum energy (TeV) for extracting events. A value of 0 results in no cut |
| 76 | being applied. | 84 | being applied. |
| 77 | 85 | ||
| 86 | +``(sig_thr = 4.5) [real]`` | ||
| 87 | + Significance threshold for variability detection. | ||
| 88 | + | ||
| 78 | ``(smoothkrnl = NONE) <GAUSSIAN|DISK|NONE> [string]`` | 89 | ``(smoothkrnl = NONE) <GAUSSIAN|DISK|NONE> [string]`` |
| 79 | Kernel to be used in smoothing the counts maps before computing | 90 | Kernel to be used in smoothing the counts maps before computing |
| 80 | significances. | 91 | significances. |