scan_info.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

./guide
scan_info.pro

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

scan_info

function scan_info(scan, [/keep])

Get scan information structure from the appropriate I/O object. This uses !g.line to determine which I/O object to get the information from, unless keep is set, in which case it gets it from the keep file. The fields in the returned structure are:

SCAN, the scan number, long integer

SUBSCAN, the sub-scan number, long integer

PROCEDURE, the procedure name, string

N_INTEGRATION, the number of integrations, long integer

N_FEEDS, the number of feeds, long integer

N_IFS, the number of IFs, long integer

N_SWITCHING_STATES, the number of switching states, long integer

Returns: Scan information structure. Returns -1 on error.
Version: $Id: scan_info.pro,v 1.3 2005/04/20 16:27:41 jbraatz Exp $

Parameters

scan
in, required
integer Scan number to get information on.

Keywords

keep
in, optional
boolean If set, the scan information comes from the keep file.

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