casa::RFAFlagCubeBase Class Reference

Abstract RedFlagger Agent class with a flag cube. More...

#include <RFAFlagCubeBase.h>

Inheritance diagram for casa::RFAFlagCubeBase:

Public Member Functions
	RFAFlagCubeBase (RFChunkStats &ch, const casacore::RecordInterface &parm)
virtual	~RFAFlagCubeBase ()
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 void	startFlag (bool verbose)
	Called before starting the fetch-flags pass. More...
virtual IterMode	iterTime (casacore::uInt it)
	Iteration methods for a data pass. More...
virtual IterMode	iterDry (casacore::uInt it)
	Iteration method for a dry pass. More...
virtual void	iterFlag (casacore::uInt it)
	Iteration method for a flag 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...
virtual casacore::String	getDesc ()
	called to obtain a short description of this RFA 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 ()
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 Attributes
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

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 Member Functions inherited from casa::RFABase
casacore::uInt	num (StatEnums which)
RFlagWord	corrMask ()
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...

Detailed Description

Abstract RedFlagger Agent class with a flag cube.

Intended use:

Internal

Prerequisite

• RFFlagCube

Synopsis

RFAFlagCubeBase is derived from RFABase. It includes an RFFlagCube object, which is essentially an [NCHAN,NIFR,NTIME] lattice of flags. Approrpiate vritual methods for managing the cube are defined.

To Do

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

Definition at line 61 of file RFAFlagCubeBase.h.

Constructor & Destructor Documentation

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

virtual casa::RFAFlagCubeBase::~RFAFlagCubeBase ( )

virtual

Member Function Documentation

virtual void casa::RFAFlagCubeBase::endChunk ( )

virtual

Called once finished with a chunk.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFATimeFreqCrop, casa::RFAFlagExaminer, casa::RFASpectralRej, casa::RFAUVBinner, casa::RFANewMedianClip, and casa::RFATimeMedian.

virtual IterMode casa::RFAFlagCubeBase::endData ( )

virtual

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

Return value: STOP to stop, DATA for another data pass, DRY for another dry pass.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFATimeFreqCrop, casa::RFAUVBinner, casa::RFANewMedianClip, casa::RFASpectralRej, and casa::RFATimeMedian.

virtual IterMode casa::RFAFlagCubeBase::endDry ( )

virtual

Called after a dry pass is complete.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFAUVBinner, and casa::RFANewMedianClip.

virtual casacore::uInt casa::RFAFlagCubeBase::estimateMemoryUse ( )

virtual

This method is called before iterating over a chunk, to inquire the expected memory use.

Should return the max desired memory footprint, in MB. Available physical memory is divided between agents in proportion to their requests.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFASelector, casa::RFASpectralRej, casa::RFAUVBinner, and casa::RFANewMedianClip.

Referenced by casa::RFASpectralRej::estimateMemoryUse(), and casa::RFASelector::estimateMemoryUse().

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

static

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

virtual

called to obtain a short description of this RFA

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffMapBase, casa::RFAFreqMedian, casa::RFADiffBase, casa::RFASelector, casa::RFAUVBinner, casa::RFANewMedianClip, casa::RFASpectralRej, and casa::RFATimeMedian.

virtual casacore::String casa::RFAFlagCubeBase::getID ( )

inlinevirtual

Reimplemented from casa::RFABase.

Reimplemented in casa::RFAFlagExaminer.

Definition at line 83 of file RFAFlagCubeBase.h.

virtual casacore::String casa::RFAFlagCubeBase::getStats ( )

virtual

called (before endChunk()) to obtain a statistics report

Reimplemented from casa::RFABase.

virtual IterMode casa::RFAFlagCubeBase::iterDry ( casacore::uInt  )

virtual

Iteration method for a dry pass.

Called once per each time slot. Return value: STOP to finish iterating, CONT/DRY to continue, or DATA to cancel the dry pass and request another data pass.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFAUVBinner, and casa::RFANewMedianClip.

virtual void casa::RFAFlagCubeBase::iterFlag ( casacore::uInt  )

virtual

Iteration method for a flag pass.

Called once per each VisBuffer.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFATimeFreqCrop, casa::RFASelector, and casa::RFAFlagExaminer.

virtual IterMode casa::RFAFlagCubeBase::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::RFABase.

Reimplemented in casa::RFADiffMapBase, casa::RFADiffBase, casa::RFATimeFreqCrop, casa::RFASelector, casa::RFASpectralRej, casa::RFAUVBinner, casa::RFANewMedianClip, and casa::RFATimeMedian.

virtual casacore::Bool casa::RFAFlagCubeBase::newChunk ( casacore::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 casacore::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::RFABase.

Reimplemented in casa::RFAFreqMedian, casa::RFADiffBase, casa::RFATimeFreqCrop, casa::RFASelector, casa::RFAFlagExaminer, casa::RFASpectralRej, casa::RFAUVBinner, casa::RFANewMedianClip, and casa::RFATimeMedian.

virtual void casa::RFAFlagCubeBase::startData ( bool  )

virtual

Called before starting a data pass on a chunk.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFATimeFreqCrop, casa::RFASelector, casa::RFAFlagExaminer, casa::RFASpectralRej, casa::RFAUVBinner, casa::RFANewMedianClip, and casa::RFATimeMedian.

Referenced by casa::RFAFlagExaminer::startData().

virtual void casa::RFAFlagCubeBase::startDry ( bool  )

virtual

Called before starting a dry pass on a chunk.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFADiffBase, casa::RFAUVBinner, and casa::RFANewMedianClip.

virtual void casa::RFAFlagCubeBase::startFlag ( bool  )

virtual

Called before starting the fetch-flags pass.

Reimplemented from casa::RFABase.

Reimplemented in casa::RFATimeFreqCrop, and casa::RFAFlagExaminer.

Member Data Documentation

RFlagWord casa::RFAFlagCubeBase::corrmask

protected

mask of active correlations.

Must be setup somewhere before calling newChunk()

Definition at line 83 of file RFAFlagCubeBase.h.

RFFlagCube casa::RFAFlagCubeBase::flag

protected

flag cube lattice

Definition at line 90 of file RFAFlagCubeBase.h.

---

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

• casa/code/flagging/Flagging/RFAFlagCubeBase.h