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.setfreq - Function Up: componentlist - Tool Previous: componentlist.getfrequnit - Function


componentlist.getfreqframe - Function



Package synthesis
Module componentmodels
Tool componentlist


Get the reference frequency frame


Synopsis
getfreqframe(which)


Description
The getfreqframe function returns as a string the reference frame of the reference frequency of the specified component.

See the measures module for a description of the available frequency reference frames. Common frames are, 'LSR', 'TOPO' and 'GEO'.

The frame string is always returned in upper case.



Arguments

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


Returns
A string containing the reference frame of the reference frequency.


Example
See the example for the getfreqvalue function.

next up previous contents index
Next: componentlist.setfreq - Function Up: componentlist - Tool Previous: componentlist.getfrequnit - 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