Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

dish.aver - Function

	Package	dish
	Module	dish
	Tool	dish

Average a group of scans or subscans.

Synopsis
aver(scanlist, subscanlist, weighting, alignment)

Description
This function permits flexible averaging and selection/averaging of scans. The scanlist should contain a vector of integers indicating which scans to average, and the subscanlist optionally specifies which records within each scan to include. The subscanlist can either be a vector of integers or a string identifier, as outlined here:

• subscanlist = [1,2,3] : this will select only records 1-3 for averaging from the specified scans.
• subscanlist = 'even' : this will select every even numbered record from the specified scans. (e.g., [2,4,6,8,...]).
• subscanlist = 'odd' : this will select every odd numbered record from the specified scans. (e.g., [1,3,5,7,...]).
• subscanlist = 'n/m' : this will select only record n from each group of m records. For example:
  • '1/4' will select records [1,5,9,13,...]
  • '3/4' will select records [3,7,11,15,...]

Arguments

scanlist		a vector of scan numbers
		Allowed:	vector of integers
subscanlist		a vector of subscans or 'odd','even','n/m'
		Allowed:	vector of integers
		Default:	all
weighting		NONE, RMS, TSYS
		Allowed:	string
		Default:	RMS
alignment		NONE, VELOCITY, XAXIS
		Allowed:	string
		Default:	NONE

Returns
An SDRecord

Example

myavg := d.aver([2,3,4],[1,3]);  # myavg will contain the average of
                                 # subscans 1 and 3 in scans 2-4.