Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.convertfluxpol - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Change (convert) the polarization representation of the specified components

Synopsis
convertfluxpol(which, polarization)

Description
The convertfluxpol function is used to convert the flux to another polarization representation. There are are three representations used, namely , 'Stokes', 'linear' & 'circular'

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
polarization		The new polarization representation
		Allowed:	``Stokes'', ``linear'' or ``circular''
		Default:	Stokes

Returns
nothing

Example

      include 'componentlist.g'
      cl := componentlist('centarusA.cl');
      print cl.getfluxvalue(1);
      cl.convertpol(1, 'linear');
      print cl.getfluxvalue(1);

This example converts the flux of the first component to a linear representation. If the flux was originally [1,0.1,0,0.01] (in the Stokes representation) then the resultant flux will be [1.1, 0.01i, -0.01i, 0.9]. Note that the flux is returned as a complex vector when the polarization representation is not Stokes.