RFAFreqMedian: RedFlagger Agent for clipping relative to median over frequency. More...

#include <RFAMedianClip.h>

Inheritance diagram for casa::RFAFreqMedian:

Public Member Functions
	RFAFreqMedian (RFChunkStats &ch, const RecordInterface &parm)
virtual	~RFAFreqMedian ()
virtual Bool	newChunk (Int &maxmem)
	Called before iterating over a chunk.
virtual RFA::IterMode	iterRow (uInt irow)
	iterRow() is called once per each row in the VisBuffer.
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 Attributes
uInt	halfwin

Detailed Description

RFAFreqMedian: RedFlagger Agent for clipping relative to median over frequency.

Intended use:

Internal

Prerequisite

Synopsis

RFAFreqMedian computes a sliding median of some quantity (as established in RFADiffMapbase) over frequency, per each row. 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 119 of file RFAMedianClip.h.

Constructor & Destructor Documentation

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

virtual casa::RFAFreqMedian::~RFAFreqMedian ( ) [inline, virtual]

Definition at line 123 of file RFAMedianClip.h.

Member Function Documentation

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

returns a Record of all available parameters and their default values

Reimplemented from casa::RFADiffMapBase.

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

called to obtain a short description of this RFA

Reimplemented from casa::RFADiffMapBase.

virtual RFA::IterMode casa::RFAFreqMedian::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 Bool casa::RFAFreqMedian::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.

Member Data Documentation

uInt casa::RFAFreqMedian::halfwin [protected]

Definition at line 131 of file RFAMedianClip.h.

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

code/flagging/Flagging/RFAMedianClip.h

Public Member Functions

Static Public Member Functions

Protected Attributes