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

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

dcsetfframe

procedure dcsetfframe, dc, [toframe=string]

Procedure to reset the frequency reference frame of the supplied data container(s) to the indicated frame. The frequency axis reference frame is given by the frequency_type header value. Normally this remains "TOPO", the topocentric frame in which the data were originally taken. The default GBTIDL display routines use the reference frame found in the velocity_definition header value. This procedure can be used to set the frequency axis values to that frame (or any other valid reference frame). This can be useful when exporting the data to an environment that doesn't know about anything except the frequency information. This routine will not change the displayed frequency axis.

If the frame is not set, the one implied by the data header velocity_definition is used.

This routine adjusts the following header values: reference_frequency, frequency_interval, frequency_type and center_frequency. When written to an SDFITS table, the first three of these four values correspond to CRVAL1, CDELT1, and CTYPE1, in that order.

Nothing is changed if the frame is already set to the desired frame.

Nothing is changed if the frame is unrecognized.

Version: $Id$

Parameters

dc
in, required
spectrum The data container(s) to be adjusted.

Keywords

toframe
in, optional
string The reference frame to use. If not supplied, the value implied by the last 4 characters of the velocity_definition the data container. See frame_velocity for a full list of supported reference frames.

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

Parameters
dc in, required spectrum	The data container(s) to be adjusted.

Keywords
toframe in, optional string	The reference frame to use. If not supplied, the value implied by the last 4 characters of the velocity_definition the data container. See frame_velocity for a full list of supported reference frames.