./guide
find_scan_info.pro

Last modification date:

Wed Sep 28 13:27:12 2016

find_scan_info

function find_scan_info(scan, [timestamp=string], [instance=integer], [file=string])

Find a scan info from the current line filein matching the given scan, file, timestamp, and instance values. The matching scan_info is returned. See scan_info for more information on the returned structure.

This is used by all of the standard calibration routines to get the scan_info for the requested scan. It is encapsulated here to make it easy to adapt and understand those calibration routines. If there was a problem, the return value will not be structure (it will be -1). Because this is designed to be called from another routine, any error messages are displayed using the prefix appropriate to the calling routine.

Returns

A single scan_info structure. Returns -1 if a match can not be found.

Uses

select_data scan_info

Version

$Id$

Parameters
scan in, required integer	Scan number to get information on. This must be provided unless timestamp is provided.

Keywords
timestamp in, optional string	The M&C timestamp associated with the desired scan. When supplied, scan and instance are ignored.
instance in, optional integer	Which occurence of this scan should be used. Default is 0.
file in, optional string	Limit the search for matching scans to a specific file. If omitted, scans are found in all files currently opened through filein (a single file) or dirin (possibly multiple files).