Useful scripts for RACS.
Project description
RACS-tools
Useful scripts for RACS
Installation
First numpy
is required before running pip install
.
conda install numpy
# or
pip install numpy
Use the package manager pip to install RACS-tools.
pip install RACS-tools
Usage
$ beamcon_2D -h
usage: beamcon_2D [-h] [-p PREFIX] [-s SUFFIX] [-o OUTDIR]
[--conv_mode CONV_MODE] [-v] [-d] [--bmaj BMAJ]
[--bmin BMIN] [--bpa BPA] [--log LOG] [-c CUTOFF]
[-t TOLERANCE] [-e EPSILON] [-n NSAMPS]
[--ncores N_CORES | --mpi]
infile [infile ...]
Smooth a field of 2D images to a common resolution.
Names of output files are 'infile'.sm.fits
positional arguments:
infile Input FITS image(s) to smooth (can be a wildcard) - beam info must be in header.
optional arguments:
-h, --help show this help message and exit
-p PREFIX, --prefix PREFIX
Add prefix to output filenames.
-s SUFFIX, --suffix SUFFIX
Add suffix to output filenames [...sm.fits].
-o OUTDIR, --outdir OUTDIR
Output directory of smoothed FITS image(s) [same as input file].
--conv_mode CONV_MODE
Which method to use for convolution [robust].
'robust' uses the built-in, FFT-based method.
Can also be 'scipy', 'astropy', or 'astropy_fft'.
Note these other methods cannot cope well with small convolving beams.
-v, --verbose verbose output [False].
-d, --dryrun Compute common beam and stop [False].
--bmaj BMAJ Target BMAJ (arcsec) to convolve to [None].
--bmin BMIN Target BMIN (arcsec) to convolve to [None].
--bpa BPA Target BPA (deg) to convolve to [None].
--log LOG Name of beamlog file. If provided, save beamlog data to a file [None - not saved].
-c CUTOFF, --cutoff CUTOFF
Cutoff BMAJ value (arcsec) -- Blank channels with BMAJ larger than this [None -- no limit]
-t TOLERANCE, --tolerance TOLERANCE
tolerance for radio_beam.commonbeam.
-e EPSILON, --epsilon EPSILON
epsilon for radio_beam.commonbeam.
-n NSAMPS, --nsamps NSAMPS
nsamps for radio_beam.commonbeam.
--ncores N_CORES Number of processes (uses multiprocessing).
--mpi Run with MPI.
$ beamcon_3D -h
usage: beamcon_3D [-h] [--uselogs] [--mode MODE] [--conv_mode CONV_MODE] [-v]
[-d] [-p PREFIX] [-s SUFFIX] [-o OUTDIR] [--bmaj BMAJ]
[--bmin BMIN] [--bpa BPA] [-c CUTOFF] [-t TOLERANCE]
[-e EPSILON] [-n NSAMPS]
infile [infile ...]
Smooth a field of 3D cubes to a common resolution.
Names of output files are 'infile'.sm.fits
positional arguments:
infile Input FITS image(s) to smooth (can be a wildcard)
- beam info must be in co-located beamlog files.
optional arguments:
-h, --help show this help message and exit
--uselogs Get convolving information from previous run [False].
--mode MODE Common resolution mode [natural].
natural -- allow frequency variation.
total -- smooth all plans to a common resolution.
--conv_mode CONV_MODE
Which method to use for convolution [robust].
'robust' computes the analytic FT of the convolving Gaussian.
Can also be 'scipy', 'astropy', or 'astropy_fft'.
Note these other methods cannot cope well with small convolving beams.
-v, --verbose verbose output [False].
-d, --dryrun Compute common beam and stop [False].
-p PREFIX, --prefix PREFIX
Add prefix to output filenames.
-s SUFFIX, --suffix SUFFIX
Add suffix to output filenames [...{mode}.fits].
-o OUTDIR, --outdir OUTDIR
Output directory of smoothed FITS image(s) [None - same as input].
--bmaj BMAJ BMAJ to convolve to [max BMAJ from given image(s)].
--bmin BMIN BMIN to convolve to [max BMAJ from given image(s)].
--bpa BPA BPA to convolve to [0].
-c CUTOFF, --cutoff CUTOFF
Cutoff BMAJ value (arcsec) -- Blank channels with BMAJ larger than this [None -- no limit]
-t TOLERANCE, --tolerance TOLERANCE
tolerance for radio_beam.commonbeam.
-e EPSILON, --epsilon EPSILON
epsilon for radio_beam.commonbeam.
-n NSAMPS, --nsamps NSAMPS
nsamps for radio_beam.commonbeam.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
RACS-tools-1.1.1.tar.gz
(23.9 kB
view hashes)
Built Distributions
Close
Hashes for RACS_tools-1.1.1-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9e374f8546c391773619ef998f7df4e7252713534100d8c95c846b9cddb1c62 |
|
MD5 | b5ad7db7117e6de73e1f19bd6b20aa8d |
|
BLAKE2b-256 | 64003590fce92495ae5849390ca76defa582096b096c89996d6635256e100760 |
Close
Hashes for RACS_tools-1.1.1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20b3dd9b0addc3ad0f909d894150394d899c2e03c0762e2228e9d395672d03cf |
|
MD5 | 67197dfc552d6c71f7f88c27f6e88cc6 |
|
BLAKE2b-256 | 0d3e84deb441ab28f9936beed3d81323a391b9447b148d923c61a283b1eec01c |