edit · history · print

Software.PulsarHunter History

Hide minor edits - Show changes to output

October 08, 2007, at 08:31 AM by mkeith -
Added lines 123-150:
Below is an example of a script which uses ph-dir2candlist to create candlists for each pointing in a survey 'tape'.
[=
#!/bin/csh

setenv PULSARHUNTER_HOME /raid1/software/pulsar/pulsarhunter/

setenv PATH ${PATH}:/raid1/software/pulsar/cvshome/pasurv/bin/linux/:/remote/dcore36_1/software/singlepulse/bin/:/raid1/software/pulsar/presto/bin/:${PULSARHUNTER_HOME}/scripts/

setenv PGPLOT_DIR /raid1/pasurv/pgplot
setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:$PGPLOT_DIR


set tapename = $1

set rootpath = "/raid1/pasurv/links/pasurv/results/"

mkdir /raid1/pasurv/links/pasurv/jreapercands/pasurv_re/$tapename

cd /raid1/pasurv/links/pasurv/jreapercands/pasurv_re/$tapename

foreach pointing (`ls -d $rootpath"/"$tapename/PA????_???`)
foreach beam (`ls $pointing`)
set extdir = `echo $pointing/$beam | sed -e 's:/raid1/pasurv/links:/packages/pulsar/links/:'`
ph-dir2candlist $pointing/$beam/ -resdir $extdir/ -dmlist /raid1/pasurv/links/pasurv/jreapercands/padmlist
end
end
=]
September 27, 2007, at 12:48 PM by mkeith - added more about ph-dir2candlist
Changed lines 114-115 from:
This makes JReaper candidate lists from directories of candidates.
to:
This makes JReaper candidate lists from directories of candidates. Note that at this point the scoring is done, therefore this can take a little while. In general the time for a single beam (say 200 cands) is not great, but if you have a lot of beams it might be best to do it as you process on the cluster (as the time is insignificant compared to the process time). If you do this, be sure to check out he -resdir option, which you can use to specify where the cands will go (as the path to the cands is in the candlist file at present). If you need to change the path at a later date, ungzip and do a text search/replace.
September 27, 2007, at 12:37 PM by mkeith -
Changed lines 112-117 from:
e.g. 'ph-view-phcf /xw' will display a new xwindow to show the phcf data.

!! ph-view-zapfile
This displays a Xwindow (or equivilent) that shows the details for the given zapfile.
To create a new zapfile, call this on a non-existing file.
to:
!! ph-dir2candlist

This makes JReaper candidate lists from directories of candidates.
Added lines 117-127:
@@ph-dir2candlist [input dir] [options]@@

Options include:
* -resdir [somedir] - which overwrites the directory that the candidates are listed as (default is the input dir specified). This is useful if you are running from a machine which sees a different disk path than the machine you will run jreaper on.
* -beamid [beamid] - which overwrites the beam name (default is to read from file)

!! ph-view-zapfile
This displays a Xwindow (or equivilent) that shows the details for the given zapfile.
To create a new zapfile, call this on a non-existing file.

!!!Usage
August 08, 2007, at 05:43 AM by mkeith -
Changed lines 132-133 from:
to:
* [[Polyco Files]].
August 08, 2007, at 05:42 AM by mkeith -
Deleted line 129:
* [[Sigproc]] time series* and multi-channel time series
Added line 135:
* [[Sigproc]] time series* and multi-channel time series
Changed lines 138-140 from:
* [[Sigproc]] time series* (.tim)

*Sigproc time series now writable as of version 1.1.0
to:
* [[EPN Format]] Files (.epn)
July 16, 2007, at 09:55 AM by 145.238.32.78 -
Changed lines 13-14 from:
!! Features and funcitonality
to:
!! Features and functionality
April 10, 2007, at 10:24 AM by mkeith -
Changed lines 9-10 from:
For known issues see [[PulsarHunterIssues]]
to:
For known issues see [[PulsarHunterIssues]] and [[PulsarHunterVersionHistory]] for the changelog
March 12, 2007, at 08:23 AM by mkeith -
Changed lines 97-98 from:

to:
* -zapfile [zapfile] Zap any candidates that match known frequencies from the zapfile.
Changed lines 100-102 from:

