./toolbox
chantovel.pro

Last modification date:

Wed Sep 28 13:27:10 2016

chantovel

function chantovel(data, chans, [frame=string], [veldef=string], [true_frame=variable], [true_veldef=variable])

Convert channel number to velcity (m/s) using the supplied data container. Optionally return the velocity in another reference frame.

Returns

velocity (m/s)

Uses

data_valid decode_veldef chantofreq freqtovel

Version

$Id$

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 frame_velocity. Defaults to the frame given in data.velocity_definition.
veldef in, optional string	The velocity definition to use from RADIO, OPTICAL, or TRUE. Defaults to value found in data.velocity_definition.
true_frame out, optional variable	The actual rest frame used in constructing the velocity 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.velocity_definition.
true_veldef out, optional variable	The actual velocity frame used in constructing the velocity 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 data.velocity_definition.