Skip to content

Commit

Permalink
Removed deprecated instruments. Added start/offset options.
Browse files Browse the repository at this point in the history
  • Loading branch information
scottransom committed Jun 28, 2017
1 parent e669e04 commit c4c58c1
Show file tree
Hide file tree
Showing 32 changed files with 433 additions and 717 deletions.
28 changes: 15 additions & 13 deletions clig/mpiprepsubband.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.\" it edited by clig, remove the respective pair of cligPart-lines.
.\"
.\" cligPart TITLE
.TH "mpiprepsubband" 1 "03Jun17" "Clig-manuals" "Programmer's Manual"
.TH "mpiprepsubband" 1 "28Jun17" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end

.\" cligPart NAME
Expand All @@ -23,10 +23,6 @@ mpiprepsubband \- Converts a raw radio data file into many de-dispersed time-ser
.SH SYNOPSIS
.B mpiprepsubband
-o outfile
[-pkmb]
[-gmrt]
[-bcpm]
[-spigot]
[-filterbank]
[-psrfits]
[-noweights]
Expand All @@ -43,6 +39,8 @@ mpiprepsubband \- Converts a raw radio data file into many de-dispersed time-ser
[-runavg]
[-numout numout]
[-nobary]
[-offset offset]
[-start start]
[-lodm lodm]
[-dmstep dmstep]
[-numdms numdms]
Expand All @@ -59,14 +57,6 @@ infile ...
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
Expand Down Expand Up @@ -111,6 +101,18 @@ Output this many values. If there are not enough values in the original data fi
1 Long value between 1 and oo.
.IP -nobary
Do not barycenter the data.
.IP -offset
Number of spectra to offset into as starting data point,
.br
1 Long value between 0 and oo.
.br
Default: `0'
.IP -start
Starting point of the processing as a fraction of the full obs,
.br
1 Double value between 0.0 and 1.0.
.br
Default: `0.0'
.IP -lodm
The lowest dispersion measure to de-disperse (cm^-3 pc),
.br
Expand Down
8 changes: 4 additions & 4 deletions clig/mpiprepsubband_cmd.cli
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ Commandline full_cmd_line

String -o outfile {Root of the output file names} \
-m
Flag -pkmb pkmb {Raw data in Parkes Multibeam format}
Flag -gmrt gmrt {Raw data in GMRT Phased Array format}
Flag -bcpm bcpm {Raw data in Berkeley-Caltech Pulsar Machine (BPP) format}
Flag -spigot spigot {Raw data in Caltech-NRAO Spigot Card format}
Flag -filterbank filterbank {Raw data in SIGPROC filterbank format}
Flag -psrfits psrfits {Raw data in PSRFITS format}
Flag -noweights noweights {Do not apply PSRFITS weights}
Expand All @@ -36,6 +32,10 @@ Flag -runavg runavg {Running mean subtraction from the input data}
Long -numout 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} \
-r 1 oo
Flag -nobary nobary {Do not barycenter the data}
Long -offset offset {Number of spectra to offset into as starting data point} \
-r 0 oo -d 0
Double -start start {Starting point of the processing as a fraction of the full obs} \
-r 0.0 1.0 -d 0.0
Double -lodm lodm {The lowest dispersion measure to de-disperse (cm^-3 pc)} \
-r 0 oo -d 0
Double -dmstep dmstep {The stepsize in dispersion measure to use(cm^-3 pc)} \
Expand Down
50 changes: 21 additions & 29 deletions clig/prepdata.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.\" it edited by clig, remove the respective pair of cligPart-lines.
.\"
.\" cligPart TITLE
.TH "prepdata" 1 "03Jun17" "Clig-manuals" "Programmer's Manual"
.TH "prepdata" 1 "28Jun17" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end

