Overview   Directory   Index   Search   File   Source   Help   Etc 
   
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
whichsampler.pro

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

whichsampler

function whichsampler(scan, ifnum, plnum, fdnum, [instance=integer], [file=string], [timestamp=string], [/quiet])

Find the sampler name which corresponds to the given if, feed, and polarization numbers in the scan. This value is the same as the sampler_name in the data containers associated with that if, feed, and polarization numbers in the scan.

A single value is always returned. If the same scan appears more than once in the data file then a value corresponding to instance will be returned. If instance is not used then the value corresponding to the first instance (instances=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 combination of if, feed, and polarization numbers is not found in the scan, the returned value is an empty string.

Returns
sampler name
Version
$Id$

Parameters
scan
in, required
integer 		scan number
ifnum
in, required
integer 		IF number
plnum
in, required
integer 		polarization number
fdnum
in, required
integer 		feed number

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.

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