unshiftvel.pro

NRAO GBTIDL
Produced by IDL 7.1.1
User Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./toolbox
unshiftvel.pro

Last modification date:: Wed Sep 28 13:27:11 2016

unshiftvel

function unshiftvel(vel, voffset, [veldef=string])

Undo the effects of shiftvel using the same voffset (do not use its negative here). See the comments in shiftvel. This is intended to only be used on a quantity that is the result from shiftvel.

Returns: the unshifted velocities in m/s.
Version: $Id$

Parameters

vel
in, required
double The velocities, in m/s, to unshift.

voffset
in, required
double The velocity offset (m/s) to remove. This should be the same value used in a previous call to shiftvel.

Keywords

veldef
in, optional
string (def. 'RADIO') The velocity definition from one of RADIO, OPTICAL or TRUE.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:39 2016

Parameters
vel in, required double	The velocities, in m/s, to unshift.
voffset in, required double	The velocity offset (m/s) to remove. This should be the same value used in a previous call to shiftvel.

Keywords
veldef in, optional string (def. 'RADIO')	The velocity definition from one of RADIO, OPTICAL or TRUE.