componentlist

NRAO Home > CASA > CASA Toolkit Reference Manual

1.2.1 componentlist - Tool

A tool for the manipulation of groups of components
Requires:

Synopsis

Description

A componentlist is a tool that contains functions that manipulate components. A component is a functional representation of the sky brightness - point source, disk, Gaussian, etc.

Note for those new to CASA: components are not used explicitly in cleaning, rather the model is stored as an image. Components are useful for e.g. simulation and modifying images (ia.modify), but one will not in general have a clean component list associated with cleaning data.

The simplest way to make a componentlist tool is to use cl.addcomponent: cl.done() # it is safest to close it before beginning # add a single point source component with # Stokes I=2.3Jy and other Stokes parameters 0 cl.addcomponent(dir=’J2000 10h30m00 -20d00m00.0’, flux=[2.3,0,0,0]) cl.rename(”myList.cl”) # save to disk

One can open a list on disk with cl.open(filename).

Componentlists can be converted to/from records (python dictionaries) with cl.torecord() and cl.fromrecord(record).

Methods

componentlist	Construct an empty componentlist
open	Construct a cl from a table on disk
asciitocomponentlist	Create a componentlist from an ascii file (Not implemented yet)
concatenate	Append components from another componentlist.
fromrecord	make a componentlist tool from a record
torecord	convert componentlist to a record
remove	Remove a component from the list.
purge	Permanently delete removed components.
recover	Obtain removed components.
length	Find the number of components in the list.
indices	Return a vector of indices. (Not implemented yet)
sort	Sort the components in a list
isphysical	Check if a component is physically plausible
sample	Sample the flux of the list in a specified direction. (Not implemented yet)
rename	Give the list a name so it can save itself. use close to save to disk
simulate	Add some simulated components to the list
addcomponent	Add a component to the list
close	Save the componentlist to disk and reset its state.
edit	Start up the component editor gui (Not implemented yet)
done	Delete the componentlist tool

select	Mark components in the list
deselect	Unmark components in the list
selected	Determine which components are selected
getlabel	Get the label of the specified component
setlabel	Set the label of the specified components
getfluxvalue	Get the flux value of the specified component
getfluxunit	Get the flux unit of the specified component
getfluxpol	Get the polarization representation for the flux of the specified component (Not implmented yet)
getfluxerror	Get the error in the flux of the specified component
setflux	Set the flux of the specified components
convertfluxunit	Change (convert) the flux units of the specified components
convertfluxpol	Change (convert) the polarization representation of the specified components
getrefdir	Return the reference direction
getrefdirra	Get the RA of the reference direction. (Not implemented not)
getrefdirdec	Get the declination of the reference direction.(Not implemented yet)
getrefdirframe	Get the reference frame of the reference direction.
setrefdir	Set the reference direction
setrefdirframe	Set the reference frame for the direction
convertrefdir	Convert the reference direction to a new frame
shapetype	Returns the shape type of the component

getshape	Return the shape parameters the component
setshape	Change the shape of the component
convertshape	Change the units of the shape parameters (Not implemented yet)
spectrumtype	Returns the spectral shape of the component
getspectrum	Return the spectral parameters the component
setstokesspectrum	Change the spectrum of the component
setspectrum	Change the spectrum of the component
getfreq	Get the reference frequency (Not implemented yet)
getfreqvalue	Get the reference frequency value (Not implemeted yet)
getfrequnit	Get the reference frequency unit (Not implemeted yet)
getfreqframe	Get the reference frequency frame (Not implemeted yet)
setfreq	Set the reference frequency
setfreqframe	Set the reference frame for the frequency
convertfrequnit	Convert the reference frequency to a new unit
getcomponent	Extract a component from the list.
add	Add a component to the list.
replace	Replace components in the list. (Not implemented yet)
summarize	Summarize the specified component to the logger
iscomponentlist	Is the argument a componentlist tool? (Not implemented yet)

[next] [prev] [prev-tail] [front] [up]

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

This code is available under the terms of the GNU General Public Lincense