componentlist.addcomponent - Function

1.4.2 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
See the setspectrum function.
label
See the setlabel function.

Arguments





Inputs

flux

The flux value. A vector with four real or complex numbers

allowed:

any

Default:

variant

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:

variant J2000 00h00m00.0 90d00m00.0

shape

The new shape type. A string that is either ’point’, ’Gaussian’ or ’disk’

allowed:

string

Default:

disk Gaussian point

majoraxis

The width of the larger axis. A quantity with angular units

allowed:

any

Default:

variant 2.0arcmin

minoraxis

The width of the smaller axis. A quantity with angular units

allowed:

any

Default:

variant 1.0arcmin

positionangle

The rotation of the axes with respect to the reference frame. A quantity with angular units

allowed:

any

Default:

variant 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:

variant LSRK 1.415GHz

spectrumtype

The new spectrum type. A string that is either ’constant’ or ’spectral index’

allowed:

string

Default:

spectral index constant

index

The spectral indices A 4-element vector or real numbers

allowed:

doubleArray

Default:

1 0 0 0

label

The label for the component

allowed:

string

Default:

Returns
bool

Please send any comments or questions about CASA or AIPS++ to aips2-requests@nrao.edu

Copyright © 2008 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

Updated daily during alpha development.