casatools

CASAtools

If you are looking for the place to check out CASA with Git, please refer to the top level directory of this repository.

CASAtools is a self-contained python module that provides the tools from the CASA project.

Building casatools

Please refer to the top level readme.md.

Testing casatools

A quick test to see if the casatools installation is successful is to try loading the CASAtools module:

$ python3
Python 3.8.13 (default, Nov  8 2022, 17:19:05) 
[GCC 8.5.0 20210514 (Red Hat 8.5.0-15)] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from casatools import image
>>> ia = image( )
>>> ia.fromshape("mytest.im",[20,20])
2019-03-25 16:15:08     INFO    ImageFactory::createImage       Created Paged image 'mytest.im' of shape [20, 20] with float valued pixels.
True
>>>
-bash-4.2$

Available Tools

Tool Name	Description
agentflagger	Tool for manual and automated flagging
atcafiller	Filler for ATNF/ATCA RPFITS data
atmosphere	Atmosphere model
calanalysis	Get and fit data from a calibration table (CASA 3.4 and later).
calibrater	Synthesis calibration (self- and cross-)
componentlist	A tool for the manipulation of groups of components
coordsys	Operations on CoordinateSystems
functional	Functionals handling
imagemetadata	Operations on imagemetadata
image	Operations on images
imagepol	Polarimetric analysis of images
imager	tool for synthesis imaging
iterbotsink	tool for synthesis imaging
logsink	tool for logsink
measures	measures tool
miriadfiller	Tool for the importmiriad task
msmetadata	Operations to retrieve metadata from a measurment set
ms	Operations on measurement sets
mstransformer	Tool to apply spw and frame transformations in MS
quanta	quanta tool handles units and quantities
regionmanager	Create and manipulate regions of interest
sakura	New single dish tool interface using sakura
sdm	Manipulate or examine SDM datasets
sidebandseparator	Tool for sideband separation
simulator	Tool for simulation
singledishms	New single dish tool interface to process an MS
spectralline	spectral line tool
synthesisdeconvolver	tool for synthesis imaging
synthesisimager	tool for synthesis imaging
synthesisimstore	tool for synthesis imaging
synthesismaskhandler	tool for mask handling in sysnthesis imaging
synthesisnormalizer	tool for synthesis imaging
synthesisutils	tool for synthesis imaging
table	Access tables from casapy
vlafiller	tool for VLA filler tasks
vpmanager	Tool for specifying voltage patterns and primary beams
wvr	Tool for the analysis of Water Vapour Radiometer data

XML

Tool Specification

    <tool name="tool-name">
        <shortdescription>one-line description</shortdescription>
        <description>paragraph description</description>

        <needs>tool-name</needs>

        <code>
            <include>path to headerfile</include>
            <private>
                <include>path to headerfile</include>
            </private>
        </code>

        <method name="method-name">
            <shortdescription>one-line description</shortdescription>
            <description>paragraph description</description>
            <input>
                <param name="param-name">
                    <description>short description</description>
                    <type units="unit-name" mustexist="true">type-name</type>
                    <value>value-content</value>
                </param>
            </input>
            <output>
                <param name="param-name">
                    <description>short description</description>
                    <type units="unit-name" mustexist="true">type-name</type>
                    <value>value-content</value>
                </param>
            </output>

            <returns type="type-name"/>
        </method>
    </tool>

• Red text indicate unique names. They may be developer specified (e.g. tool-name), they may be predefined enumerations (e.g. unit-name), or they may be both (e.g. type-name).
• Blue XML elements or attributes indicates optional items (zero or one).
• Green XML elements can be repeated.
• Black XML elements or attributes must be supplied (once)