RFAFlagExaminer: Examine the flags and get statistics. perform extensions too. More...

#include <RFAFlagExaminer.h>

Inheritance diagram for casa::RFAFlagExaminer:

Public Member Functions
	RFAFlagExaminer (RFChunkStats &ch, const RecordInterface &parm)
	constructor.
virtual	~RFAFlagExaminer ()
virtual void	iterFlag (uInt it)
	Iteration method for a flag pass.
virtual IterMode	iterRow (uInt irow)
	iterRow() is called once per each row in the VisBuffer.
virtual Bool	newChunk (Int &maxmem)
	Called before iterating over a chunk.
virtual void	endChunk ()
	Called once finished with a chunk.
virtual void	startData (bool verbose)
	Called before starting a data pass on a chunk.
virtual void	startFlag (bool verbose)
	Called before starting the fetch-flags pass.
virtual void	endFlag ()
	Called after a flag pass is complete.
virtual void	finalize ()
virtual void	initialize ()
	Initialize chunk.
virtual void	initializeIter (uInt it)
virtual void	finalizeIter (uInt it)
virtual String	getID ()
virtual Record	getResult ()
Private Member Functions
void	processRow (uInt ifr, uInt it)
	virtual String getDesc (); static const RecordInterface & getDefaults ();
Private Attributes
uInt64	totalflags
uInt64	totalcount
uInt64	totalrowflags
uInt64	totalrowcount
uInt64	accumTotalFlags
	accumulated over all chunks
uInt64	accumTotalCount
uInt64	accumRowFlags
uInt64	accumTotalRowCount
uInt64	accumTotalRowFlags
uInt64	inTotalFlags
	per chunk
uInt64	inTotalCount
uInt64	inTotalRowFlags
uInt64	inTotalRowCount
uInt64	outTotalFlags
uInt64	outTotalCount
uInt64	outTotalRowFlags
uInt64	outTotalRowCount
std::map< std::string, std::map< std::string, uInt64 > >	accumflags
	Statistics per antenna, baseline, spw, etc.
std::map< std::string, std::map< std::string, uInt64 > >	accumtotal
std::vector< uInt64 >	accumflags_channel
std::vector< uInt64 >	accumtotal_channel
std::vector< uInt64 >	accumflags_correlation
std::vector< uInt64 >	accumtotal_correlation

Detailed Description

RFAFlagExaminer: Examine the flags and get statistics. perform extensions too.

Intended use:

Internal

Prerequisite

RFASelector

Etymology

RedFlaggerAgent Selector

Synopsis

RFAFlagExaminer accepts a whole bunch of options to select a subset of the MS (by time, antenna, baseline, channel/frequency, etc.), and to flag/unflag the whole selection, or specific parts of it (autocorrelations, specific time slots, VLA quacks, etc.)

To Do

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

Definition at line 67 of file RFAFlagExaminer.h.

Constructor & Destructor Documentation

casa::RFAFlagExaminer::RFAFlagExaminer	(	RFChunkStats &	ch,
		const RecordInterface &	parm
	)

constructor.

virtual casa::RFAFlagExaminer::~RFAFlagExaminer ( ) [virtual]

Member Function Documentation

virtual void casa::RFAFlagExaminer::endChunk ( ) [virtual]

Called once finished with a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFAFlagExaminer::endFlag ( ) [virtual]

Called after a flag pass is complete.

Reimplemented from casa::RFABase.

virtual void casa::RFAFlagExaminer::finalize ( ) [virtual]

Reimplemented from casa::RFABase.

virtual void casa::RFAFlagExaminer::finalizeIter ( uInt it ) [virtual]

Reimplemented from casa::RFABase.

virtual String casa::RFAFlagExaminer::getID ( ) [inline, virtual]

Reimplemented from casa::RFAFlagCubeBase.

Definition at line 87 of file RFAFlagExaminer.h.

References String.

virtual Record casa::RFAFlagExaminer::getResult ( ) [virtual]

Reimplemented from casa::RFABase.

virtual void casa::RFAFlagExaminer::initialize ( ) [virtual]

Initialize chunk.

Reimplemented from casa::RFABase.

virtual void casa::RFAFlagExaminer::initializeIter ( uInt it ) [virtual]

Reimplemented from casa::RFABase.

