forked from scottransom/psrfits_utils
-
Notifications
You must be signed in to change notification settings - Fork 0
/
psrfits_subband.1
124 lines (118 loc) · 2.84 KB
/
psrfits_subband.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
.\" clig manual page template
.\" (C) 1995-2004 Harald Kirsch (clig@geggus.net)
.\"
.\" 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 "psrfits_subband" 1 "17Jun16" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end
.\" cligPart NAME
.SH NAME
psrfits_subband \-
Partially de-disperse and subband PSRFITS search-mode data.
.\" cligPart NAME end
.\" cligPart SYNOPSIS
.SH SYNOPSIS
.B psrfits_subband
[-dm dm]
[-nsub nsub]
[-dstime dstime]
[-startfile startfile]
[-numfiles numfiles]
[-outbits outbits]
[-filetime filetime]
[-filelen filelen]
[-tgtstd tgtstd]
[-tgtavg tgtavg]
[-onlyI]
[-weights wgtsfile]
[-bandpass bandpassfile]
[-o outputbasename]
infile ...
.\" cligPart SYNOPSIS end
.\" cligPart OPTIONS
.SH OPTIONS
.IP -dm
Dispersion measure to use for the subband de-dispersion,
.br
1 Double value between 0.0 and 10000.0.
.br
Default: `0.0'
.IP -nsub
Number of output frequency subbands,
.br
1 Int value between 1 and 4096.
.IP -dstime
Power-of-2 number of samples to average in time,
.br
1 Int value between 1 and 128.
.br
Default: `1'
.IP -startfile
Starting file number of sequence,
.br
1 Int value between 1 and 2000.
.br
Default: `1'
.IP -numfiles
Number of files to process,
.br
1 Int value between 1 and 2000.
.IP -outbits
Number of output bits desired,
.br
1 Int value between 2 and 8.
.IP -filetime
Desired length of the resulting files in sec,
.br
1 Float value between 0.0 and 100000.0.
.IP -filelen
Desired length of the resulting files in GB,
.br
1 Float value between 0.0 and 1000.0.
.IP -tgtstd
Target stdev. If 0, set in code based on outbits,
.br
1 Float value between 0.0 and 100000.0.
.br
Default: `0.0'
.IP -tgtavg
Target avg for UNSIGNED data. If 0, set in code based on outbits,
.br
1 Float value between 0.0 and 100000.0.
.br
Default: `0.0'
.IP -onlyI
Only output total intensity data.
.IP -weights
Filename containing ASCII list of channels and weights to use,
.br
1 String value
.IP -bandpass
Filename containing ASCII list of channels, avgs, stdevs to use,
.br
1 String value
.IP -o
Basename for the output files,
.br
1 String value
.IP infile
Input file name(s) of the PSRFITs datafiles.
.\" 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