1.2.1.0 componentlist.setflux

NRAO Home > CASA > CASA Toolkit Reference Manual

componentlist.setflux - Function

1.2.1 Set the flux of the specified components

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. (Currently, the parameter, error is ignored.)

Arguments


Inputs
which	A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively
	allowed:	int
	Default:
value	The flux values for the specified components A vector with four real or complex numbers
	allowed:	any
	Default:
unit	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
	allowed:	string
	Default:	circular linear Stokes
error	The error in the value field. A complex vector of length four.
	allowed:	any
	Default:
log	Send a message to the logger
	allowed:	bool
	Default:	true

Returns
bool

Example

      cl.open(’crux.cl’);
      cl.setflux(0, [1,0,0,0], unit=’jy’,
         polarization=’Stokes’, error=[.3, 0, 0, 0])

__________________________________________________________________

[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