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.component - Function Up: componentlist - Tool Previous: componentlist.setfreqframe - Function


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 )




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