RFATimeMedian: RedFlagger Agent for clipping relative to median over time. More...

#include <RFAMedianClip.h>

Inheritance diagram for casa::RFATimeMedian:

Public Member Functions
	RFATimeMedian (RFChunkStats &ch, const RecordInterface &parm)
virtual	~RFATimeMedian ()
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 IterMode	iterTime (uInt itime)
	Iteration methods for a data pass.
virtual IterMode	iterRow (uInt irow)
	iterRow() is called once per each row in the VisBuffer.
virtual IterMode	endData ()
	Called after a pass is completed successfully (i.e., not stopped by start or iter methods).
virtual String	getDesc ()
	called to obtain a short description of this RFA
Static Public Member Functions
static const RecordInterface &	getDefaults ()
	returns a Record of all available parameters and their default values
Protected Member Functions
MedianSlider &	slider (uInt ich, uInt ifr)
Protected Attributes
uInt	itime
FlagCubeIterator	flag_iter
uInt	halfwin
MedianSlider *	msl

Detailed Description

RFATimeMedian: RedFlagger Agent for clipping relative to median over time.

Intended use:

Internal

Prerequisite

Synopsis

RFATimeMedian computes a sliding median of some quantity (as established in RFADiffMapbase) over time, per each channel. Deviation w/respect to the median is passed to RFADiffBase for the actual flagging.

To Do

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

Definition at line 61 of file RFAMedianClip.h.

Constructor & Destructor Documentation

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

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

Member Function Documentation

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

Called once finished with a chunk.

Reimplemented from casa::RFADiffBase.

virtual IterMode casa::RFATimeMedian::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::RFADiffBase.

static const RecordInterface& casa::RFATimeMedian::getDefaults ( ) [static]

returns a Record of all available parameters and their default values

Reimplemented from casa::RFADiffMapBase.

virtual String casa::RFATimeMedian::getDesc ( ) [virtual]

called to obtain a short description of this RFA

Reimplemented from casa::RFADiffMapBase.

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

virtual IterMode casa::RFATimeMedian::iterTime ( 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::RFADiffMapBase.

virtual Bool casa::RFATimeMedian::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::RFADiffBase.