forked from scottransom/presto
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsearch_rzw.1
123 lines (114 loc) · 3.04 KB
/
search_rzw.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
.\" 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 "search_rzw" 1 "12Mar10" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end
.\" cligPart NAME
.SH NAME
search_rzw \- Searches an FFT for pulsar candidates using a Fourier domain acceleration search.
.\" cligPart NAME end
.\" cligPart SYNOPSIS
.SH SYNOPSIS
.B search_rzw
[-ncand ncand]
[-zlo zlo]
[-zhi zhi]
[-rlo rlo]
[-rhi rhi]
[-flo flo]
[-fhi fhi]
[-lobin lobin]
[-zapfile zapfile]
[-baryv baryv]
[-photon]
infile
.\" cligPart SYNOPSIS end
.\" cligPart OPTIONS
.SH OPTIONS
.IP -ncand
Number of candidates to try to return,
.br
1 Int value between 1 and 10000.
.br
Default: `100'
.IP -zlo
The low Fourier frequency derivative to search,
.br
1 Int value between -2000000 and 2000000.
.br
Default: ` -50'
.IP -zhi
The high Fourier frequency derivative to search,
.br
1 Int value between -2000000 and 2000000.
.br
Default: `50'
.IP -rlo
The lowest Fourier frequency to search,
.br
1 Int value between 0 and oo.
.br
Default: `300'
.IP -rhi
The highest Fourier frequency to search,
.br
1 Int value between 0 and oo.
.IP -flo
The lowest frequency (Hz) to search,
.br
1 Int value between 0 and oo.
.IP -fhi
The highest frequency (Hz) to search,
.br
1 Int value between 0 and oo.
.IP -lobin
The first Fourier frequency in the data file,
.br
1 Int value between 0 and oo.
.br
Default: `0'
.IP -zapfile
A file containing a list of freqs to ignore (i.e. RFI),
.br
1 String value
.IP -baryv
The earth's radial velocity component (v/c) towards the observation (used to convert topocentric birdie freqs to barycentric),
.br
1 Double value between -0.1 and 0.1.
.br
Default: `0.0'
.IP -photon
Data is poissonian so use freq 0 as power normalization.
.IP infile
Input file name (no suffix) of floating point fft data. A '.inf' file of the same name must also exist.
.\" cligPart OPTIONS end
.SH DESCRIPTION
This program searches an FFT found in the input file for pulsars using
a Fourier domain acceleration search (i.e. Ransom and Eikenberry,
2000, in prep.). The search uses a spacing of 0.5 frequency bins in
the fourier frequency (r) direction and 2 'bins' in the fdot (z)
direction.
The 'zapfile', if present, contains a list of center frequencies (Hz)
and widths (Hz), which the search routine should ignore (usually these
are known noise sources in the data). Lines beginning with '#' are
ignored. The example file would be:
# Freq(Hz) Freq-width(Hz)
.br
60.0 0.02
.br
120.0 0.01
.br
The routine outputs formatted statistics for the 'ncand' best
candidates found in the search region. The routine currently cannot
search the 'w' dimension. This may be fixed shortly.
Copyright 1999, Scott M. Ransom ([email protected])