virtual void casa::RFAFlagExaminer::iterFlag ( uInt ) [virtual]

Iteration method for a flag pass.

Called once per each VisBuffer.

Reimplemented from casa::RFASelector.

virtual IterMode casa::RFAFlagExaminer::iterRow ( uInt ) [virtual]

iterRow() is called once per each row in the VisBuffer.

Iterating over rows is perhaps preferrable in terms of performance, at least for data iterations.

Reimplemented from casa::RFASelector.

virtual Bool casa::RFAFlagExaminer::newChunk ( Int & ) [virtual]

Called before iterating over a chunk.

Returns True if agent will process this chunk, or False if this the agent is unable to process it. (this can happen if, e.g., the requisite correlations are not present). The Int & maxmem argument is the number of MB memory which is still available in the memory pool. The agent class should plan its memory use accordingly, and subtract its expected memory use from maxmem. In effect, the agent "reserves" some amount of memory. This is used by RedFlagger to contain the total memory footprint. Note that only a rough reckoning is sufficient, so only bother estimating the biggest data structures. See implementations in RFADiffBase and RFATimeMedian for good examples. nAgent is the total number of agents.

Reimplemented from casa::RFASelector.

void casa::RFAFlagExaminer::processRow	(	uInt	ifr,
		uInt	it
	)		`[private, virtual]`

virtual String getDesc (); static const RecordInterface & getDefaults ();

Reimplemented from casa::RFASelector.

virtual void casa::RFAFlagExaminer::startData ( bool ) [inline, virtual]

Called before starting a data pass on a chunk.

Reimplemented from casa::RFASelector.

Definition at line 80 of file RFAFlagExaminer.h.

virtual void casa::RFAFlagExaminer::startFlag ( bool ) [virtual]

Called before starting the fetch-flags pass.

Reimplemented from casa::RFAFlagCubeBase.

Member Data Documentation

std::map<std::string, std::map<std::string, uInt64> > casa::RFAFlagExaminer::accumflags [private]

Statistics per antenna, baseline, spw, etc.

These maps of maps is used e.g. like:

   accumflags["baseline"]["2&&7"] == 42
   accumflags["spw"     ]["0"   ] == 17

which means that there were 42 flags on baseline 2 - 7, etc.

Definition at line 115 of file RFAFlagExaminer.h.

std::vector<uInt64> casa::RFAFlagExaminer::accumflags_channel [private]

Definition at line 118 of file RFAFlagExaminer.h.

std::vector<uInt64> casa::RFAFlagExaminer::accumflags_correlation [private]

Definition at line 120 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::accumRowFlags [private]

Definition at line 101 of file RFAFlagExaminer.h.

std::map<std::string, std::map<std::string, uInt64> > casa::RFAFlagExaminer::accumtotal [private]

Definition at line 116 of file RFAFlagExaminer.h.

std::vector<uInt64> casa::RFAFlagExaminer::accumtotal_channel [private]

Definition at line 119 of file RFAFlagExaminer.h.

std::vector<uInt64> casa::RFAFlagExaminer::accumtotal_correlation [private]

Definition at line 121 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::accumTotalCount [private]

Definition at line 101 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::accumTotalFlags [private]

accumulated over all chunks

Definition at line 101 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::accumTotalRowCount [private]

Definition at line 101 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::accumTotalRowFlags [private]

Definition at line 101 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::inTotalCount [private]

Definition at line 105 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::inTotalFlags [private]

per chunk

Definition at line 105 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::inTotalRowCount [private]

Definition at line 105 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::inTotalRowFlags [private]

Definition at line 105 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::outTotalCount [private]

Definition at line 106 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::outTotalFlags [private]

Definition at line 106 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::outTotalRowCount [private]

Definition at line 106 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::outTotalRowFlags [private]

Definition at line 106 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::totalcount [private]

Definition at line 96 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::totalflags [private]

Definition at line 96 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::totalrowcount [private]

Definition at line 97 of file RFAFlagExaminer.h.

uInt64 casa::RFAFlagExaminer::totalrowflags [private]

Definition at line 97 of file RFAFlagExaminer.h.

The documentation for this class was generated from the following file:

code/flagging/Flagging/RFAFlagExaminer.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Prerequisite

Etymology

Synopsis

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation