Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents index
Next: componentlist.getfrequnit - Function Up: componentlist - Tool Previous: componentlist.getfreq - Function


componentlist.getfreqvalue - Function



Package synthesis
Module componentmodels
Tool componentlist


Get the reference frequency value


Synopsis
getfreqvalue(which)


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 up previous contents index
Next: componentlist.getfrequnit - Function Up: componentlist - Tool Previous: componentlist.getfreq - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15