componentlist.getfreqvalue

Description

The getfreqvalue function returns as a floating point number the value of the reference frequency. To fully interpret this value you should also use the frequency unit, obtained using the getfrequnit function and the frequency reference frame, obtained using the getfrequnit function

Arguments

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

Returns A number containing the value of the reference frequency.

Example

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

This example prints the following:

    The reference frequency is  1   GHz ( LSR )

which is the reference frequency of the first component.

Next: componentlist.getfrequnit - Function Up: componentlist - Tool Previous: componentlist.getfreq - Function Contents Index

	`Package`	`synthesis`
	`Module`	`componentmodels`
	`Tool`	`componentlist`

componentlist.getfreqvalue - Function