Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.convertfrequnit - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Convert the reference frequency to a new unit

Synopsis
convertfrequnit(which, unit)

Description

The convertfrequnit function changes the specified components to use a new unit for the reference frequency. Using this function will change the frequency value also so that the overall reference frequency is not changed. It will affect the values and units obtained with setfreqvalue function.

Any unit can be used that has the same dimensions as the 'Hz'.

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
unit		The new frequency unit
		Allowed:	Any string with the same dimensions as the 'Hz'
		Default:	'GHz'

Returns
nothing

Example

      include 'componentlist.g'
      cl := componentlist('centarusA.cl');
      cl.convertfrequnit(1, 'kHz');
      print 'The reference frequency is ', cl.getfreqvalue(1), ' ', 
            cl.getfrequnit(1), '(', cl.getfreqframe(1), ')'

This example prints, when used in conjunction with example from the setfreq function the following:

    The reference frequency is  1.415e+06   kHz ( LSR )