Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.spectrumtype - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Returns the spectral shape of the component

Synopsis
spectrumtype(which)

Description
The spectrumtype function returns the current spectral shape of the specified component. The spectral shape defines how the flux of the component varies with frequency. Currently there are two spectral shapes available. These are 'Constant' and 'Spectral Index'. This function returns one of these two 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 spectral shape of the specified component

Example

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

This example prints the following:

      The first component has a Constant  spectrum