NRAO Home > CASA > CASA Cookbook and User Reference Manual

1.4.1 What Tasks are Available?

As mentioned in the introduction, tasks in CASA are python interfaces to the more basic toolkit. Tasks are executed to perform a single job, such as loading, plotting, flagging, calibrating, and imaging the data.

Basic information on tasks, including the parameters used and their defaults, can be obtained by typing help <taskname> or <taskname>? at the CASA prompt, where <taskname> is the name of a given task. As described above in § 1.3.8.2, help <taskname> provides a 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.

To see what tasks are available in CASA, use tasklist, e.g.

CASA <6>: tasklist  
--------> tasklist()  
Available tasks, organized by category (experimental tasks in parens ()  
  deprecated tasks in curly brackets {}).  
 
 
Import/export       Information         Editing             Manipulation  
------------------  ------------------  ------------------  ------------------  
exportasdm          imhead              fixplanets          concat  
exportfits          imstat              fixvis              conjugatevis  
exportuvfits        imval               flagautocorr        cvel  
importasdm          listcal             flagcmd             fixvis  
importfits          listfits            flagdata            hanningsmooth  
importfitsidi       listhistory         flagmanager         imhead  
importuvfits        listobs             msview              msmoments  
importvla           listvis             oldflagcmd          plotms  
(importevla)        plotms              plotms              plotxy  
(importgmrt)        plotuv              plotxy              split  
                    plotxy              tflagdata           testconcat  
                    vishead             (flagdata2)         uvcontsub  
                    visstat             (testautoflag)      vishead  
                    (asdmsummary)                           (statwt)  
                    (listsdm)                               (uvcontsub3)  
                                                            {uvcontsub2}  
 
Calibration         Modeling            Imaging             Analysis  
------------------  ------------------  ------------------  ------------------  
accum               predictcomp         clean               imcollapse  
applycal            setjy               deconvolve          imcontsub  
bandpass            uvcontsub           feather             imfit  
blcal               uvmodelfit          ft                  imhead  
calstat             uvsub               imcontsub           immath  
clearcal            (uvcontsub3)        (boxit)             immoments  
delmod              {uvcontsub2}        (csvclean)          impbcor  
fixplanets                              {mosaic}            imregrid  
fluxscale                               {widefield}         imsmooth  
ft                                                          imstat  
gaincal                                                     imtrans  
gencal                                                      imval  
listcal                                                     listvis  
plotants                                                    slsearch  
plotcal                                                     splattotable  
polcal                                                      (specfit)  
predictcomp  
setjy  
smoothcal  
uvmodelfit  
uvsub  
wvrgcal  
 
Visualization       Simulation          Single dish         Utility  
------------------  ------------------  ------------------  ------------------  
clearplot           simanalyze          asap_init           browsetable  
imview              simdata             sdbaseline          caltabconvert  
msview              simobserve          sdcal               clearplot  
plotants                                sdcoadd             clearstat  
plotcal                                 sdfit               concat  
plotms                                  sdflag              conjugatevis  
plotuv                                  sdflagmanager       find  
plotxy                                  sdgrid              help par.parameter  
viewer                                  sdimaging           help taskname  
(plotweather)                           sdimprocess         imview  
                                        sdlist              msview  
                                        sdmath              plotms  
                                        sdplot              rmtables  
                                        sdreduce            startup  
                                        sdsave              taskhelp  
                                        sdscale             tasklist  
                                        sdsmooth            testconcat  
                                        sdstat              toolhelp  
                                        sdtpimaging  
 
User defined tasks  
------------------  

The tasks with name in parentheses are experimental, those in curly brackets are deprecated and will be removed in future releases. The functionality of deprecated tasks is usually available in some other task (e.g., instead of mosaic one should use clean). In the above case, the user has not defined any task him/herself.

Typing taskhelp provides a one line description of all available tasks.

CASA <7>: taskhelp  
--------> taskhelp()  
Available tasks:  
 
