|
|||
NRAO Home > CASA > CASA Cookbook and User Reference Manual |
|
1.3.8.2 help <taskname>
Basic information on an application, including the parameters used and their defaults, can be obtained by typing pdoc task, help task, help ’task’ or task?. The pdoc task currently gives the cleanest documentation format with the smallest amount of object-oriented (programmer) output. This inline help provides a one line description of the task and then lists all parameters, a brief description of the parameter, the parameter default, an example setting the parameter and any options if there are limited allowed values for the parameter.
For example:
Imports an arbitrary number of VLA archive-format data sets into
a casa measurement set. If more than one band is present, they
will be put in the same measurement set but in a separate spectral
window. The task will handle old style and new style VLA (after
July 2007) archive data and apply the tsys to the data and to
the weights.
Keyword arguments:
archivefiles -- Name of input VLA archive file(s)
default: none. Must be supplied
example: archivefiles = ’AP314_A959519.xp1’
example: archivefiles=[’AP314_A950519.xp1’,’AP314_A950519.xp2’]
vis -- Name of output visibility file
default: none. Must be supplied.
example: vis=’NGC7538.ms’
Will not over-write existing ms of same name.
A backup flag-file version ’Original’ will be made in
vis.flagversions. See help flagmanager
bandname -- VLA Frequency band
default: => ’’ = all bands
example: bandname=’K’
Options: ’4’=48-96 MHz,’P’=298-345 MHz,’L’=1.15-1.75 GHz,
’C’=4.2-5.1 GHz,’X’=6.8-9.6 GHz,’U’=13.5-16.3 GHz,
’K’=20.8-25.8 GHz,’Q’=38-51 GHz
frequencytol -- Tolerance in frequency shift in making spectral windows
default: => 150000 (Hz). For Doppler shifted data, <10000 Hz may
may produce too many unnecessary spectral windows.
example: frequencytol = 1500000.0 (units = Hz)
project -- Project name to import from archive files:
default: ’’ => all projects in file
example: project=’AL519’
project = ’al519’ or AL519 will work. Do not include
leading zeros; project = ’AL0519’ will not work.
starttime -- Time after which data will be considered for importing
default: ’’ => all: Date must be included.
syntax: starttime = ’2003/1/31/05:05:23’
stoptime -- Time before which data will be considered for importing
default: ’’ => all: Date must be included.
syntax: stoptime = ’2003/1/31/08:05:23’
applytsys -- Apply data scaling and weight scaling by nominal
sensitivity (~Tsys)
default: True. Strongly recommended
autocorr -- import autocorrelations to ms
default: => False (no autocorrelations)
antnamescheme -- ’old’ or ’new’ antenna names.
default => ’new’ gives antnenna names
’VA04’ or ’EA13 for VLA telescopse 04 and 13 (EVLA)
’old’ gives names ’04’ or ’13’
keepblanks -- Should sources with blank names be filled into the data base
default => false. Do not fill
These scans are tipping scans (as of June 1, 2009) and should not
be filled in the visibility data set.
evlabands -- Use the EVLA’s center frequency and bandwidths for frequencies
specified via wavelength or band.
default => True.
async -- Run asynchronously
default = False; do not run asychronously
You can also get the short help for a CASA tool method by typing ’help tool.method’.
Help on built-in function subimage:
subimage(...)
Create a (sub)image from a region of the image
--- --- --- --- --- --- Parameters --- --- --- --- --- ---
outfile: Output image file name. Default is unset.
region: Region of interest. Default is whole image.
mask: OTF mask, Boolean LEL expression or mask region. Default is none.
dropdeg: Drop degenerate axes false
overwrite: Overwrite (unprompted) pre-existing output file? false
list: List informative messages to the logger true
--- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
outfile
region
mask
dropdeg = false
overwrite = false
list = true
----------------------------------------
For a full list of keywords associated with the various tools, see the CASA User Reference Manual.
More information about CASA may be found at the
CASA web page
Copyright © 2010 Associated Universities Inc., Washington, D.C.
This code is available under the terms of the GNU General Public Lincense
Home |
Contact Us |
Directories |
Site Map |
Help |
Privacy Policy |
Search