frequency_axis.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 frequency_axis.pro

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

FREQUENCY_AXIS

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

Construct a frequency axis from a data structure.

Returns: A vector of frequencies (MHz). May also set the keywords. Returns -1 on a severe error. If the ref_frame is invalid this will use the values found in the data structure and the values of the true_frame keyword will be set.
Uses: chantovel
Version: $Id: frequency_axis.pro,v 1.1 2004/11/30 15:42:58 bgarwood Exp $

Parameters

data
in, required
spectrum The data structure to use in constructing a frequency axis.

Keywords

frame
in, optional
string The reference frame to use. If not supplied, the data.frequency_type value will be used. See frame_frequency for a full list of supported reference frames.

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 frequency axis. 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:16 2004

Parameters
data in, required spectrum	The data structure to use in constructing a frequency axis.

Keywords
frame in, optional string	The reference frame to use. If not supplied, the data.frequency_type value will be used. See frame_frequency for a full list of supported reference frames.
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 frequency axis. 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.