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

./guide
samplerinfo.pro

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

samplerinfo

function samplerinfo(scan, sampler, [instance=integer], [file=string], [timestamp=string], [/quiet], [recs=variable])

Find the if, feed, and polarization numbers which corresponds to the given sampler name in the scan.

A three-element array is returned having the value (ifnum,plnum,fdnum) corresponding to the IF, feed, and polarization numbers associated with the given sampler name and scan.

If the same scan appears more than once in the data file then the value corresponding to instance will be returned. If instance is omitted, the first instance (instance=0) will be returned. The instance and file keywords can be used to ensure that a single scan is used. Alternatively, the timestamp keyword can be used to ensure that a single scan is used (scan and instance are ignored in that case).

If the requested sampler is not found in the scan, the all values of the returned array will be -1.

There is no check to make sure that there is just one (ifnum,plnum,fdnum) associated with the given sampler. The values for the first matching sampler are returned.

Returns: array of [ifnum,plnum,fdnum]
Version: $Id$

Parameters

scan
in, required
integer scan number

sampler
in, required
string sampler name

Keywords

instance
in, optional
integer Which occurence of this scan should be used. Default is 0.

file
in, optional
string When specified, limit the search for this scan (and instance) to this specific file. Default is all files.

timestamp
in, optional
string The M&C timestamp associated with the desired scan. When supplied, scan and instance are ignored.

quiet
in, optional
boolean When set, suppress most error messages. Useful when being used within another procedure.

recs
out, optional
variable This contains the records (index numbers) from this sampler in the indicated scan. This is useful when you want to fetch that data immediately using getchunk since that will not involve any further selection and hence will be faster. This is used by all of the get* calibration routines (which use get_calib_data, where the work is actually done). If there is no matching data, this value will be -1.

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

Parameters
scan in, required integer	scan number
sampler in, required string	sampler name

Keywords
instance in, optional integer	Which occurence of this scan should be used. Default is 0.
file in, optional string	When specified, limit the search for this scan (and instance) to this specific file. Default is all files.
timestamp in, optional string	The M&C timestamp associated with the desired scan. When supplied, scan and instance are ignored.
quiet in, optional boolean	When set, suppress most error messages. Useful when being used within another procedure.
recs out, optional variable	This contains the records (index numbers) from this sampler in the indicated scan. This is useful when you want to fetch that data immediately using getchunk since that will not involve any further selection and hence will be faster. This is used by all of the get* calibration routines (which use get_calib_data, where the work is actually done). If there is no matching data, this value will be -1.