-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathprepsubband.1
171 lines (166 loc) · 4.16 KB
/
prepsubband.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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
.\" clig manual page template
.\" (C) 1995 Harald Kirsch ([email protected])
.\"
.\" 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 "prepsubband" 1 "19Aug13" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end
.\" cligPart NAME
.SH NAME
prepsubband \- Converts a raw radio data file into many de-dispersed time-series (including barycentering).
.\" cligPart NAME end
.\" cligPart SYNOPSIS
.SH SYNOPSIS
.B prepsubband
-o outfile
[-pkmb]
[-gmrt]
[-bcpm]
[-spigot]
[-filterbank]
[-psrfits]
[-noweights]
[-noscales]
[-nooffsets]
[-wapp]
[-window]
[-numwapps numwapps]
[-if ifs]
[-clip clip]
[-noclip]
[-runavg]
[-zerodm]
[-sub]
[-subdm subdm]
[-numout numout]
[-nobary]
[-DE405]
[-lodm lodm]
[-dmstep dmstep]
[-numdms numdms]
[-nsub nsub]
[-downsamp downsamp]
[-mask maskfile]
infile ...
.\" cligPart SYNOPSIS end
.\" cligPart OPTIONS
.SH OPTIONS
.IP -o
Root of the output file names,
.br
1 String value
.IP -pkmb
Raw data in Parkes Multibeam format.
.IP -gmrt
Raw data in GMRT Phased Array format.
.IP -bcpm
Raw data in Berkeley-Caltech Pulsar Machine (BPP) format.
.IP -spigot
Raw data in Caltech-NRAO Spigot Card format.
.IP -filterbank
Raw data in SIGPROC filterbank format.
.IP -psrfits
Raw data in PSRFITS format.
.IP -noweights
Do not apply PSRFITS weights.
.IP -noscales
Do not apply PSRFITS scales.
.IP -nooffsets
Do not apply PSRFITS offsets.
.IP -wapp
Raw data in Wideband Arecibo Pulsar Processor (WAPP) format.
.IP -window
Window correlator lags with a Hamming window before FFTing.
.IP -numwapps
Number of WAPPs used with contiguous frequencies,
.br
1 Int value between 1 and 8.
.br
Default: `1'
.IP -if
A specific IF to use if available (summed IFs is the default),
.br
1 Int value between 0 and 1.
.IP -clip
Time-domain sigma to use for clipping (0.0 = no clipping, 6.0 = default,
.br
1 Float value between 0 and 1000.0.
.br
Default: `6.0'
.IP -noclip
Do not clip the data. (The default is to _always_ clip!).
.IP -runavg
Running mean subtraction from the input data.
.IP -zerodm
Subtract the mean of all channels from each sample (i.e. remove zero DM).
.IP -sub
Write subbands instead of de-dispersed data.
.IP -subdm
The DM to use when de-dispersing subbands for -sub,
.br
1 Double value between 0 and 4000.0.
.br
Default: `0.0'
.IP -numout
Output this many values. If there are not enough values in the original data file, will pad the output file with the average value,
.br
1 Int value between 1 and oo.
.IP -nobary
Do not barycenter the data.
.IP -DE405
Use the DE405 ephemeris for barycentering instead of DE200 (the default).
.IP -lodm
The lowest dispersion measure to de-disperse (cm^-3 pc),
.br
1 Double value between 0 and oo.
.br
Default: `0'
.IP -dmstep
The stepsize in dispersion measure to use(cm^-3 pc),
.br
1 Double value between 0 and oo.
.br
Default: `1.0'
.IP -numdms
The number of DMs to de-disperse,
.br
1 Int value between 1 and 1000.
.br
Default: `10'
.IP -nsub
The number of sub-bands to use,
.br
1 Int value between 1 and 1024.
.br
Default: `32'
.IP -downsamp
The number of neighboring bins to co-add,
.br
1 Int value between 1 and 128.
.br
Default: `1'
.IP -mask
File containing masking information to use,
.br
1 String value
.IP infile
Input data file name. If the data is not in a known raw format, it should be a single channel of single-precision floating point data. In this case a '.inf' file with the same root filename must also exist (Note that this means that the input data file must have a suffix that starts with a period).
.\" 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