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

./toolbox
dototalpower.pro

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

dototalpower

procedure dototalpower, result, sig_off, sig_on, [tcal=float]

This procedure calibrates a single integration from a total power scan.

The result is the average of the data in the two data containers: 

     (*result.data_ptr) = (*sig_off.data_ptr + *sig_on.data_ptr)/2.0
The tsys in the result is meanTsys as calculated by dcmeantsys. The integration and exposure times in the result are the sum of those two times from each data container. All other header parameters in the result are copies of their values in the sig_off spectrum. dcmeantsys uses the mean_tcal value found in the sig_off data container unless the user supplies a tcal value using the tcal keyword. The mean_tcal value in result will reflect the actual tcal value used (as resuted by dcmeantsys).

This simple routine is designed to be called from a more complicated routine like gettp. This does not check the arguments for consistency or type.

It is the responsibility of the caller to ensure that result is freed using data_free when it is no longer needed (i.e. at the end of all anticipated calls to this function before returning to the calling level). Failure to do that will result in memory leaks. It is not necessary to free these data containers between consecutive calls to this function at the same IDL level (e.g. inside the same procedure).

Version
$Id$

Parameters
result
out, required
variable 		The result as described above.
sig_off
in/out, required
variable 		An uncalibrated spectrum with no cal signal.
sig_on
in, required
spectrum 		An uncalibrated spectrum with a cal signal.

Keywords
tcal
in, optional
float 		A scalar value for the cal temperature (K). If not supplied. sig_off.mean_tcal will be used.

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