.\" cligPart NAME
Expand All @@ -24,27 +24,23 @@ prepdata \- Prepares a raw data file for pulsar searching or folding (conversion
.B prepdata
[-ncpus ncpus]
-o outfile
[-pkmb]
[-gmrt]
[-bcpm]
[-spigot]
[-filterbank]
[-psrfits]
[-noweights]
[-noscales]
[-nooffsets]
[-wapp]
[-window]
[-numwapps numwapps]
[-if ifs]
[-clip clip]
[-noclip]
[-invert]
[-zerodm]
[-numout numout]
[-downsamp downsamp]
[-nobary]
[-shorts]
[-numout numout]
[-downsamp downsamp]
[-offset offset]
[-start start]
[-dm dm]
[-mask maskfile]
[-ignorechan ignorechanstr]
Expand All @@ -63,14 +59,6 @@ Default: `1'
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
Expand All @@ -81,16 +69,8 @@ Do not apply PSRFITS weights.
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
Expand All @@ -107,6 +87,10 @@ Do not clip the data. (The default is to _always_ clip!).
For rawdata, flip (or invert) the band.
.IP -zerodm
Subtract the mean of all channels from each sample (i.e. remove zero DM).
.IP -nobary
Do not barycenter the data.
.IP -shorts
Use short ints for the output data instead of floats.
.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
Expand All @@ -117,10 +101,18 @@ The number of neighboring bins to co-add,
1 Int value between 1 and 128.
.br
Default: `1'
.IP -nobary
Do not barycenter the data.
.IP -shorts
Use short ints for the output data instead of floats.
.IP -offset
Number of spectra to offset into as starting data point,
.br
1 Long value between 0 and oo.
.br
Default: `0'
.IP -start
Starting point of the processing as a fraction of the full obs,
.br
1 Double value between 0.0 and 1.0.
.br
Default: `0.0'
.IP -dm
The dispersion measure to de-disperse (cm^-3 pc),
.br
Expand Down
27 changes: 12 additions & 15 deletions clig/prepdata_cmd.cli
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,33 @@ Commandline full_cmd_line

# Options (in order you want them to appear)

Int -ncpus ncpus {Number of processors to use with OpenMP} \
Int -ncpus ncpus {Number of processors to use with OpenMP} \
-r 1 oo -d 1
String -o outfile {Root of the output file names} \
-m
Flag -pkmb pkmb {Raw data in Parkes Multibeam format}
Flag -gmrt gmrt {Raw data in GMRT Phased Array format}
Flag -bcpm bcpm {Raw data in Berkeley-Caltech Pulsar Machine (BPP) format}
Flag -spigot spigot {Raw data in Caltech-NRAO Spigot Card format}
Flag -filterbank filterbank {Raw data in SIGPROC filterbank format}
Flag -psrfits psrfits {Raw data in PSRFITS format}
Flag -noweights noweights {Do not apply PSRFITS weights}
Flag -noscales noscales {Do not apply PSRFITS scales}
Flag -nooffsets nooffsets {Do not apply PSRFITS offsets}
Flag -wapp wapp {Raw data in Wideband Arecibo Pulsar Processor (WAPP) format}
Flag -noweights noweights {Do not apply PSRFITS weights}
Flag -noscales noscales {Do not apply PSRFITS scales}
Flag -nooffsets nooffsets {Do not apply PSRFITS offsets}
Flag -window window {Window correlator lags with a Hamming window before FFTing}
Int -numwapps numwapps {Number of WAPPs used with contiguous frequencies} \
-r 1 8 -d 1
Int -if ifs {A specific IF to use if available (summed IFs is the default)} \
-r 0 1
Float -clip clip {Time-domain sigma to use for clipping (0.0 = no clipping, 6.0 = default} \
-r 0 1000.0 -d 6.0
Flag -noclip noclip {Do not clip the data. (The default is to _always_ clip!)}
Flag -invert invert {For rawdata, flip (or invert) the band}
Flag -zerodm zerodm {Subtract the mean of all channels from each sample (i.e. remove zero DM)}
Long -numout 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} \
-r 1 oo
Int -downsamp downsamp {The number of neighboring bins to co-add} \
-r 1 128 -d 1
Flag -nobary nobary {Do not barycenter the data}
Flag -shorts shorts {Use short ints for the output data instead of floats}
Long -numout 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} \
-r 1 oo
Int -downsamp downsamp {The number of neighboring bins to co-add} \
-r 1 128 -d 1
Long -offset offset {Number of spectra to offset into as starting data point} \
-r 0 oo -d 0
Double -start start {Starting point of the processing as a fraction of the full obs} \
-r 0.0 1.0 -d 0.0
Double -dm dm {The dispersion measure to de-disperse (cm^-3 pc)} \
-r 0 oo -d 0
String -mask maskfile {File containing masking information to use}
Expand Down
14 changes: 1 addition & 13 deletions clig/prepfold.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.\" it edited by clig, remove the respective pair of cligPart-lines.
.\"
.\" cligPart TITLE
.TH "prepfold" 1 "03Jun17" "Clig-manuals" "Programmer's Manual"
.TH "prepfold" 1 "28Jun17" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end

