Abstract base class for deviation-based flagging with a data mapper. More...

#include <RFADiffBase.h>

Inheritance diagram for casa::RFADiffMapBase:

Public Member Functions
	RFADiffMapBase (RFChunkStats &ch, const casacore::RecordInterface &parm)

virtual	~RFADiffMapBase ()

virtual IterMode	iterTime (casacore::uInt it)
	Iteration methods for a data pass. More...

virtual casacore::String	getDesc ()
	called to obtain a short description of this RFA More...

Public Member Functions inherited from casa::RFADiffBase
	RFADiffBase (RFChunkStats &ch, const casacore::RecordInterface &parm)

virtual	~RFADiffBase ()

virtual casacore::uInt	estimateMemoryUse ()
	This method is called before iterating over a chunk, to inquire the expected memory use. More...

virtual casacore::Bool	newChunk (casacore::Int &maxmem)
	Called before iterating over a chunk. More...

virtual void	endChunk ()
	Called once finished with a chunk. More...

virtual void	startData (bool verbose)
	Called before starting a data pass on a chunk. More...

virtual void	startDry (bool verbose)
	Called before starting a dry pass on a chunk. More...

virtual IterMode	iterDry (casacore::uInt it)
	Iteration method for a dry pass. More...

virtual IterMode	endData ()
	Called after a pass is completed successfully (i.e., not stopped by start or iter methods). More...

virtual IterMode	endDry ()
	Called after a dry pass is complete. More...

Public Member Functions inherited from casa::RFAFlagCubeBase
	RFAFlagCubeBase (RFChunkStats &ch, const casacore::RecordInterface &parm)

virtual	~RFAFlagCubeBase ()

virtual void	startFlag (bool verbose)
	Called before starting the fetch-flags pass. More...

virtual void	iterFlag (casacore::uInt it)
	Iteration method for a flag pass. More...

virtual casacore::String	getStats ()
	called (before endChunk()) to obtain a statistics report More...

virtual casacore::String	getID ()

Public Member Functions inherited from casa::RFABase
	RFABase (RFChunkStats &ch, const casacore::RecordInterface &parm)
	An agent is always constructed from a chunk stats accessor, and a record of parameters. More...

virtual	~RFABase ()
	Destructor. More...

virtual void	init ()
	This method is called after constructing the agent. More...

virtual void	endFlag ()
	Called after a flag pass is complete. More...

virtual void	endRows (casacore::uInt)
	Called at end of time chunk. More...

virtual IterMode	iterRow (casacore::uInt)
	iterRow() is called once per each row in the VisBuffer. More...

virtual void	printFlaggingReport ()

const casacore::String &	name ()
	returns the name of this RFA (set in myname) More...

casacore::Bool	isActive ()
	returns the active status More...

casacore::LogIO &	logSink ()
	accessor to a casacore::LogIO for this agent More...

virtual casacore::Record	getResult ()

virtual void	finalize ()

virtual void	initialize ()
	Initialize chunk. More...

virtual void	initializeIter (casacore::uInt)

virtual void	finalizeIter (casacore::uInt)

virtual void	setNAgent (casacore::uInt n)

virtual void	setOnlySelector (bool only_sel)

Static Public Member Functions
static const casacore::RecordInterface &	getDefaults ()
	returns a casacore::Record of all available parameters and their default values More...

Static Public Member Functions inherited from casa::RFADiffBase
static const casacore::RecordInterface &	getDefaults ()

Static Public Member Functions inherited from casa::RFAFlagCubeBase
static const casacore::RecordInterface &	getDefaults ()

Static Public Member Functions inherited from casa::RFABase
static void	setIndexingBase (casacore::uInt base)
	static method for setting the indexing base for agent arguments More...

Protected Member Functions
virtual RFlagWord	newCorrMask ()
	computes a correlations mask. More...

void	setupMapper ()

Protected Member Functions inherited from casa::RFADiffBase
void	startDataRow (casacore::uInt ifr)
	prepares for a pass over one data row More...

casacore::Float	setDiff (casacore::uInt ich, casacore::uInt ifr, casacore::Float d, casacore::Bool &flagged=dummy_Bool)
	updates the diff lattice with a value, and performs clipping More...

void	endDataRow (casacore::uInt ifr)
	ends pass over single data row More...

casacore::Float	updateSigma ()
	updates noise estimates (sih0), returns the max change More...

Protected Member Functions inherited from casa::RFABase
casacore::uInt	num (StatEnums which)

RFlagWord	corrMask ()

Protected Member Functions inherited from casa::RFDataMapper
casacore::Float	dummyRowMapper (casacore::uInt)
	various row mappers More...

casacore::Float	U_RowMapper (casacore::uInt)

casacore::Float	V_RowMapper (casacore::uInt)

casacore::Float	W_RowMapper (casacore::uInt)

casacore::Float	AbsU_RowMapper (casacore::uInt)

casacore::Float	AbsV_RowMapper (casacore::uInt)

casacore::Float	AbsW_RowMapper (casacore::uInt)

casacore::Float	UVD_RowMapper (casacore::uInt)

casacore::Float	UVA_RowMapper (casacore::uInt)

casacore::Float	HA_RowMapper (casacore::uInt)

	RFDataMapper (const casacore::String &col, DDMapper *map)
	construct from a column and a DDMapper More...

	RFDataMapper (const casacore::Vector< casacore::String > &expr, const casacore::String &defcol="")
	construct from a column and an expression More...

	~RFDataMapper ()
	destructor More...

MapperType	type ()
	returns type of mapper More...

