1.2.1.0 componentlist.addcomponent

NRAO Home > CASA > CASA Toolkit Reference Manual

componentlist.addcomponent - Function

1.2.1 Add a component to the list

Description

The addcomponent function is a convenience function that ties together the simulate function, and the various set functions. This function adds a component to the end of the list. For a description of the arguments see the following functions.

flux, fluxunit, polarization

See the setflux function.

ra, raunit, dec, decunit

See the setrefdir function.

dirframe

See the setrefdirframe function.

shape, majoraxis, minoraxis, positionangle

See the setshape function.

freq

A frequency quantity which is split into a value and units and passed to the setfreq function.

freqframe

See the setfreq function.

spectrumtype, index

The spectral index α such that flux density S as a function of frequency ν is given by the formula: S ∝ ν^α

See the setspectrum function.

setspectrum

label

See the setlabel function.

Arguments


Inputs
flux	The flux value. A vector with four real or complex numbers
	allowed:	any
	Default:
fluxunit	The units of the flux. Any string with the same dimensions as the Jansky
	allowed:	string
	Default:	Jy
polarization	The polarization of the value field. “Stokes”, “linear” or “circular”
	allowed:	string
	Default:	Circular Linear Stokes
dir	The direction measure of the source, it can a be any direction measure from the measures tool or a string of the type ’J2000 10h30m00 -20d00m00.0’ or a vector of strings of the type [’J2000’, ’10:30:00.00’, ’-20.00.00.0’]. Basically the string or strings should have the direction frame and quantities for Ra and Dec
	allowed:	any
	Default:	J2000 00h00m00.0 90d00m00.0
shape	The new shape type. A string that is either ’point’, ’Gaussian’, ’disk’, or ’limbdarkeneddisk’
	allowed:	string
	Default:	disk limbdarkeneddisk Gaussian point
majoraxis	The width (FWHM in the case of a Gaussian) of the larger axis. A quantity with angular units
	allowed:	any
	Default:	2.0arcmin
minoraxis	The width (FWHM in the case of a Gaussian) of the smaller axis. A quantity with angular units
	allowed:	any
	Default:	1.0arcmin
positionangle	The rotation of the axes with respect to the reference frame. A quantity with angular units
	allowed:	any
	Default:	0.0deg
freq	The reference frequency. A quantity with units equivalent to the ’Hz’ and frame or a frequency measure, e.g [’TOPO’, ’1.6GHz’], or simply default frame (LSRK) ’1.6GHz’
	allowed:	any
	Default:	LSRK 1.415GHz
spectrumtype	The spectrum type, a string that is either ’constant’ or ’spectral index’
	allowed:	string
	Default:	spectral index constant
index	The spectral index
	allowed:	double
	Default:	1.0
optionalparms	optional parameters in vector (currently only used for limbdarkeneddisk)
	allowed:	doubleArray
	Default:	0.0
label	The label for the component
	allowed:	string
	Default:

Returns
bool
__________________________________________________________________

[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