get_calib_data.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./guide
get_calib_data.pro

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

get_calib_data

function get_calib_data(info, ifnum, plnum, fdnum, sampler[, count], [intnum=integer], [useflag=boolean or string], [skipflag=boolean or string], [/twofeeds], [sig_state=integer], [wcalpos=string], [subref=integer])

Used by the calibration routines to actually fetch the necessary data. This is not meant to be called directly by the user. Error messages generated here are displayed using the prefix from the calling routine. It is expected that some argument checking will have happened prior to this function being called. The only checks done here are that the requested data (ifnum, plnum, fdnum, and intnum) are consistent with the given scan info.

The returned values are the array of data containers found in the current line data source that satisfy the request using the provided scan info structure to indentify the scan.

If there is a problem, the returned value is -1 and count is 0.

Returns: an array of spectral line data containers that satisfy this request. Returns -1 on error (count will also be 0 in that case).
Version: $Id$

Parameters

info
in, required
structure The scan_info structure that describes the scan. Use find_scan_info to get this scan_info.

ifnum
in, required
integer The IF number to fetch

plnum
in, required
integer The polarization number to fetch.

fdnum
in, required
integer The feed number to fetch. Ignored when twofeeds is set.

sampler
in, required
string The sampler name, an alternative to ifnum, plnum and fdnum. This is used (and the others are ignored) when it is not empty.

count
out, optional
variable The number of data containers returned. This is 0 when there is a problem.

Keywords

intnum
in, optional
integer The specific integration to fetch. If not supplied then fetch data from all integrations that match the other parameters.

useflag
in, optional
boolean or string (def. true) Apply all or just some of the flag rules?

skipflag
in, optional
boolean or string Do not apply any or do not apply a few of the flag rules?

twofeeds
in, optional
boolean When set (1), then this data must contain 2 and only two feeds and all data from both feeds is returned by this call. In that case, fdnum is ignored.

sig_state
in, optional
integer When -1, this keyword is ignored, when 0 then the reference state is selected, when 1 then the sig state is selected.

wcalpos
in, optional
string When set, then only data matching this wcalpos string is fetched. Ignored when fetching data from an individual integration.

subref
in, optional
integer When set, then only data matching this subref value is fetched. Ignored when fetching data from an individual integration.

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

Parameters
info in, required structure	The scan_info structure that describes the scan. Use find_scan_info to get this scan_info.
ifnum in, required integer	The IF number to fetch
plnum in, required integer	The polarization number to fetch.
fdnum in, required integer	The feed number to fetch. Ignored when twofeeds is set.
sampler in, required string	The sampler name, an alternative to ifnum, plnum and fdnum. This is used (and the others are ignored) when it is not empty.
count out, optional variable	The number of data containers returned. This is 0 when there is a problem.

Keywords
intnum in, optional integer	The specific integration to fetch. If not supplied then fetch data from all integrations that match the other parameters.
useflag in, optional boolean or string (def. true)	Apply all or just some of the flag rules?
skipflag in, optional boolean or string	Do not apply any or do not apply a few of the flag rules?
twofeeds in, optional boolean	When set (1), then this data must contain 2 and only two feeds and all data from both feeds is returned by this call. In that case, fdnum is ignored.
sig_state in, optional integer	When -1, this keyword is ignored, when 0 then the reference state is selected, when 1 then the sig state is selected.
wcalpos in, optional string	When set, then only data matching this wcalpos string is fetched. Ignored when fetching data from an individual integration.
subref in, optional integer	When set, then only data matching this subref value is fetched. Ignored when fetching data from an individual integration.