./guide
flagrec.pro

Last modification date:

Wed Sep 28 13:27:08 2016

flagrec

procedure flagrec, record, [bchan=integer], [echan=integer], [chans=integer], [chanwidth=integer], [idstring=string], [/keep]

Flag a specific record or records in the currently open spectral line data file.

A record number or array of record numbers must be supplied. This routine will flag the indicated channels (or all channels, if bchan and echan are not used) in those record numbers. This is appropriate if you know exactly which specific records need to be flagged. It is usually easier to use flag and let flag work out which records should be flagged. A record number is simply the index number for that spectrum in the input data set.

Flags are applied when the data is actually read into a data container (e.g. get, getrec, getps, getnod, etc). At that point, any flagged data is replaced with the blanked value (not a number, NaN). GBTIDL ignores blanked data. If that data is saved back to a data file, it will be saved as blanked values and no further flagging is necessary. Flags are associated with the data in the file, not with the data in a data container. Once the data is in GBTIDL in a data container, it can be blanked (e.g. replace) but not flagged.

Continuum flagging is not supported.

See Also: Introduction to Blanking and Flagging in the GBTIDL user's guide

Examples

  ; flags all the channels in record number one
  flagrec, 1

  ; flags just the first ten channels in record two
  flagrec, 2, echan=10, idstring="flag first 10 channels"

  ; flags the first ten channels, and channels 50 to 60
  flagrec, 3, bchan=[0,50], echan=[10,60]

  ; flags the same channels as the above example in record four
  flagrec, 4, chans=[5,55], width=5
 

Version

$Id$

Parameters
record in, required integer	The record numbers to be flagged.

Keywords
bchan in, optional integer	Starting channel number (default=0)
echan in, optional integer	Ending channel number (default=last channel)
chans in, optional integer	Channels to flag. Mutually exclusive to bchan and echan keywords.
chanwidth in, optional integer	Buffer of channels surrounding the channels specified in chans keyword. (default=1)
idstring in, optional string (def. "unspecified")	A short string describing the flag.
keep in, optional boolean	Flag the keep (output) data source.