vcstools scripts

The following scripts are provided as part of the vcstools package:

RVM_fit.py

.. _calibrate-vcs.py-label:

calibrate_vcs.py

.. _checks.py-label:

checks.py

.. _cleanup.py-label:

cleanup.py

.. _combine-calibrations.py-label:

combine_calibrations.py

.. _create-ics-psrfits.py-label:

create_ics_psrfits.py

.. _find-pulsar-in-obs.py-label:

find_pulsar_in_obs.py

.. _mwa-metadb-utils.py-label:

mwa_metadb_utils.py

Returns information on an input Obs ID

usage: mwa_metadb_utils.py [-h] [-c] obsid

positional arguments:
  obsid           Input Observation ID

pabeam.py

.. _process-vcs.py-label:

process_vcs.py

.. _prof-estimate.py-label:

prof_estimate.py

.. _recombine.py-label:

recombine.py

Combines raw VCS data

usage: recombine.py [-h] -o OBSID -s START -d DURATION [-w DATA_DIR]
                    [-p OUTPUT_BASE_DIR] [-e RECOMBINE_COMMAND]
                    [-L {DEBUG,INFO,WARNING,ERROR}] [-V]

optional arguments:
  -h, --help            show this help message and exit
  -o OBSID, --obsid OBSID
                        Input Observation ID.
  -s START, --start START
                        First GPS second of data to recombine.
  -d DURATION, --duration DURATION
                        Seconds of data to recomine
  -w DATA_DIR, --data_dir DATA_DIR
                        Directory containing the raw data
  -p OUTPUT_BASE_DIR, --output_base_dir OUTPUT_BASE_DIR
                        The base directory to put the recombined data. Eg
                        /astro/mwavcs/<USER>/<obsid>.
  -e RECOMBINE_COMMAND, --recombine_command RECOMBINE_COMMAND
                        the filename of the recombine function. Default:
                        recombine
  -L {DEBUG,INFO,WARNING,ERROR}, --loglvl {DEBUG,INFO,WARNING,ERROR}
                        Logger verbosity level. Default: INFO
  -V, --version         Print version and quit

rename_corr_output.py

.. _reorder-chans.py-label:

reorder_chans.py

.. _rm-synthesis.py-label:

rm_synthesis.py

.. _rts2ao.py-label:

rts2ao.py

rts2ao.py is a tool for converting an RTS solution to an Offringa-style solution.

usage: rts2ao.py [-h] [-d DIR] [-m METAFITS] [-r RTS_GLOB] [-o OUTFILE]
                 [-L {DEBUG,INFO,WARNING}] [-V]

optional arguments:
  -h, --help            show this help message and exit
  -d DIR, --dir DIR     Directory containing RTS solution files (DI_Jones...)
                        (default: ./)
  -m METAFITS, --metafits METAFITS
                        Metafits file from which to determine antenna and
                        channel order (default: None)
  -r RTS_GLOB, --rts_glob RTS_GLOB
                        Filename globbing pattern for the RTS direction
                        independent solution files (default:
                        DI_JonesMatrices_node[0-9]*.dat)
  -o OUTFILE, --outfile OUTFILE
                        Name of the file to write (default:
                        calibration_solution.bin)
  -L {DEBUG,INFO,WARNING}, --loglvl {DEBUG,INFO,WARNING}
                        Logger verbosity level. Default: INFO (default: INFO)
  -V, --version         Print version and quit (default: False)

sn_flux_est.py

.. _splice-wrapper.py-label:

splice_wrapper.py

Wraps the splice_psrfits.sh script to automate it. Should be run from the foulder containing the files.

usage: splice_wrapper.py [-h] [-o OBSERVATION] [-i] [-d] [-w WORK_DIR]
                         [-c CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS]

optional arguments:
  -h, --help            show this help message and exit
  -o OBSERVATION, --observation OBSERVATION
                        The observation ID to be used.
  -i, --incoh           Use this check if there are and incoh files from the
                        beamformer.
  -d, --delete          This will cause the script to remove the unspliced
                        files if splice_psrfits.sh succeeds (error code of 0).
  -w WORK_DIR, --work_dir WORK_DIR
                        Working directory of the vcs files.
  -c CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS, --channels CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS CHANNELS
                        A list of the observations channel IDs for example "-c
                        109 110 111 112 113 114 115 116 117 118 119 120 121
                        122 123 124 125 126 127 128 129 130 131 132". If this
                        option is not used a metadata call will be used to
                        find the channel IDs.

submit_to_database.py

.. _upload-beams.py-label:

upload_beams.py

.. _upload-cands.py-label:

upload_cands.py

.. _upload-obsid.py-label:

upload_obsid.py

.. _zapchan.py-label:

zapchan.py

Output the correctly formated MWA band edge channels and user-defined channels to remove for aliasing/RFI excision. If no options are given, returns an empty string.

usage: zapchan.py [-h] [-N Nchan] [-C Nchan Nchan] [-Z] [-n Nedge] [-m]
                  [-z chan [chan ...]] [-r] [-p filename]
                  [-L {DEBUG,INFO,WARNING}] [-V]

optional arguments:
  -h, --help            show this help message and exit
  -N Nchan, --nchans Nchan
                        TOTAL number of frequency channels in data set.
                        Assumes 128 fine channels per coarse channel.
                        (default: None)
  -C Nchan Nchan, --n_coarse_fine Nchan Nchan
                        Number of coarse channels followed by the number of
                        fine channels per coarse channel. This options
                        overrides --nchans. (default: None)
  -Z, --zapedges        Zap the fine channel edges of the coarse channels.
                        (default: False)
  -n Nedge, --nzap Nedge
                        Number of edge channels to remove from each side of a
                        coarse channel. If given, but --zapedges is not then
                        this argument is ignored. (default: 20)
  -m, --middle          Flag the center fine channels for each coarse channel?
                        (default: False)
  -z chan [chan ...]    Individual channels to zap (default: None)
  -r, --rfifind         Output to screen the edge channels in a format
                        readable by the PRESTO rfifind routine (default:
                        False)
  -p filename, --paz filename
                        Output channels for PSRCHIVE paz routine into the
                        given file, using paz's '-k filename' option (default:
                        None)
  -L {DEBUG,INFO,WARNING}, --loglvl {DEBUG,INFO,WARNING}
                        Logger verbosity level. Default: WARNING (default:
                        WARNING)
  -V, --version         Print version and quit (default: False)