Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.shapetype - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Returns the shape type of the component

Synopsis
shapetype(which)

Description
The shapetype function returns the current shape of the specified component. The shape defines how the flux of the component varies with direction on the sky. Currently there are three shapes available. These are 'Point', 'Gaussian', and 'Disk'. This function returns one of these three strings.

Arguments

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

Returns
A string specifying the current component shape

Example

      include 'componentlist.g'
      cl := componentlist('crux.cl');
      print 'The first component has a', cl.shapetype(1), ' shape';

This example prints the following:

      The first component has a Point  shape