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

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

veltochan

function veltochan(data, vels, [frame=string], [/rel], [veldef=string])

Convert velocity (m/s) to channel number using the supplied data container. The velocity's frame and definition can also be supplied. The velocity can be expressed relative to the reference channel.

Returns: channel number.
Uses: data_valid decode_veldef chantofreq freqtovel veltofreq freqtochan
Version: $Id: veltochan.pro,v 1.1 2004/11/30 15:42:58 bgarwood Exp $

Parameters

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

vels
in, required
The velocities (m/s) to convert, may be an array of values.

Keywords

frame
in, optional
string The rest frame that the velocities are in. Known rest frames are listed in freqtovel. Defaults to the frame given in data.velocity_definition.

rel
in, optional
boolean If set, the velocities are given relative to the reference channel.

veldef
in, optional
string The velocity definition in use from RADIO, OPTICAL, or TRUE. Defaults to the value found in data.velocity_definition.

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

Parameters
data in, required spectrum	The spectrum data container to use to get the necessary header information.
vels in, required	The velocities (m/s) to convert, may be an array of values.

Keywords
frame in, optional string	The rest frame that the velocities are in. Known rest frames are listed in freqtovel. Defaults to the frame given in data.velocity_definition.
rel in, optional boolean	If set, the velocities are given relative to the reference channel.
veldef in, optional string	The velocity definition in use from RADIO, OPTICAL, or TRUE. Defaults to the value found in data.velocity_definition.