-
Notifications
You must be signed in to change notification settings - Fork 0
/
eventdft.1
146 lines (141 loc) · 3.4 KB
/
eventdft.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
.\" clig manual page template
.\" (C) 1995-2001 Harald Kirsch (kirschh@lionbioscience.com)
.\"
.\" This file was generated by
.\" clig -- command line interface generator
.\"
.\"
.\" Clig will always edit the lines between pairs of `cligPart ...',
.\" but will not complain, if a pair is missing. So, if you want to
.\" make up a certain part of the manual page by hand rather than have
.\" it edited by clig, remove the respective pair of cligPart-lines.
.\"
.\" cligPart TITLE
.TH "eventdft" 1 "2014-03-28" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end
.\" cligPart NAME
.SH NAME
eventdft \- Search the Discrete Fourier Transform of a set of TOAs for periodicities
.\" cligPart NAME end
.\" cligPart SYNOPSIS
.SH SYNOPSIS
.B eventdft
[-days]
[-mjds]
[-double]
[-iout]
[-cout]
[-nocoherent]
[-noincoherent]
[-nostatus]
[-fmin fmin]
[-fmax fmax]
[-fdotbyf fdotbyf]
[-ifs ifs]
[-mjd0 MJD0]
[-time T]
[-start startT]
[-end endT]
[-offset offset]
[-numsum numsum]
[-osamp osamp]
[-ncands ncands]
infile
.\" cligPart SYNOPSIS end
.\" cligPart OPTIONS
.SH OPTIONS
.IP -days
Events are in days since MJD0 (default is seconds).
.IP -mjds
Events are in MJDs.
.IP -double
Events are in binary double precision (default is ASCII).
.IP -iout
Send the list of freqs and incoherently summed powers to stdout.
.IP -cout
Send the list of freqs and coherently summed powers to stdout.
.IP -nocoherent
Do not sum powers coherently in the search.
.IP -noincoherent
Do not sum powers incoherently in the search.
.IP -nostatus
Do not print percent complete status to STDOUT.
.IP -fmin
Lowest freq to search (hz),
.br
1 Double value between 0 and oo.
.br
Default: `0.01'
.IP -fmax
Highest freq to search (hz),
.br
1 Double value between 0 and oo.
.br
Default: `1000.0'
.IP -fdotbyf
Frequency Derivative / Freq to apply to the events before DFTing,
.br
1 Double value.
.IP -ifs
Approx number of independent freqs in search,
.br
1 Double value between 0 and oo.
.IP -mjd0
The fiducial time (in MJD) to use as T0 (default sets T0 to the first event),
.br
1 Double value between 0 and oo.
.br
Default: `0.0'
.IP -time
The total duration in sec to accept events from the input file (default uses all events),
.br
1 Double value between 0 and oo.
.br
Default: `0.0'
.IP -start
The fraction of the way through T (beginning at MJD0) to start looking at events (default is 0.0),
.br
1 Double value between 0 and oo.
.br
Default: `0.0'
.IP -end
The fraction of the way through T (beginning at MJD0) to stop looking at events (default is 1.0),
.br
1 Double value between 0 and oo.
.br
Default: `1.0'
.IP -offset
A time offset to add to the 1st event in the same units as the events,
.br
1 Double value.
.br
Default: `0.0'
.IP -numsum
Maximum number of harmonics to sum,
.br
1 Int value between 1 and 32.
.br
Default: `8'
.IP -osamp
Factor to oversample normal (1/T) Fourier spacing,
.br
1 Int value between 1 and 1000.
.IP -ncands
Number of candidates to return,
.br
1 Int value between 1 and 1000.
.br
Default: `50'
.IP infile
File containing input events..
.\" cligPart OPTIONS end
.\" cligPart DESCRIPTION
.SH DESCRIPTION
This manual page was generated automagically by clig, the
Command Line Interface Generator. Actually the programmer
using clig was supposed to edit this part of the manual
page after
generating it with clig, but obviously (s)he didn't.
Sadly enough clig does not yet have the power to pick a good
program description out of blue air ;-(
.\" cligPart DESCRIPTION end