Supported statistical tests includes Chi-squared (X2),
Z-squared-n ( Z2N), H, and Rayleigh (Z2N with N == 1).
For
details about how each of these is computed, see pulsar_algorithm.
Known Issues: When running gtpsearch multiple times using the GUI, plot windows from previous runs reappear after they are closed manually. Thus, there is no way to permanently close plot windows without exiting the GUI.
Usage: gtpspec evfile outfile numphase numharm maxharm
| |
evfile [file name] |
| |
|
Name of input event file, FT1 format or equivalent. |
| |
|
|
| |
outfile [file name] |
| |
|
Name of output FITS file that contains a search result. If outfile is NONE, no FITS output will be created. |
| |
|
|
| |
numphase = 10 [integer] |
| |
|
Number of phase bins in each trial for the chi-squared test. This parameter only has effect if algorithm is CHI2. |
| |
|
|
| |
numharm = 10 [integer] |
| |
|
Number of harmonics in each trial for the Z2n/Rayleigh test. This parameter only has effect if algorithm is Z2N. For the Rayleigh test, set algorithm to Z2N, and set numharm to 1. |
| |
|
|
| |
maxharm = 10 [integer] |
| |
|
Maximum number of harmonics in each trial for the H test. This parameter only has effect if algorithm is H. |
| |
|
|
| |
(evtable = EVENTS) [string] |
| |
|
Name of the FITS table containing the event data. |
| |
|
|
| |
(pphasefield = PULSE_PHASE) [string] |
| |
|
Name of the output column to contain the assigned pulse phase. |
| |
|
|
| |
(plot = yes) [bool] |
| |
|
If plot is "yes", the result will be displayed in a separate plot window, and the numerical results will be output in a text screen. If plot is "no", only the text output will be displayed, and no plot window will be displayed. |
| |
|
|
| |
(title = DEFAULT) [string] |
| |
|
Title for the graph. By default a title indicating the type of test and other pertinent information will be displayed. |
| |
|
|
| |
(chatter) |
| |
|
This parameter fixes the output verbosity: no screen output (0), nominal screen output (2), maximum verbosity (4). (default: 2) |
| |
|
|
| |
(clobber = yes) |
| |
|
If true, an existing file of the same name will be overwritten. This is a hidden parameter. (default: yes) |
| |
|
|
| |
(debug = no) |
| |
|
Activate debugging mode. (default: no)
When debug is "no", all exceptions that are not caught and handled by individual tool-specific code are caught by a top-level exception handler that displays information about the exception and then exits.
When debug is "yes", such exceptions are not caught by the top level code. Instead the tool produces a segmentation violation, which is more useful for debugging. When debugging mode is enabled, the tool produces more verbose output describing any errors or exceptions that are encountered. |
| |
|
|
| |
(gui = no) |
| |
|
If "yes", the graphical user Interface (GUI) mode is activated.
(default: no) |
| |
|
|
| |
(mode = ql) |
| |
|
Mode of automatic parameters. (default: ql) |