Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

msplotapplyflags - Function

	Package	general
	Module	ms

Apply flag columns

Synopsis
msplotapplyflags(flagfile, msfile, merge)

Description
msplot can, during a flagging session, create a table that contains the contents of the FLAG & FLAG_ROW columns of the measurement set. This function can copy the flags from this ``flag'' table back into the corresponding columns of the measurement set.

The name of the measurement set that was used to create the ``flag'' table is stored in the flag table and it is not necessary to specify which measurement set the ``flag'' table is associated with. You can apply the ``flag'' table to a different measurement set by specifying its name using the msfile argument. It is critical that the alternate measurement set have the same number of rows, and that the data in each row of be the same shape as the measurement set from which the flag table was derived. In practice this means the the alternate measurement set should be derived in some way from the original one.

Normally the flags in the ``flag'' table will replace those in the measurement set. It is possible to merge the flags so that the resultant flags are the logical OR of those already in the measurement set and the flags in the ``flag'' table. This is done by setting the merge argument to T.

Arguments

flagfile		Name of flag file
		Allowed:	String
		Default:	no default
msfile		Name of measurement set
		Allowed:	String
		Default:	unset
merge		Merge the flags from both tables
		Allowed:	Boolean
		Default:	F

Returns
T or fail

Example

      include 'msplot.g';
      msplotapplyflags('3C273XC1.ms.flags.12')

This example applies the flags in the table called 3C273XC1.flags.12 to a measurements set called 3C273XC1.ms in the same directory.