accum         : Accumulate incremental calibration solutions into a calibration table  
applycal      : Apply calibrations solutions(s) to data  
asdmsummary   : Summarized description of an ASDM dataset.  
autoclean     : CLEAN an image with automatically-chosen clean regions.  
bandpass      : Calculates a bandpass calibration solution  
blcal         : Calculate a baseline-based calibration solution (gain or bandpass)  
boxit         : Box regions in image above given threshold value.  
browsetable   : Browse a table (MS, calibration table, image)  
calstat       : Displays statistical information on a calibration table  
caltabconvert : Convert old-style caltables into new-style caltables.  
 
clean         : Invert and deconvolve images with selected algorithm  
clearcal      : Re-initializes the calibration for a visibility data set  
clearplot     : Clear the matplotlib plotter and all layers  
clearstat     : Clear all autolock locks  
concat        : Concatenate several visibility data sets.  
conjugatevis  : Change the sign of the phases in all visibility columns.  
csvclean      : This task does an invert of the visibilities and deconvolve in the image plane.  
cvel          : regrid an MS to a new spectral window / channel structure or frame  
deconvolve    : Image based deconvolver  
delmod        : Deletes model representations in the MS  
exportasdm    : Convert a CASA visibility file (MS) into an ALMA Science Data Model  
exportfits    : Convert a CASA image to a FITS file  
exportuvfits  : Convert a CASA visibility data set to a UVFITS file:  
feather       : Combine two images using their Fourier transforms  
find          : Find string in tasks, task names, parameter names:  
fixplanets    : Changes FIELD and SOURCE table entries based on user given direction or POINTING table, optionally fixes the UVW coordinates  
fixvis        : Recalculates (u, v, w) and/or changes Phase Center  
flagautocorr  : Flag autocorrelations  
flagcmd       : Flagging task based on batches of flag-commands  
flagdata      :  
 ******* THIS TASK IS OBSOLETE AND WILL BE DEPRECATED *******  
 *******            USE THE TASK tflagdata            *******  
  All purpose flagging task based on selections  
flagdata2     :  
 ******* THIS TASK IS OBSOLETE AND WILL BE DEPRECATED *******  
 *******            USE THE TASK tflagdata            *******  
  All purpose flagging task based on selections. It allows the combination of several modes.  
