avg_accum.pro

NRAO GBTIDL
Produced by IDL 6.1
User Documentation

prev file | next file view single page | view frames

SUMMARY: fields | routine DETAILS: routine

./guide
File avg_accum.pro

Last modification date:: Fri Nov 19 11:20:49 2004

avg_accum

function avg_accum(data, tint, tsys[, teff], [accum_buf=accum_struct structure])

Get the averaged values from the given accum_struct structure. This procedure is in GUIDE because of the nature of system variables. They are passed by value and not by reference, which would make this inefficient as temporary copies are continuously made. So, this procedure needs to optionally be aware of the global structure, although it will use a user supplied one.

Returns: The total number of data arrays in the accumulation so far. A return value of 0 indicates that the accum_buf was empty or there was a problem. The output arguments remain unchanged in that case.
Version: $Id: avg_accum.pro,v 1.1 2004/11/19 16:20:49 bgarwood Exp $

Parameters

data
out, required
float array The weighted average.

tint
out
type=float} The sum of the integration times.

tsys
out, required
float The weighted system temperature.

teff
out, optional
float The sum of the effective integration times.

Keywords

accum_buf
in, optional
accum_struct structure The accum_struct structure holding an on-going accumulation. If omitted, the global structure at !g.accumbuf is used.

Produced by IDLdoc 1.5 on Wed Dec 8 13:08:13 2004

Parameters
data out, required float array	The weighted average.
tint out	type=float} The sum of the integration times.
tsys out, required float	The weighted system temperature.
teff out, optional float	The sum of the effective integration times.

Keywords
accum_buf in, optional accum_struct structure	The accum_struct structure holding an on-going accumulation. If omitted, the global structure at !g.accumbuf is used.