This will display a simple [[http://www.astro.caltech.edu/~tjp/pgplot/ | PGPLOT]] based rendering of the data in a PHCF file.
to:
This will display a Xwindow (or equivilent) showing the plot for this phcf file.
if you want to use the old pgplot plotter, use ph-pgplot-phcf.
Changed lines 103-104 from:
@@ph-view-phcf [phcf file] [PGPLOT format]@@
to:
@@pg-view-phcf [phcf file]@@

!! ph-pgplot-phcf

This will display a simple [[http://www.astro.caltech.edu/~tjp/pgplot/ | PGPLOT]] based rendering of the data in a PHCF file.

!!!Usage
@@ph-pgplot-phcf [phcf file] [PGPLOT format]@@
Changed lines 114-123 from:
to:
!! ph-view-zapfile
This displays a Xwindow (or equivilent) that shows the details for the given zapfile.
To create a new zapfile, call this on a non-existing file.

!!!Usage
@@ph-view-zapfile [zapfile]@@

Zapfiles should have the extention .zap to prevent any confusion when loading them.

Changed line 131 from:
* [[Sigproc]] seek output (.prd files)
to:
* [[Sigproc]] seek output (.prd files), including (and prefered) new headered format.
February 15, 2007, at 04:40 PM by mkeith -
Added lines 9-10:
For known issues see [[PulsarHunterIssues]]
February 08, 2007, at 10:23 AM by mkeith -
Changed lines 99-100 from:
This will display a simple [[PGPLOT | http://www.astro.caltech.edu/~tjp/pgplot/]] based rendering of the data in a PHCF file.
to:
This will display a simple [[http://www.astro.caltech.edu/~tjp/pgplot/ | PGPLOT]] based rendering of the data in a PHCF file.
February 08, 2007, at 10:18 AM by mkeith -
Changed line 26 from:
It can also take a phcf file as input, for example when re-optimising a candidate, or when using output from ph-best (detailed below).
to:
If you use ph-retune it can also take a phcf file as input, for example when re-optimising a candidate, or when using output from ph-best (detailed below).
Added lines 30-31:
Note that using '''ph-tune will remove any existing phcf file'''! Use ph-retune to re-analyse based on the previously optimized parameters.
Changed lines 33-34 from:
@@ph-tune [datafile] [outputfile] {options}@@
to:
@@ph-tune [datafile] [outputfile] {options}@@\\
@@ph-retune [datafile] [outputfile] {options}@@
Changed lines 43-44 from:
* -pdot specify the folding period derivative
* -pddot specify the folding period second derivative
to:
* -accn specify the folding accn
* -jerk specify the folding jerk (adot)
Changed lines 47-49 from:
* -usepdot Search in pdot space
* -usepddot Search in pddot space (Not fully tested)
to:
* -useaccn Search in accn space
* -usejerk Search in jerk space
Changed lines 51-52 from:
* -pdot-range Specify the range of pdot to search
* -pddot-range Specify the range of pddot to search
to:
* -accn-range Specify the range of accn to search
* -jerk-range Specify the range of jerk to search
Added lines 55-59:
* -period-step Specify the step size in period to search
* -accn-step Specify the step size in accn to search
* -jerk-step Specify the step size in jerk to search
* -dm-step Specify the step size in dm to search
Changed lines 95-96 from:
* -showaccn displays acceleration and jerk in place of pdot and pddot in the standard output.
to:

Changed line 108 from:
to:
[[#datatypes]]
February 07, 2007, at 01:53 PM by 195.248.119.124 -
Added lines 11-20:
!! Features and funcitonality

PulsarHunter currently provides a set of time domain optimisation tools. These are aimed at processing timeseries produced by
[[Sigproc]], however internaly there is no relyance on this format, and I intend to adapt it to read any useful data format (see
[[PulsarHunter#datatypes|accepted data types]]). The functionality of PulsarHunter currently is intended to be a replication of pdm that works on multiple data types, with added acceleration and jerk searching. It is intended to replace both the stand alone version of pdm and the search oriented pdmsuspectfind (with the inclusion of the ph-best script).

As of version [[JReaper]] 3.0, JReaper has also been integrated with PulsarHunter. This means that pulsarhunter can natively write candidate lists for JReaper, removing the need to manualy import candidates into JReaper. JReaper of course, also reads the PulsarHunter candidate file format.

In future new processes may be added for dedispersion and even fourier analysis (although currently Sigproc seek seems to be perfectly adiquate).
February 05, 2007, at 01:42 PM by 195.248.119.124 -
Changed line 95 from:
* [[Sigproc]] time series and multi-channel time series
to:
* [[Sigproc]] time series* and multi-channel time series
Changed lines 102-105 from:
* [[JReaper]] CandList files (.clist) - These are jreaper's index of candidates
to:
* [[JReaper]] CandList files (.clist) - These are jreaper's index of candidates
* [[Sigproc]] time series* (.tim)

*Sigproc time series now writable as of version 1.1.0
January 31, 2007, at 06:27 AM by mkeith -
Changed lines 3-4 from:
Pulsarhunter is a package of useful tools for searching for and confirming pulsars. Here is a list of the available scripts with usage and some basic help.
to:
Pulsarhunter is a package of useful tools for searching for and confirming pulsars. Here is a list of the available scripts with usage and some basic help. (Please update if you have any good hints/tips).
January 31, 2007, at 06:26 AM by mkeith -
Changed lines 14-19 from:
to:
It takes input from one of the [[PulsarHunter#datatypes|accepted data types]] and produces a phcf file and, if the pgplot libaries are available, a postscript plot.

It can also take a phcf file as input, for example when re-optimising a candidate, or when using output from ph-best (detailed below).
If the phcf to be created file exists, it will use the optimized parameters (i.e. the result of the last process) as the default input parameters.
Any user specified parameters will overwrite the new ones. To force creation of a fresh file, simply delete or rename the phcf file.
Changed lines 52-54 from:
to:
It will only work if filterbank and dedisperse are in your $PATH. It will create a default, 4-channel, subbanded timeseries called {file}.sub, and use this
if it is available.
Added lines 64-66:
The output will be a series of PHCF files (one per candidate) and a single .lis file that gives a simple table between the PHCF files and the best parameters.
For ease of using in scripts, there is no headers on the table, the format is the same as the standard output from ph-best.
January 31, 2007, at 05:40 AM by mkeith -
Added lines 7-8:
For installation details and how to download, see: [[PulsarHunterInstallation]]
January 31, 2007, at 05:38 AM by mkeith -
Changed line 89 from:
* [[PulsarHunter Candidate File] (.phcf)]] files - These are pulsarhunter native candidate files
to:
* [[PulsarHunter Candidate File]] (.phcf) files - These are pulsarhunter native candidate files
January 31, 2007, at 05:37 AM by mkeith -
Changed lines 3-4 from:
Pulsarhunter is a package of useful tools for searching for and confirming pulsars.
to:
Pulsarhunter is a package of useful tools for searching for and confirming pulsars. Here is a list of the available scripts with usage and some basic help.

For more details on the inner workings of pulsarhunter, see [[PulsarHunterDetails]]
Changed lines 67-68 from:
!! ph-
to:
!! ph-view-phcf

This will display a simple [[PGPLOT | http://www.astro.caltech.edu/~tjp/pgplot/]] based rendering of the data in a PHCF file.

!!!Usage
@@ph-view-phcf [phcf file] [PGPLOT format]@@

e.g. 'ph-view-phcf /xw' will display a new xwindow to show the phcf data.

January 31, 2007, at 05:34 AM by mkeith -
Changed lines 5-6 from:
to:
(:toc Contents:)
Changed lines 12-13 from:
ph-tune [datafile] [outputfile] {options}
to:
@@ph-tune [datafile] [outputfile] {options}@@
Changed lines 17-18 from:
options include:
to:
Options:
Changed lines 40-48 from:
to:
!! ph-pdm

This is a derivitive of the ph-tune script that calls [[Sigproc]] filterbank and dedisperse to allow easy use of .dat/.hdr files from Parkes.

!!!Usage
@@ph-pdm [.dat file] [root of output] [dm] {options}@@

Options are the same as ph-tune.
Added lines 53-66:
!!!Usage
@@ph-best [prd file] [output file root] {options}@@

'prd file' is the output file from seek
'output file root' the root of the output files, these will be {root}_001.phcf, {root}_002.phcf,... as well as a summary file {root}.lis

Options:

* -minsnr do not return candidates with signal to noise lower than that specified (default 7.0)
* -maxresults limit the max results to this value (default 999)
* -showaccn displays acceleration and jerk in place of pdot and pddot in the standard output.

!! ph-
January 31, 2007, at 05:27 AM by mkeith -
Added lines 10-39:
!!!Usage
ph-tune [datafile] [outputfile] {options}

'datafile' should be one of the accepted input files.
'outputfile' is the stem of the produces PHCF file and the associated postscript plot.

options include:

* -period specify the folding period
* -bary-period specify the folding period in a barycentric coordinate system
* -pdot specify the folding period derivative
* -pddot specify the folding period second derivative
* -dm specify the folding dm (for multi-channel data)

* -usepdot Search in pdot space
* -usepddot Search in pddot space (Not fully tested)

* -period-range Specify the range of periods to search
* -pdot-range Specify the range of pdot to search
* -pddot-range Specify the range of pddot to search
* -dm-range Specify the range of dm to search

* -nsub specify the number of sub-integrations to use
* -nbins specify the number of bins in the output profile

* -isub specify a comma separated list of sub-integrations to ignore
* -ibands specify a comma separated list of channels to ignore
* -iloudsints automatically try to guess the loud sub-integrations to ignore

January 31, 2007, at 05:03 AM by mkeith -
Added lines 1-27:
!PulsarHunter

Pulsarhunter is a package of useful tools for searching for and confirming pulsars.


!! ph-tune

ph-tune is the basic time domain optimization script in pulsarhunter.

!! ph-best

ph-best works in a similar way to [[Sigproc]] best. It takes a list of periods from seek (the sigproc FFT software) and returns the top candidates, with best dm/pdot/pddot, as well as signal to noise lists for these parameters.

!!Supported data formats

!!! Read only

Currently these data types are not writable. It is intended that they will be writable when any data manipulation part of the software is completed.

* [[Sigproc]] time series and multi-channel time series
* [[Sigproc]] seek output (.prd files)
* [[Presto]] time series

!!! Read/Write

* [[PulsarHunter Candidate File] (.phcf)]] files - These are pulsarhunter native candidate files
* [[JReaper]] CandList files (.clist) - These are jreaper's index of candidates
edit · history · print
Page last modified on October 08, 2007, at 08:31 AM