.\" cligPart NAME
Expand All @@ -24,10 +24,6 @@ prepfold \- Prepares (if required) and folds raw radio data, standard time serie
.B prepfold
[-ncpus ncpus]
[-o outfile]
[-pkmb]
[-gmrt]
[-bcpm]
[-spigot]
[-filterbank]
[-psrfits]
[-noweights]
Expand Down Expand Up @@ -116,14 +112,6 @@ Default: `1'
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
Expand Down
4 changes: 0 additions & 4 deletions clig/prepfold_cmd.cli
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ Commandline full_cmd_line
Int -ncpus ncpus {Number of processors to use with OpenMP} \
-r 1 oo -d 1
String -o outfile {Root of the output file names}
Flag -pkmb pkmb {Raw data in Parkes Multibeam format}
Flag -gmrt gmrt {Raw data in GMRT Phased Array format}
Flag -bcpm bcpm {Raw data in Berkeley-Caltech Pulsar Machine (BPP) format}
Flag -spigot spigot {Raw data in Caltech-NRAO Spigot Card format}
Flag -filterbank filterbank {Raw data in SIGPROC filterbank format}
Flag -psrfits psrfits {Raw data in PSRFITS format}
Flag -noweights noweights {Do not apply PSRFITS weights}
Expand Down
28 changes: 15 additions & 13 deletions clig/prepsubband.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.\" it edited by clig, remove the respective pair of cligPart-lines.
.\"
.\" cligPart TITLE
.TH "prepsubband" 1 "03Jun17" "Clig-manuals" "Programmer's Manual"
.TH "prepsubband" 1 "28Jun17" "Clig-manuals" "Programmer's Manual"
.\" cligPart TITLE end

.\" cligPart NAME
Expand All @@ -24,10 +24,6 @@ prepsubband \- Converts a raw radio data file into many de-dispersed time-series
.B prepsubband
[-ncpus ncpus]
-o outfile
[-pkmb]
[-gmrt]
[-bcpm]
[-spigot]
[-filterbank]
[-psrfits]
[-noweights]
Expand All @@ -46,6 +42,8 @@ prepsubband \- Converts a raw radio data file into many de-dispersed time-series
[-subdm subdm]
[-numout numout]
[-nobary]
[-offset offset]
[-start start]
[-lodm lodm]
[-dmstep dmstep]
[-numdms numdms]
Expand All @@ -69,14 +67,6 @@ Default: `1'
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
Expand Down Expand Up @@ -129,6 +119,18 @@ Output this many values. If there are not enough values in the original data fi
1 Long value between 1 and oo.
.IP -nobary
Do not barycenter the data.
.IP -offset
Number of spectra to offset into as starting data point,
.br
1 Long value between 0 and oo.
.br
Default: `0'
.IP -start
Starting point of the processing as a fraction of the full obs,
.br
1 Double value between 0.0 and 1.0.
.br
Default: `0.0'
.IP -lodm
The lowest dispersion measure to de-disperse (cm^-3 pc),
.br
Expand Down
8 changes: 4 additions & 4 deletions clig/prepsubband_cmd.cli
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ Int -ncpus ncpus {Number of processors to use with OpenMP} \
-r 1 oo -d 1
String -o outfile {Root of the output file names} \
-m
Flag -pkmb pkmb {Raw data in Parkes Multibeam format}
Flag -gmrt gmrt {Raw data in GMRT Phased Array format}
Flag -bcpm bcpm {Raw data in Berkeley-Caltech Pulsar Machine (BPP) format}
Flag -spigot spigot {Raw data in Caltech-NRAO Spigot Card format}
Flag -filterbank filterbank {Raw data in SIGPROC filterbank format}
Flag -psrfits psrfits {Raw data in PSRFITS format}
Flag -noweights noweights {Do not apply PSRFITS weights}
Expand All @@ -41,6 +37,10 @@ Double -subdm subdm {The DM to use when de-dispersing subbands for -sub} \
Long -numout 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} \
-r 1 oo
Flag -nobary nobary {Do not barycenter the data}
Long -offset offset {Number of spectra to offset into as starting data point} \
-r 0 oo -d 0
Double -start start {Starting point of the processing as a fraction of the full obs} \
-r 0.0 1.0 -d 0.0
Double -lodm lodm {The lowest dispersion measure to de-disperse (cm^-3 pc)} \
-r 0 oo -d 0
Double -dmstep dmstep {The stepsize in dispersion measure to use(cm^-3 pc)} \
Expand Down
Loading

0 comments on commit c4c58c1

Please sign in to comment.