NRAO Home > CASA > CASA Toolkit Reference Manual

2.3.2 vpmanager - Tool

Tool for specifying voltage patterns and primary beams



The vpmanager tool serves to set up a list of primary beams or voltage patterns (antenna responses) and then select in detail which of them is used for which observatory. The distinction of several antenna types for a given observatory (heterogeneous arrays) is supported.

Antenna responses can be selected from either internally hard-coded ones, or response-groups defined via an AntennaResponses table, or user-defined analytic primary beams.

Imaging and simulation routines pick up the selected response definitions and instantiate them.

The vpmanager can also create a table with the description of one or more voltage patterns (vp) or primary beams (pb). There is a mapping between telescope name and the vp or pb description. The vp description table can be read by imager’s setvp method, which instantiates the corresponding voltage patterns from the descriptions and applies them to the images.

The vpmanager tool is the CASA Python object which constitutes the user interface to the VPManager C++ class. By default it is named ”vp” in casapy.

The VPManager class is implemented as a singleton, i.e. internally there is only one instance at all times. This instance accessed via the static VPManager::Instance() method. It is permanent until casapy is exited and can be reinitialised via the VPManager::reset() method.

The vp tool connects to the single instance of VPManager. All settings the user makes with the tool, have effect immediately and are then used by all parts of CASA which access the VPManager class (i.e. eventually all imaging and simulation routines).

The VPManager instance keeps a simple database of available antenna responses, the vplist. This list is initialized at the startup of CASA or by calling the reset() method of the class. In the vp tool, the reset call can be triggered using


In order to support heterogeneous interferometer arrays, VPManager permits the use of antenna types in addition to observatory or telescope names.

For defining a simple response which is only spatially scaled by frequency but otherwise constant, a simple call to the vp tool is sufficient, e.g.:


This will create a new entry in the vplist for an analytic Airy disk antenna response and make it the default response for telescope ”ALMA”. Subsequent requests to VPManager for a ALMA antenna response will get this Airy disk.

If whole response systems are to be defined for a given telescope, the use of an AntennaResponses table is possible. Such a table can be set up using the vp tool method createantresp() and then connected to a telescope using a command like


where the value of the antresppath parameter indicates the path to the AntennaResponses table. Subsequent requests for ALMA antenna responses to VPManager will start a search in the indicated AntennaResponses table for responses matching given parameters. Presently supported search parameters in VPManager::getvp() and vp.getvp() are:

An example of a call to vp.getvp() is

        myrecord = vp.getvp(telescope=’ALMA’,  
                            antennatype = ’DV’,  
                            obstime = ’2009/07/24/10:00:00’,  
                            freq = ’TOPO 100GHz’,  
                            obsdirection = ’AZEL 30deg 60deg’)

If the default antenna response for the given telescope is not defined via an AntennaResponses table, the observation parameters obstime, freq, and obsdirection are not needed and can be omitted. The parameter antennatype defaults to empty string. So if no antenna types are distinguished for the given telescope, the simplest call to getvp becomes

       myrecord = vp.getvp(telescope=’HATCREEK’)

During initialization, VPManager will look for entries in the column ”AntennaResponses” of the CASA ”Observatories” table. If there are non-blank entries, the string found will be interpreted as the path to the default AntennaResponses table for the given telescope.

Note that the casacore AntennaResponses C++ class (which is used by VPManager to administrate the AntennaResponses tables) also supports the additional search parameters ”receiver type” and ”beam number”. A general interface to the response file name search is available through the vp.getrespimagename() method. But presently this accesses only AntennaResponse tables which are entered as the default table in the Observatories table.

Generally, the vp tool methods provide functionality: to set up new analytic antenna responses, select which antenna responses from the vplist to use for which telescope and antenna type, access the contents of the vplist, create and access an AntennaResponses table, create a voltage pattern table.


vpmanager Construct a vpmanager tool (note: the underlying VPManager is a singleton)
saveastable Save the vp or pb descriptions as a table
loadfromtable Load the vp or pb descriptions from a table (deleting all previous definitions)
summarizevps Summarize the currently accumulated VP descriptions
setcannedpb Select a vp/pb from our library of common pb models
setpbairy Make an airy disk vp
setpbcospoly Make a vp/pb from a polynomial of scaled cosines
setpbgauss Make a Gaussian vp/pb
setpbinvpoly Make a vp/pb as an inverse polynomial
setpbnumeric Make a vp/pb from a user-supplied vector
setpbimage Make a vp/pb from a user-supplied image
setpbpoly Make a vp/pb from a polynomial
setpbantresptableDeclare a reference to an antenna responses table
reset Reinitialize the VPManager (will erase all VPs and defaults defined on the command line)
setuserdefault Select the VP which is to be used by the imager for the given telescope and antenna type
getuserdefault Get the vp list number of the present default VP/PB for the given parameters (-1 = internal PB, -2 = none)
getanttypes Return the list of available antenna types for the given parameters
numvps Return the number of vps/pbs available for the given parameters
getvp Return the default vps/pbs record for the given parameters
getvps Return the default vps/pbs records for the given antenna list as subrecords in one record
createantresp Create a standard-format AntennaResponses table
getrespimagenameGet the image name for the given parameters from the given responses table

    vpmanager.vpmanager - Function
    vpmanager.saveastable - Function
    vpmanager.loadfromtable - Function
    vpmanager.summarizevps - Function
    vpmanager.setcannedpb - Function
    vpmanager.setpbairy - Function
    vpmanager.setpbcospoly - Function
    vpmanager.setpbgauss - Function
    vpmanager.setpbinvpoly - Function
    vpmanager.setpbnumeric - Function
    vpmanager.setpbimage - Function
    vpmanager.setpbpoly - Function
    vpmanager.setpbantresptable - Function
    vpmanager.reset - Function
    vpmanager.setuserdefault - Function
    vpmanager.getuserdefault - Function
    vpmanager.getanttypes - Function
    vpmanager.numvps - Function
    vpmanager.getvp - Function
    vpmanager.getvps - Function
    vpmanager.createantresp - Function
    vpmanager.getrespimagename - Function

More information about CASA may be found at the CASA web page

Copyright 2016 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