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

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

frame_velocity

function frame_velocity(data, toframe[, fromframe], [/bootstrap], [status=variable])

Toolbox front-end to chdoppler. Get the velocity of a given frame relative to another frame.

Recognized frames:

TOPO - topocentric. The observed (sky) frame.

GEO - geocentric.

HEL - heliocentric.

BAR - barycentric.

LSR - Local standard of rest (kinematic).

LSD - Dynamic LSR.

GAL - galactocentric.

Returns: Velocity difference between fromframe and toframe along the line of sight implied by the data header.
Uses

Parameters

data
in, required
spectrum Data container to get pointing direction, time, and telescope location from.

toframe
in, required
string The desired frame.

fromframe
in, optional
string The originating frame. Defaults to "TOPO".

Keywords

bootstrap
in, optional
boolean If set, the data.frame_velocity will be used to get to the frame given in data.velocity_definition. The other data header information will only be used to get to other frames. Bootstraping is desirable because the sdfits tool may not be getting the correct times and positions for each integration - early versions didn't. However, the frame_velocity is correct and can be relied on.

status
out, optional
variable This is 1 if there were no problems and is 0 if anything unexpected happened (invalid data container type, velocity definition, or unrecognized data frames).

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

Parameters
data in, required spectrum	Data container to get pointing direction, time, and telescope location from.
toframe in, required string	The desired frame.
fromframe in, optional string	The originating frame. Defaults to "TOPO".

Keywords
bootstrap in, optional boolean	If set, the data.frame_velocity will be used to get to the frame given in data.velocity_definition. The other data header information will only be used to get to other frames. Bootstraping is desirable because the sdfits tool may not be getting the correct times and positions for each integration - early versions didn't. However, the frame_velocity is correct and can be relied on.
status out, optional variable	This is 1 if there were no problems and is 0 if anything unexpected happened (invalid data container type, velocity definition, or unrecognized data frames).