nraonrao
 
NRAO Home > CASA > CasaRef
componentlist.setflux - Function

1.4.2 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.

Arguments





Inputs

which

A vector of indices specifying the components to modify. A vector with indices between 1 and the list length

allowed:

int

Default:

value

The flux values for the specified components A vector with four real or complex numbers

allowed:

any

Default:

variant

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:

variant

log

Send a message to the logger

allowed:

bool

Default:

true

Returns
bool

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])  
    

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.