RFADiffBase.h

Classes

RFADiffBase -- RFADiffBase: abstract class for deviation-based flagging (full description)
RFADiffMapBase -- Abstract base class for deviation-based flagging with a data mapper. (full description)

class RFADiffBase : public RFAFlagCubeBase, public PGPlotEnums

Interface

Public Members
RFADiffBase ( RFChunkStats &ch,const RecordInterface &parm )
virtual ~RFADiffBase ()
virtual uInt estimateMemoryUse ()
virtual Bool newChunk ( Int &maxmem )
virtual void endChunk ()
virtual void startData ()
virtual void startDry ()
virtual IterMode iterTime (uInt it)
virtual IterMode iterDry (uInt it)
virtual IterMode endData ()
virtual IterMode endDry ()
virtual String getDesc ()
static const RecordInterface & getDefaults ()
void setDebug( const RFDebugPlot &dbg )
Protected Members
void startDataRow (uInt ifr)
Float setDiff (uInt ich,uInt ifr,Float d,Bool &flagged = dummy_Bool )
void endDataRow (uInt ifr)
Float updateSigma ()
virtual RFlagWord newCorrMask () =0
void resetPlot ()
void makePlot ()

Description

Prerequisite

Etymology

Diff = Deviation. Well, almost...

Synopsis

Several flagging algorithms flag by analyzing the deviation w/respect to something at each point. RFADiffBase provides common functions for these classes. It will maintain a lattice of deviations, compute the noise level estimates, and flag points. It will also flag rows with excessive noise level (using RFRowClipper). Derived classes are responsible for computing the deviation.

To Do

Member Description

RFADiffBase ( RFChunkStats &ch,const RecordInterface &parm )

virtual ~RFADiffBase ()

virtual uInt estimateMemoryUse ()

virtual Bool newChunk ( Int &maxmem )

virtual void endChunk ()

virtual void startData ()

virtual void startDry ()

virtual IterMode iterTime (uInt it)

virtual IterMode iterDry (uInt it)

virtual IterMode endData ()

virtual IterMode endDry ()

virtual String getDesc ()

static const RecordInterface & getDefaults ()

void setDebug( const RFDebugPlot &dbg )

sets up a debugging plot object

void startDataRow (uInt ifr)

prepares for a pass over one data row

Float setDiff (uInt ich,uInt ifr,Float d,Bool &flagged = dummy_Bool )

updates the diff lattice with a value, and performs clipping

void endDataRow (uInt ifr)

ends pass over single data row

Float updateSigma ()

updates noise estimates (sih0), returns the max change

virtual RFlagWord newCorrMask () =0

computes a correlations mask. Called once for each chunk (since correlations can change from chunk to chunk)

void resetPlot ()

methods and members for making debugging plots Resets vectors (for start of new plot)

void makePlot ()

Makes a plot using the filled-in vectors (below)

class RFADiffMapBase : public RFADiffBase, protected RFDataMapper

Interface

Public Members
RFADiffMapBase ( RFChunkStats &ch,const RecordInterface &parm )
virtual ~RFADiffMapBase ()
virtual IterMode iterTime (uInt it)
virtual String getDesc ()
static const RecordInterface & getDefaults ()
Protected Members
virtual RFlagWord newCorrMask ()
void setupMapper ()

Description

Prerequisite

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 Float value.

To Do

Member Description

RFADiffMapBase ( RFChunkStats &ch,const RecordInterface &parm )

virtual ~RFADiffMapBase ()

virtual IterMode iterTime (uInt it)

virtual String getDesc ()

static const RecordInterface & getDefaults ()

returns a Record of all available parameters and their default values

virtual RFlagWord newCorrMask ()

void setupMapper ()