casacore::Double	getValueCycle ()
	If the value being mapped into is cyclic (i.e. More...

casacore::Double	getValueBase ()
	Returns base of a cyclic value (e.g. More...

casacore::Float	mapValue (casacore::uInt ich, casacore::uInt irow)
	gets a value from the DDMapper More...

casacore::Float	mapValue (casacore::uInt irow)
	gets a value from the row mapper More...

RFlagWord	corrMask (const VisibilityIterator &vi)
	uses mapper to compute a correlations mask More...

void	setVisBuffer (VisBuffer &vb)
	point the datamapper at a visbuffer - called for every new buffer More...

casacore::String	description () const
	returns description More...

casacore::String	descExpression () const
	returns description of expression More...

Additional Inherited Members
Public Types inherited from casa::RFABase
enum	IterMode { STOP, DRY, DATA, CONT }
	iteration modes More...

Public Types inherited from casa::FlaggerEnums
enum	StatEnums { POLZN, POL, CORR, CHAN, IFR, TIME, ROW, ANT, FEED, FEEDCORR, NONE, Num_StatEnums }

enum	PreFlagPolicy { FL_HONOR, FL_IGNORE, FL_RESET }

Protected Types inherited from casa::RFDataMapper
enum	MapperType { MAPROW, MAPCORR }
	type of data mapper: row or individual correlations More...

typedef casacore::Cube < casacore::Complex > (	CubeMapperFunc )(VisBuffer &)
	a cube mapper function maps a visbuffer to a data cube. More...

Static Protected Member Functions inherited from casa::RFABase
static casacore::uInt	indexingBase ()
	global flag indicates that Glish (1-based) indexing is in use for agent arguments More...

Static Protected Member Functions inherited from casa::RFDataMapper
static CubeMapperFunc	getCubeMapper (const casacore::String &col, casacore::Bool throw_excp=false)
	static helper function to interpret constructor parameters into a cube mapper More...

Protected Attributes inherited from casa::RFADiffBase
casacore::Double	clip_level

casacore::Double	row_clip_level

casacore::Bool	disable_row_clip

casacore::Bool	clipping_rows

RFFloatLattice	diff

FlagCubeIterator *	pflagiter

RFRowClipper	rowclipper

casacore::Vector< casacore::Float >	diffrow

int	idiffrow

casacore::Matrix< casacore::Float >	sig

casacore::Matrix< casacore::Float >	sig0

casacore::LogicalVector	sigupdated

Protected Attributes inherited from casa::RFAFlagCubeBase
RFlagWord	corrmask
	mask of active correlations. More...

RFFlagCube	flag
	flag cube lattice More...

Protected Attributes inherited from casa::RFABase
casacore::uInt	nAgent

RFChunkStats &	chunk

casacore::Record	params

casacore::String	myname

bool	only_selector

RFlagWord	corrmask
	Bit mask of correlations which are used & flagged by this RFA. More...

casacore::Bool	active
	flag: agent is active for this chunk (set in newChunk) More...

casacore::LogIO	os

Protected Attributes inherited from casa::RFDataMapper
casacore::String	expr_desc

casacore::String	desc

DDMapper *	ddm

RowMapperFunc	rowmapper

casacore::Cube < casacore::Complex > *	pviscube

casacore::Vector < casacore::RigidVector < casacore::Double, 3 > > *	puvw

CubeMapperFunc	cubemap

MapperType	mytype

casacore::Double	full_cycle

casacore::Double	cycle_base

casacore::Double	sin_dec
	required by the HA mapper - sin(declination) of phase center; More...

Static Protected Attributes inherited from casa::RFADiffBase
static casacore::Bool	dummy_Bool

Detailed Description

Abstract base class for deviation-based flagging with a data mapper.

Intended use:

Internal

Prerequisite

RFDataMapper

Synopsis

This is another abstract class on top of DiffBase. It is also inherited from RFDataMapper, so it includes functions for mapping visibilities to a single casacore::Float value.

To Do

add this feature
fix this bug
start discussion of this possible extension

Definition at line 157 of file RFADiffBase.h.

Constructor & Destructor Documentation

casa::RFADiffMapBase::RFADiffMapBase	(	RFChunkStats &	ch,
		const casacore::RecordInterface &	parm
	)

virtual casa::RFADiffMapBase::~RFADiffMapBase ( )

virtual

Member Function Documentation

static const casacore::RecordInterface& casa::RFADiffMapBase::getDefaults ( )

static

returns a casacore::Record of all available parameters and their default values

virtual casacore::String casa::RFADiffMapBase::getDesc ( )

virtual

called to obtain a short description of this RFA

Reimplemented from casa::RFADiffBase.

Reimplemented in casa::RFAFreqMedian, and casa::RFATimeMedian.

virtual IterMode casa::RFADiffMapBase::iterTime ( casacore::uInt )

virtual

Iteration methods for a data pass.

Either or both may be implemented. iterTime() is called once for each new VisBuffer (= new time slot) Return value: STOP to finish iterating, CONT/DATA to continue, or DRY to cancel the data pass and request a dry pass.

Reimplemented from casa::RFADiffBase.

Reimplemented in casa::RFATimeMedian.

virtual RFlagWord casa::RFADiffMapBase::newCorrMask ( )

inlineprotectedvirtual

computes a correlations mask.

Called once for each chunk (since correlations can change from chunk to chunk)

Implements casa::RFADiffBase.

Definition at line 171 of file RFADiffBase.h.

References casa::RFABase::chunk, casa::RFDataMapper::corrMask(), and casa::RFChunkStats::visIter().

void casa::RFADiffMapBase::setupMapper ( )

inlineprotected

Definition at line 174 of file RFADiffBase.h.