Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.setfreq - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Set the reference frequency

Synopsis
setfreq(which, value, unit, log)

Description

The setfreq function sets the reference frequency of the specified components to a new value. The frequency is defined by separately specifying the value and its units. Use the setfreqframe function to set the frequency reference frame

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
value		The new frequency value
		Allowed:	A number
		Default:	no default
unit		The units of the frequency
		Allowed:	Any string with the same dimensions as the 'Hz'
		Default:	'GHz'
log		Send a message to the logger
		Allowed:	Boolean
		Default:	T

Returns
nothing

Example

      include 'componentlist.g'
      cl := componentlist('centarusA.cl');
      cl.setfreq(1, 1.415, 'GHz');

This example sets the reference frequency of the first component to 1.415 GHz. If the spectral type is 'spectral index' and the indicies are non-zero then this will change the flux of the component at all frequencies.