./toolbox
frequency_axis.pro

Last modification date:

Wed Sep 28 13:27:11 2016

FREQUENCY_AXIS

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

Construct a frequency axis from a data structure.

Returns

A vector of frequencies (Hz). 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$

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_velocity for a full list of supported reference frames.
true_frame out, optional variable	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.