parsexunit.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

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

SUMMARY: fields | routine DETAILS: routine

./plotter
parsexunit.pro

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

parsexunit

procedure parsexunit, unit, scale, type

Extract the scale factor and type (0=Channels, 1=Frequency or 2=Velocity) from an xunit string. This routine is a helper routine for other gbtidl plotter procedures and is not intended for end-user use.

Version: $Id$

Parameters

unit
in, required
'String' The unit to parse. The recognized strings are the same strings used in the XUnits menu: Channels, Hz, kHz, MHz, GHz, m/s, and km/s.

scale
out, required
variable The scale factor implied by unit.

type
out, required
variable The type of axis implied by unit (Channels, Frequency, or Velocity).

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

Parameters
unit in, required 'String'	The unit to parse. The recognized strings are the same strings used in the XUnits menu: Channels, Hz, kHz, MHz, GHz, m/s, and km/s.
scale out, required variable	The scale factor implied by unit.
type out, required variable	The type of axis implied by unit (Channels, Frequency, or Velocity).