LightFlagger: Tool for manual and automatic flagging. More...

#include <LightFlagger.h>

Public Member Functions
	LightFlagger ()
	default constructor
	~LightFlagger ()
	default destructor
Bool	attach (String msname)
	Attach to a measurement se.
Bool	setdata (String field="", String spw="", String array="", String feed="", String scan="", String baseline="", String uvrange="", String time="", String correlation="")
	Set the data selection parameters.
Bool	setparameters (String algorithm, Record &parameters)
	Set autoflag params.
Record	getparameters (String algorithm)
	Get default autoflag params.
Record	run (Record &parameters)
	Run all the algorithms.
Bool	saveFlagVersion (String versionname, String comment, String merge)
	flag version support.
Bool	restoreFlagVersion (Vector< String > versionname, String merge)
Bool	deleteFlagVersion (Vector< String > versionname)
Bool	getFlagVersionList (Vector< String > &verlist)
Private Member Functions
Record	defaultParameters ()
void	initParameters (Record &parameters)
Bool	setupIterator ()
Bool	readVisAndFlags (VisBuffer &vb, uInt timecnt)
Bool	writeFlags (VisibilityIterator &vi, VisBuffer &vb, uInt timecnt)
void	Ants (uInt bs, uInt a1, uInt a2)
uInt	BaselineIndex (uInt row, uInt a1, uInt a2)
void	AllocateMemory ()
void	runAllMethods (Int threadindex, Int nmethods, Int nthreads, uInt numT, uInt numAnt, uInt numB, uInt numC, uInt nPol)
Private Attributes
MeasurementSet	ms_p
MeasurementSet	mssel_p
MSSelection	mss_p
VisSet *	vs_p
Vector< CountedPtr< LFBase > >	flagmethods_p
	List of flagging agents.
Int	maxnumthreads_p
Bool	ShowPlots
	Generic input parameters.
Bool	WriteFlagsToMS
Bool	StopAndExit
Bool	FlagZeros
Bool	UsePreFlags
Int	NumTime
Int	FlagLevel
String	Expr
String	Column
Vector< Int >	selCorr
Vector< Bool >	baselineFlag
uInt	NumT
	Shapes per chunk.
uInt	NumB
uInt	NumAnt
uInt	NumC
uInt	NumP
uInt	Nrow
uInt	Ncorr
IPosition	VisCubeShp
Cube< Float >	visc
	Data Mapper Vector<Bool> dmCorrs; Bool SetupDataMapper();.
Cube< Bool >	flagc
Cube< Bool >	preflagc
Vector< Int >	ant1
Vector< Int >	ant2
Bool	dbg
	LogIO os;.

Detailed Description

LightFlagger: Tool for manual and automatic flagging.

Intended use:

Prerequisite

Flagger/LFBase
MS/MSSelection
casadbus/PlotServerProxy and FlagPlotServerProxy

Etymology

A lighter version of the existing flagger. This should eventually replace the Flagger.

Synopsis

LightFlagger performs manual and automated flagging operations on a measurement set. -- Attaches to an MS, with subsets decided via MSSelection. -- Contains one or more flagging methods of types derived from LFBase -- Iterates through the MS using a VisibilityIterator -- For each visbuffer, send each flagmethod the data and flags (by reference). -- Each flagmethod modifies the flags (in sequence, and in place). -- A FlagDisplay method displays data and flags as the visbuffers iterate by -- A record of summary statistics is returned after all the data has been traversed.

Example

Construct MS MeasurementSet ms("test.MS2",Table::Update);

Construct LightFlagger LightFlagger flagger(ms);

Build record of global flagging options Record gen_options(); gen_options.define("showplots",True); gen_options.define("writeflags",False);

Build record of flagging-agent options (can read default params first) Record algo_options( flagger.getparameters("tfcrop") ); algo_options.define("freq_amp_cutoff",3.0);

Send flagging-agent parameters to the flagger flagger.setparameters("tfcrop",algo_options);

Run it. flagger.run(gen_options);

Motivation

The existing Flagger infrastructure needs clean-up.

To Do

Add a new LFManualFlag class for manual flagging and 'quacking'.
Add data-expression functionality for the user to control what to flag on.
Add a new LFClip for simple amplitude-threshold clipping
Add a new LFFilters for 1D sliding-window statistical filters
Add flag statistics counts to LFFlagDisplay
Allow extensions across polarization, baseline, time,freq in LFExtendFlags
Add support for saving/reading parameters to/from Flag_Cmd strings
Use async visbuffer I/O (the dominant cost is I/O).
Create a task interface to replace flagdata/flagdata2

Definition at line 122 of file LightFlagger.h.

Constructor & Destructor Documentation

casa::LightFlagger::LightFlagger ( )

default constructor

casa::LightFlagger::~LightFlagger ( )

default destructor

Member Function Documentation

void casa::LightFlagger::AllocateMemory ( ) [private]

void casa::LightFlagger::Ants	(	uInt	bs,
		uInt *	a1,
		uInt *	a2
	)		`[private]`

Bool casa::LightFlagger::attach ( String msname )

Attach to a measurement se.

uInt casa::LightFlagger::BaselineIndex	(	uInt	row,
		uInt	a1,
		uInt	a2
	)		`[private]`

Record casa::LightFlagger::defaultParameters ( ) [private]

Bool casa::LightFlagger::deleteFlagVersion ( Vector< String > versionname )

Bool casa::LightFlagger::getFlagVersionList ( Vector< String > & verlist )

Record casa::LightFlagger::getparameters ( String algorithm )

Get default autoflag params.

void casa::LightFlagger::initParameters ( Record & parameters ) [private]

Bool casa::LightFlagger::readVisAndFlags	(	VisBuffer &	vb,
		uInt	timecnt
	)		`[private]`

Bool casa::LightFlagger::restoreFlagVersion	(	Vector< String >	versionname,
		String	merge
	)

Record casa::LightFlagger::run ( Record & parameters )

Run all the algorithms.

void casa::LightFlagger::runAllMethods	(	Int	threadindex,
		Int	nmethods,
		Int	nthreads,
		uInt	numT,
		uInt	numAnt,
		uInt	numB,
		uInt	numC,
		uInt	nPol
	)		`[private]`

Bool casa::LightFlagger::saveFlagVersion	(	String	versionname,
		String	comment,
		String	merge
	)

flag version support.

Bool casa::LightFlagger::setdata	(	String	field = `""`,
		String	spw = `""`,
		String	array = `""`,
		String	feed = `""`,
		String	scan = `""`,
		String	baseline = `""`,
		String	uvrange = `""`,
		String	time = `""`,
		String	correlation = `""`
	)