flagmanager   : Enable list, save, restore, delete and rename flag version files.  
fluxscale     : Bootstrap the flux density scale from standard calibrators  
ft            : Insert a source model into the MODEL_DATA column of a visibility set:  
gaincal       : Determine temporal gains from calibrator observations  
gencal        : Specify Calibration Values of Various Types  
hanningsmooth : Hanning smooth frequency channel data to remove Gibbs ringing  
imcollapse    : Collapse image along one axis, aggregating pixel values along that axis.  
imcontsub     : Estimates and subtracts continuum emission from an image cube  
imfit         : Fit one or more elliptical Gaussian components on an image region(s)  
imhead        : List, get and put image header parameters  
immath        : Perform math operations on images  
immoments     : Compute moments from an image  
impbcor       : Construct a primary beam corrected image from an image and a primary beam pattern.  
importasdm    : Convert an ALMA Science Data Model observation into a CASA visibility file (MS) or single-dish data format (Scantable)  
importevla    : Convert an Science Data Model observation into a CASA Measurement Set  
importfits    : Convert an image FITS file into a CASA image  
importfitsidi : Convert a FITS-IDI file to a CASA visibility data set  
importgmrt    : Convert a UVFITS file to a CASA visibility data set  
importuvfits  : Convert a UVFITS file to a CASA visibility data set  
importvla     : Import VLA archive file(s) to a measurement set  
imregrid      : regrid an image onto a template image  
imsmooth      : Smooth an image or portion of an image  
imstat        : Displays statistical information from an image or image region  
imtrans       : Reorder image axes  
imval         : Get the data value(s) and/or mask value in an image.  
imview        : View an image  
listcal       : List antenna gain solutions  
listfits      : List the HDU and typical data rows of a fits file:  
listhistory   : List the processing history of a dataset:  
listobs       : List the summary of a data set in the logger or in a file  
listsdm       : Lists observation information present in an SDM directory.  
listvis       : List measurement set visibilities.  
mosaic        : Create a multi-field deconvolved image with selected algorithm  
msmoments     : Compute moments from an MS  
msview        : View a visibility data set  
oldflagcmd    : Flagging task based on flagging commands  
partition     : Experimental extension of split to produce multi-MSs  
pclean        : Invert and deconvolve images with parallel engines  
peel          : Do direction dependent selfcal(s) and optionally remove annoying sources.  
plotants      : Plot the antenna distribution in the local reference frame:  
plotcal       : An all-purpose plotter for calibration results  
plotms        : A plotter/interactive flagger for visibility data.  
plotuv        : Plot the baseline distribution  
plotweather   : Plot elements of the weather table; estimate opacity.  
plotxy        : An X-Y plotter/interactive flagger for visibility data.  
polcal        : Determine instrumental polarization calibrations  
predictcomp   : Make a component list for a known calibrator  
rmtables      :  
sdbaseline    : ASAP SD task: fit/subtract a spectral baseline  
sdcal         : ASAP SD task: do data selection, calibration, and averaging  
sdcoadd       : ASAP SD task: coadd multiple scantables into one  
sdfit         : ASAP SD task: fit a spectral line  
sdflag        : ASAP SD spectral flagging task  
sdflagmanager : ASAP SD task: enable list, save, restore, delete and rename flag version files  
sdgrid        : SD task: gridding single dish data  
sdimaging     : SD task: imaging for total power and spectral data  
sdimprocess   : SD task: task for single-dish image processing  
sdlist        : ASAP SD task: list summary of single dish data  
sdmath        : ASAP SD task: do simple arithmatic (subtraction, addition, multiplication, and division) for spectra  
sdplot        : ASAP SD plotting task  
sdreduce      : ASAP SD task: do sdcal, sdsmooth, and sdbaseline in one task  
sdsave        : ASAP SD task: save the sd spectra in various format  
sdscale       : ASAP SD task: scale the sd spectra  
sdsmooth      : ASAP SD task: do smoothing of spectra  
sdstat        : ASAP SD task: list statistics of spectral region  
sdtpimaging   : SD task: do a simple calibration and imaging for total power data  
setjy         : Fills the model column with the visibilities of a calibrator  
simanalyze    : image and analyze simulated datasets  
simdata       : mosaic simulation task:  
simobserve    : mosaic simulation task:  
slsearch      : Search a spectral line table.  
smoothcal     : Smooth calibration solution(s) derived from one or more sources:  
specfit       : Fit 1-dimensional gaussians and/or polynomial models to an image or image region  
splattotable  : Convert a downloaded Splatalogue spectral line list to a casa table.  
split         : Create a visibility subset from an existing visibility set  
ssoflux       : Fills the model column with the visibilities of a calibrator  
statwt        :  Reweight visibilities according to their scatter (Experimental)  
testautoflag  : Task for automatic identification and flagging of RFI  
testconcat    : Concatenate the subtables of several visibility data sets, not the MAIN bulk data.  
tflagdata     :  All-purpose flagging task based on data-selections and flagging modes/algorithms  
uvcontsub     : Continuum fitting and subtraction in the uv plane  
uvcontsub2    : Temporarily a clone of uvcontsub  
uvcontsub3    : An experimental clone of uvcontsub  
uvmodelfit    : Fit a single component source model to the uv data  
uvsub         : Subtract/add model from/to the corrected visibility data.  
viewer        : View an image or visibility data set  
vishead       : List, summary, get, and put metadata in a measurement set  
visstat       : Displays statistical information from a measurement set, or from a measurement set selection  
widefield     : Wide-field imaging and deconvolution with selected algorithm  
wvrgcal       : Generate a gain table based on Water Vapour Radiometer data

Typing startup will provide the startup page displayed when entering CASA. The startup screen lists the various options to obtain help within CASA.

 
CASA <26>: startup  
---------> startup()  
___________________________________________________________________  
    For help use the following commands:  
    tasklist               - Task list organized by category  
    taskhelp               - One line summary of available tasks  
    help taskname          - Full help for task  
    toolhelp               - One line summary of available tools  
    help par.parametername - Full help for parameter name  
___________________________________________________________________  
 


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