Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.sample - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Sample the flux of the list in a specified direction.

Synopsis
sample(direction, pixellatsize, pixellongsize, frequency)

Description

The sample function returns a vector containing the flux in Janskys/pixel of all the components in the list, in the specified direction, at the specified frequency. The returned vector always contains four elements corresponding to the Stokes parameters I, Q, U, V.

Arguments

direction		The direction to sample
		Allowed:	any valid direction measure.
		Default:	no default
pixellatsize		the x-size of the in pixels to use when sampling
		Allowed:	any quantity that has angular units.
		Default:	no default
pixellongsize		the y-size of the in pixels to use when sampling
		Allowed:	any quantity that has angular units.
		Default:	no default
frequency		The frequency to sample at
		Allowed:	Any frequency measure
		Default:	no default

Returns
A vector with four elements containing the flux in Janskys/pixel in the I, Q, U, & V polarizations

Example

      include 'componentlist.g'
      include 'measures.g'
      cl := componentlist('crux.cl', readonly=T);
      dir := dm.direction('J2000', '12h26m35.9', '-63d5m56');
      pixelsize := dm.quantity('1arcsec');
      flux := cl.sample(dir, pixelsize);

In this example the componentlist is sampled at the position of $\alpha$-Cru. The flux will be a vector with four elements.