NRAO Home > CASA > CASA Toolkit Reference Manual

CASA Toolkit Reference Manual

CASA Group, eds

May 16, 2017

Copyright 2016 AUI

CASA Reference Manual.

The CASA Reference Manual contains the documentation on the tool-based functionality within the system. There are five broad packages:

Contents
1 Package General
 1.1 images - Module
  1.1.1 image - Tool
    image.image - Function
    image.newimage - Function
    image.newimagefromfile - Function
    image.imagecalc - Function
    image.collapse - Function
    image.decimate - Function
    image.imageconcat - Function
    image.fromarray - Function
    image.fromascii - Function
    image.fromfits - Function
    image.fromimage - Function
    image.fromshape - Function
    image.maketestimage - Function
    image.deviation - Function
    image.adddegaxes - Function
    image.addnoise - Function
    image.convolve - Function
    image.boundingbox - Function
    image.boxcar - Function
    image.brightnessunit - Function
    image.calc - Function
    image.calcmask - Function
    image.close - Function
    image.continuumsub - Function
    image.convertflux - Function
    image.convolve2d - Function
    image.coordsys - Function
    image.coordmeasures - Function
    image.decompose - Function
    image.deconvolvecomponentlist - Function
    image.deconvolvefrombeam - Function
    image.beamforconvolvedsize - Function
    image.commonbeam - Function
    image.remove - Function
    image.removefile - Function
    image.done - Function
    image.fft - Function
    image.findsources - Function
    image.fitprofile - Function
    image.fitcomponents - Function
    image.fromrecord - Function
    image.getchunk - Function
    image.getregion - Function
    image.getprofile - Function
    image.getslice - Function
    image.hanning - Function
    image.haslock - Function
    image.histograms - Function
    image.history - Function
    image.insert - Function
    image.isopen - Function
    image.ispersistent - Function
    image.lock - Function
    image.makecomplex - Function
    image.maskhandler - Function
    image.miscinfo - Function
    image.modify - Function
    image.maxfit - Function
    image.moments - Function
    image.name - Function
    image.open - Function
    image.pad - Function
    image.crop - Function
    image.pixelvalue - Function
    image.putchunk - Function
    image.putregion - Function
    image.rebin - Function
    image.regrid - Function
    image.transpose - Function
    image.rotate - Function
    image.rotatebeam - Function
    image.rename - Function
    image.replacemaskedpixels - Function
    image.beamarea - Function
    image.restoringbeam - Function
    image.sepconvolve - Function
    image.set - Function
    image.setbrightnessunit - Function
    image.setcoordsys - Function
    image.sethistory - Function
    image.setmiscinfo - Function
    image.shape - Function
    image.setrestoringbeam - Function
    image.statistics - Function
    image.twopointcorrelation - Function
    image.subimage - Function
    image.summary - Function
    image.tofits - Function
    image.toASCII - Function
    image.torecord - Function
    image.type - Function
    image.topixel - Function
    image.toworld - Function
    image.unlock - Function
    image.newimagefromarray - Function
    image.newimagefromfits - Function
    image.newimagefromimage - Function
    image.newimagefromshape - Function
    image.pbcor - Function
    image.pv - Function
    image.makearray - Function
    image.isconform - Function
  1.1.2 regionmanager - Tool
    regionmanager.regionmanager - Function
    regionmanager.absreltype - Function
    regionmanager.box - Function
    regionmanager.frombcs - Function
    regionmanager.complement - Function
    regionmanager.concatenation - Function
    regionmanager.deletefromtable - Function
    regionmanager.difference - Function
    regionmanager.done - Function
    regionmanager.selectedchannels - Function
    regionmanager.fromtextfile - Function
    regionmanager.fromtext - Function
    regionmanager.fromfiletorecord - Function
    regionmanager.tofile - Function
    regionmanager.fromrecordtotable - Function
    regionmanager.fromtabletorecord - Function
    regionmanager.intersection - Function
    regionmanager.ispixelregion - Function
    regionmanager.isworldregion - Function
    regionmanager.namesintable - Function
    regionmanager.setcoordinates - Function
    regionmanager.makeunion - Function
    regionmanager.wbox - Function
    regionmanager.wpolygon - Function
  1.1.3 coordsys - Tool
    coordsys.coordsys - Function
    coordsys.newcoordsys - Function
    coordsys.addcoordinate - Function
    coordsys.axesmap - Function
    coordsys.axiscoordinatetypes - Function
    coordsys.conversiontype - Function
    coordsys.convert - Function
    coordsys.convertdirection - Function
    coordsys.convertmany - Function
    coordsys.coordinatetype - Function
    coordsys.copy - Function
    coordsys.done - Function
    coordsys.epoch - Function
    coordsys.findaxis - Function
    coordsys.findaxisbyname - Function
    coordsys.findcoordinate - Function
    coordsys.frequencytofrequency - Function
    coordsys.frequencytovelocity - Function
    coordsys.fromrecord - Function
    coordsys.increment - Function
    coordsys.lineartransform - Function
    coordsys.names - Function
    coordsys.naxes - Function
    coordsys.ncoordinates - Function
    coordsys.observer - Function
    coordsys.projection - Function
    coordsys.referencecode - Function
    coordsys.referencepixel - Function
    coordsys.referencevalue - Function
    coordsys.reorder - Function
    coordsys.transpose - Function
    coordsys.replace - Function
    coordsys.restfrequency - Function
    coordsys.setconversiontype - Function
    coordsys.getconversiontype - Function
    coordsys.setdirection - Function
    coordsys.setepoch - Function
    coordsys.setincrement - Function
    coordsys.setlineartransform - Function
    coordsys.setnames - Function
    coordsys.setobserver - Function
    coordsys.setprojection - Function
    coordsys.setreferencecode - Function
    coordsys.setreferencelocation - Function
    coordsys.setreferencepixel - Function
    coordsys.setreferencevalue - Function
    coordsys.setrestfrequency - Function
    coordsys.setspectral - Function
    coordsys.setstokes - Function
    coordsys.settabular - Function
    coordsys.settelescope - Function
    coordsys.setunits - Function
    coordsys.stokes - Function
    coordsys.summary - Function
    coordsys.telescope - Function
    coordsys.toabs - Function
    coordsys.toabsmany - Function
    coordsys.topixel - Function
    coordsys.topixelmany - Function
    coordsys.torecord - Function
    coordsys.subimage - Function
    coordsys.torel - Function
    coordsys.torelmany - Function
    coordsys.toworld - Function
    coordsys.toworldmany - Function
    coordsys.type - Function
    coordsys.units - Function
    coordsys.velocitytofrequency - Function
    coordsys.parentname - Function
    coordsys.setparentname - Function
  1.1.4 imagepol - Tool
    imagepol.imagepol - Function
    imagepol.imagepoltestimage - Function
    imagepol.complexlinpol - Function
    imagepol.complexfraclinpol - Function
    imagepol.depolratio - Function
    imagepol.close - Function
    imagepol.done - Function
    imagepol.fourierrotationmeasure - Function
    imagepol.fraclinpol - Function
    imagepol.fractotpol - Function
    imagepol.linpolint - Function
    imagepol.linpolposang - Function
    imagepol.makecomplex - Function
    imagepol.open - Function
    imagepol.pol - Function
    imagepol.rotationmeasure - Function
    imagepol.sigma - Function
    imagepol.sigmadepolratio - Function
    imagepol.sigmafraclinpol - Function
    imagepol.sigmafractotpol - Function
    imagepol.sigmalinpolint - Function
    imagepol.sigmalinpolposang - Function
    imagepol.sigmastokes - Function
    imagepol.sigmastokesi - Function
    imagepol.sigmastokesq - Function
    imagepol.sigmastokesu - Function
    imagepol.sigmastokesv - Function
    imagepol.sigmatotpolint - Function
    imagepol.stokes - Function
    imagepol.stokesi - Function
    imagepol.stokesq - Function
    imagepol.stokesu - Function
    imagepol.stokesv - Function
    imagepol.summary - Function
    imagepol.totpolint - Function
 1.2 components - Module
  1.2.1 componentlist - Tool
    componentlist.componentlist - Function
    componentlist.open - Function
    componentlist.asciitocomponentlist - Function
    componentlist.concatenate - Function
    componentlist.fromrecord - Function
    componentlist.torecord - Function
    componentlist.remove - Function
    componentlist.purge - Function
    componentlist.recover - Function
    componentlist.length - Function
    componentlist.indices - Function
    componentlist.sort - Function
    componentlist.isphysical - Function
    componentlist.sample - Function
    componentlist.rename - Function
    componentlist.simulate - Function
    componentlist.addcomponent - Function
    componentlist.close - Function
    componentlist.edit - Function
    componentlist.done - Function
    componentlist.select - Function
    componentlist.deselect - Function
    componentlist.selected - Function
    componentlist.getlabel - Function
    componentlist.setlabel - Function
    componentlist.getfluxvalue - Function
    componentlist.getfluxunit - Function
    componentlist.getfluxpol - Function
    componentlist.getfluxerror - Function
    componentlist.setflux - Function
    componentlist.convertfluxunit - Function
    componentlist.convertfluxpol - Function
    componentlist.getrefdir - Function
    componentlist.getrefdirra - Function
    componentlist.getrefdirdec - Function
    componentlist.getrefdirframe - Function
    componentlist.setrefdir - Function
    componentlist.setrefdirframe - Function
    componentlist.convertrefdir - Function
    componentlist.shapetype - Function
    componentlist.getshape - Function
    componentlist.setshape - Function
    componentlist.convertshape - Function
    componentlist.spectrumtype - Function
    componentlist.getspectrum - Function
    componentlist.setstokesspectrum - Function
    componentlist.setspectrum - Function
    componentlist.getfreq - Function
    componentlist.getfreqvalue - Function
    componentlist.getfrequnit - Function
    componentlist.getfreqframe - Function
    componentlist.setfreq - Function
    componentlist.setfreqframe - Function
    componentlist.convertfrequnit - Function
    componentlist.getcomponent - Function
    componentlist.add - Function
    componentlist.replace - Function
    componentlist.summarize - Function
    componentlist.iscomponentlist - Function
 1.3 ms - Module
  1.3.1 ms - Tool
    ms.ms - Function
    ms.fromfits - Function
    ms.fromfitsidi - Function
    ms.listfits - Function
    ms.createmultims - Function
    ms.ismultims - Function
    ms.getreferencedtables - Function
    ms.getfielddirmeas - Function
    ms.nrow - Function
    ms.nrow2 - Function
    ms.iswritable - Function
    ms.open - Function
    ms.reset - Function
    ms.close - Function
    ms.name - Function
    ms.statwt2 - Function
    ms.tofits - Function
    ms.summary - Function
    ms.getscansummary - Function
    ms.getspectralwindowinfo - Function
    ms.listhistory - Function
    ms.writehistory - Function