accumulate.pro

NRAO GBTIDL
Produced by IDL 6.1
Developer Documentation

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

SUMMARY: fields | routine DETAILS: routine

./toolbox
accumulate.pro

Last modification date:: Thu Jun 2 23:56:08 2005

accumulate

procedure accumulate, accumbuf, data, tint, tsys[, teff][, f_delt], [wt=float]

Add some data into an accum_struct. Not intended for use by general users.

The data is : sum(wt*data)

The times are summed: sum(teff), sum(tint)

The wt is summed: sum(wt)

The tsys_sq is : sqrt(sum(wt*Tsys^2))

f_delt is used as a check to see if the channel spacing matches the ongoing average. If not supplied, the check is not done.

If a weight (wt) is not supplied, it will be teff/Tsys^2 If teff is not supplied, tint will be used in its place.

Version: $Id: accumulate.pro,v 1.2 2005/05/29 22:44:28 bgarwood Exp $

Parameters

accumbuf
in, required
accum_struct structure The structure to hold the results of this accumlation. Care must be taken if this is !g.accumbuf. Simply passing it in will not work because global values are passed by value not reference. See the code in accum.pro for an example of how to use this in that case.

data
in, required
float array The data to add to the accumulation structure. It must have the same number of elements as the ongoing accumulation (if this is not the first one added in).

tint
in, required
float Integration time.

tsys
in, required
float System temperature.

teff
in, optional
float Effective integration time.

f_delt
in, optional
float Channel spacing.

Keywords

wt
in, optional
float Weight to give this data.

Produced by IDLdoc 1.6 on Thu Jun 2 23:56:20 2005

Parameters
accumbuf in, required accum_struct structure	The structure to hold the results of this accumlation. Care must be taken if this is !g.accumbuf. Simply passing it in will not work because global values are passed by value not reference. See the code in accum.pro for an example of how to use this in that case.
data in, required float array	The data to add to the accumulation structure. It must have the same number of elements as the ongoing accumulation (if this is not the first one added in).
tint in, required float	Integration time.
tsys in, required float	System temperature.
teff in, optional float	Effective integration time.
f_delt in, optional float	Channel spacing.