1.3.1.0 ms.iterinit

NRAO Home > CASA > CASA Toolkit Reference Manual

ms.iterinit - Function

1.3.1 Initialize for iteration over an ms

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 False. You need to call selectinit before calling this. See the example below.

Arguments


Inputs
columns	Vector of column names (case sensitive).
	allowed:	stringArray
	Default:
interval	Time interval in seconds (greater than 0), to group together in iteration
	allowed:	double
	Default:	0.0
maxrows	Max number of rows (greater than 0) to return in iteration
	allowed:	int
	Default:	0
adddefaultsortcolumns	Add the default sort columns
	allowed:	bool
	Default:	true

Returns
bool

Example

See the example for the iterend function.

__________________________________________________________________

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense