componentlist.setflux

Set the flux of the specified components

Synopsis setflux(which, value, unit, polarization, error, log)

Description The setflux function is used to reassign the flux of the specified components to a new value. The flux value, unit and polarization can be specified and any number of components can be set to the new value.

Arguments

`which`	A vector of indices specifying the components to modify
	`Allowed:`	`A vector with indices between 1 and the list length`
	`Default:`	`no default`
`value`	The flux values for the specified components
	`Allowed:`	`A vector with four real or complex numbers`
	`Default:`	`no default`
`unit`	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`
`error`	The error in the value field
	`Allowed:`	`A complex vector of length four.`
	`Default:`	`[0,0,0,0]`
`log`	Send a message to the logger
	`Allowed:`	`Boolean`
	`Default:`	`T`

Returns nothing

Example

      include 'componentlist.g'
      cl := componentlist('crux.cl');
      cl.setflux(cl.indices(), [1,0,0,0], unit='jy', 
	         polarization='stokes', error=[.3, 0, 0, 0])

This example sets all the components in the list to a flux of 1 Jy in I and zero in the Q, U, & V polarizations.

Next: componentlist.convertfluxunit - Function Up: componentlist - Tool Previous: componentlist.getfluxerror - Function Contents Index

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

componentlist.setflux - Function