chantofreq.pro

NRAO GBTIDL
Produced by IDL 6.1
User Documentation

prev file | next file view single page | view frames

SUMMARY: fields | routine DETAILS: routine

./toolbox
File chantofreq.pro

Last modification date:: Tue Nov 30 10:42:57 2004

chantofreq

function chantofreq(data, chans, [frame=string], [/rel], [true_frame=string])

Convert channel number to frequency (MHz) using the supplied data container. Optionally return the frequency in another reference frame. Optionally return the frequency relative to the reference channel.

Returns: frequencies (MHz), optionally relative to reference channel.
Uses: data_valid frame_velocity
Version: $Id: chantofreq.pro,v 1.1 2004/11/30 15:42:57 bgarwood Exp $

Parameters

data
in, required
spectrum The spectrum data container to use to get the necessary header information.

chans
in, required
The channel numbers to convert, may be an array of values.

Keywords

frame
in, optional
string The rest frame to convert to. Known rest frames are listed in freqtovel. Defaults to the frame given in the data.frequency_type.

rel
in, optional
boolean If set, return the frequency relative to the reference channel.

true_frame
out, optional
string The actual rest frame used in constructing the frequencies. The only way this will not equal the frame argument is if that argument was invalid. In that case, this keyword will be the same as the frame in data.frequency_type.

Produced by IDLdoc 1.5 on Wed Dec 8 13:08:15 2004

Parameters
data in, required spectrum	The spectrum data container to use to get the necessary header information.
chans in, required	The channel numbers to convert, may be an array of values.

Keywords
frame in, optional string	The rest frame to convert to. Known rest frames are listed in freqtovel. Defaults to the frame given in the data.frequency_type.
rel in, optional boolean	If set, return the frequency relative to the reference channel.
true_frame out, optional string	The actual rest frame used in constructing the frequencies. The only way this will not equal the frame argument is if that argument was invalid. In that case, this keyword will be the same as the frame in data.frequency_type.