Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.getfluxvalue - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Get the flux value of the specified component

Synopsis
getfluxvalue(which)

Description
The getfluxvalue function returns the value of the flux of the specified component using the current units and the current polarization representation. The functions getfluxunit & getfluxpol & can be used to get the units and polarization representation that corresponds to the supplied value.

Arguments

which		An index specifying which component
		Allowed:	An integer between 1 and the list length
		Default:	no default

Returns
A vector of length 4 with the flux values in the current units and polarization representation.

Example

      include 'componentlist.g'
      cl := componentlist('crux.cl');
      flux := cl.getfluxvalue(1);
      unit := cl.getfluxunit(1);
      pol := cl.getfluxpol(1);
      err := cl.getfluxerror(1);

This example returns the values, units, polarization and error of the first component in the list.