setvoffset.pro

NRAO GBTIDL
Produced by IDL 6.1
Developer Documentation

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

SUMMARY: fields | routine DETAILS: routine

./plotter
setvoffset.pro

Last modification date:: Thu Jun 2 23:56:08 2005

setvoffset

procedure setvoffset[, voffset], [veldef=string]

Procedure to set the velocity offset in the plotter, in the current frame.

Version: $Id: setvoffset.pro,v 1.3 2005/04/11 16:58:48 bgarwood Exp $
Common blocks: gbtplot_common

Parameters

voffset
in, optional
double The new velocity offset in km/s. If not supplied it uses the source velocity of the spectrum in the plotter. In that case, the veldef also comes from the spectrum in the plotter and the veldef keyword here is not used. If there is no spectrum in the plotter, it does nothing.

Keywords

veldef
in, optional
string The velocity definition to use. If not set, the current definition in use in the plotter will be used.

Produced by IDLdoc 1.6 on Thu Jun 2 23:56:18 2005

Parameters
voffset in, optional double	The new velocity offset in km/s. If not supplied it uses the source velocity of the spectrum in the plotter. In that case, the veldef also comes from the spectrum in the plotter and the veldef keyword here is not used. If there is no spectrum in the plotter, it does nothing.

Keywords
veldef in, optional string	The velocity definition to use. If not set, the current definition in use in the plotter will be used.