ms.iterinit - Function

Initialize for iteration over a MS

Synopsis
iterinit(columns, interval, maxrows, adddefaultsortcolumns)

Arguments

columns	in	Double quoted string with column names
		Allowed:	Vector of strings
		Default:	no default
interval	in	Time interval in seconds, to group together in iteration
		Allowed:	Positive number
		Default:	no default
maxrows	in	Max number of rows to return in iteration
		Allowed:	Positive integer
		Default:	no default
adddefaultsortcolumns	in	Add the default sort columns
		Allowed:	Boolean
		Default:	T

Returns
Boolean

Description
Specify the columns to iterate over and the time interval to use for the TIME column iteration. The columns are specified by their MS column name. Note that the following columns are always added to the specified columns: array_id, field_id, data_desc_id and time. This is so that the iterator can keep track of the coordinates associated with the data (field direction, frequency etc.) If you want to sort on these columns last instead of first you need to include them in the columns specified. If you don't want to sort on these columns at all, you can set adddefaultsortcolumns to F. You need to call selectinit before calling this. See the example below.

Example
See the example for the iterend function.

Next: ms.iterorigin - Function Up: ms - Tool Previous: ms.split - Function Contents Index

	Package	general
	Module	ms
	Tool	ms