componentlist.addcomponent

Add a component to the list

Synopsis addcomponent(flux, fluxunit, polarization, ra, raunit, dec, decunit, dirframe, shape, majoraxis, minoraxis, positionangle, freq, freqframe, spectrumtype, index, label)

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

`flux`	The flux value
	`Allowed:`	`A vector with four real or complex numbers`
	`Default:`	`[1,0,0,0]`
`fluxunit`	The units of the flux
	`Allowed:`	`Any string with the same dimensions as the Jansky`
	`Default:`	`Jy`
`polarization`	The polarization of the value field
	`Allowed:`	``Stokes'', ``linear'' or ``circular''
	`Default:`	`Stokes`
`ra`	The RA of the new direction
	`Allowed:`	`A formatted string or a number`
	`Default:`	`00:00:00.00`
`raunit`	The units of the RA
	`Allowed:`	`Any string containing an angular unit or 'angle' or 'time'`
	`Default:`	`'time'`
`dec`	The declination of the new direction
	`Allowed:`	`A formatted string or a number`
	`Default:`	`'90.00.00.00'`
`decunit`	The units of the declination
	`Allowed:`	`Any string containing an angular unit or 'angle' or 'time'`
	`Default:`	`'time'`
`dirframe`	The new reference frame
	`Allowed:`	`A string like 'B1950', 'J2000' or 'galactic'`
	`Default:`	`j2000`
`shape`	The new shape type
	`Allowed:`	`A string that is either 'point', 'Gaussian' or 'disk'`
	`Default:`	`point`
`majoraxis`	The width of the larger axis
	`Allowed:`	`A quantity with angular units`
	`Default:`	`2arcmin`
`minoraxis`	The width of the smaller axis
	`Allowed:`	`A quantity with angular units`
	`Default:`	`1arcmin`
`positionangle`	The rotation of the axes with respect to the reference frame
	`Allowed:`	`A quantity with angular units`
	`Default:`	`0deg`
`freq`	The reference frequency
	`Allowed:`	`A quantity with units equivalent to the 'Hz'`
	`Default:`	`1.415GHz`
`freqframe`	The new reference frame
	`Allowed:`	`A string like 'LSR', 'GEO' or 'TOPO`
	`Default:`	`LSR`
`spectrumtype`	The new spectrum type
	`Allowed:`	`A string that is either 'constant' or 'spectral index'`
	`Default:`	`constant`
`index`	The spectral indices
	`Allowed:`	`A 4-element vector or real numbers`
	`Default:`	`[1,0,0,0]`
`label`	The label for the component
	`Allowed:`	`A string`
	`Default:`	`The default label`

Returns nothing

Next: componentlist.close - Function Up: componentlist - Tool Previous: componentlist.simulate - Function Contents Index

	`Package`	`synthesis`
	`Module`	`componentmodels`
	`Tool`	`componentlist`

componentlist.addcomponent - Function