casa::RFANewMedianClip Class Reference
[Flagging_internal_classes]

#include <RFANewMedianClip.h>

Inheritance diagram for casa::RFANewMedianClip:

Inheritance graph
[legend]
Collaboration diagram for casa::RFANewMedianClip:

Collaboration graph
[legend]
List of all members.

Detailed Description

RFANewMedianClip:RedFlagger Agent;clips relative to median over time slots.

Intended use:

Internal

Prerequisite

Synopsis

RFANewMedianClip computes a median of some quantity over time slots, per each channel. Deviation w/respect to the median is computed for the actual flagging.

To Do

Definition at line 66 of file RFANewMedianClip.h.

Public Member Functions

 RFANewMedianClip (RFChunkStats &ch, const RecordInterface &parm)
virtual ~RFANewMedianClip ()
virtual uInt estimateMemoryUse ()
 This method is called before iterating over a chunk, to inquire the expected memory use.
virtual Bool newChunk (Int &maxmem)
 Called before iterating over a chunk.
virtual void endChunk ()
 Called once finished with a chunk.
virtual void startData ()
 Called before starting a data pass on a chunk.
virtual void startDry ()
 Called before starting a dry 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 iterDry (uInt it)
 Iteration method for a dry pass.
virtual IterMode endData ()
 Called after a pass is completed successfully (i.e., not stopped by start or iter methods).
virtual IterMode endDry ()
 Called after a dry pass is complete.
virtual String getDesc ()
 called to obtain a short description of this RFA

Static Public Member Functions

static const RecordInterface & getDefaults ()

Protected Member Functions

MedianSlider & slider (uInt ich, uInt ifr)
void makePlot (PGPlotterInterface &pgp, uInt ich)

Protected Attributes

MedianSlider globalmed
FlagCubeIteratorpflagiter
FlagCubeIterator flag_iter
Double threshold
MedianSlider * msl
RFCubeLattice< Float > evalue
 lattice of evaluated values [NCH,NIFR,NTIME]
Matrix< Float > stdev
 matrix of standard deviation [NCH,NIFR]
Bool stdeved
Double globalsigma


Constructor & Destructor Documentation

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

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


Member Function Documentation

virtual uInt casa::RFANewMedianClip::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::RFAFlagCubeBase.

virtual Bool casa::RFANewMedianClip::newChunk ( Int &  maxmem  )  [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.

Reimplemented from casa::RFAFlagCubeBase.

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

Called once finished with a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFANewMedianClip::startData (  )  [virtual]

Called before starting a data pass on a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFANewMedianClip::startDry (  )  [virtual]

Called before starting a dry pass on a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual IterMode casa::RFANewMedianClip::iterTime ( uInt  itime  )  [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::RFAFlagCubeBase.

virtual IterMode casa::RFANewMedianClip::iterRow ( uInt  irow  )  [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::RFANewMedianClip::iterDry ( uInt  it  )  [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::RFAFlagCubeBase.

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

virtual IterMode casa::RFANewMedianClip::endDry (  )  [virtual]

Called after a dry pass is complete.

Reimplemented from casa::RFAFlagCubeBase.

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

called to obtain a short description of this RFA

Reimplemented from casa::RFAFlagCubeBase.

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

Reimplemented from casa::RFAFlagCubeBase.

MedianSlider & casa::RFANewMedianClip::slider ( uInt  ich,
uInt  ifr 
) [inline, protected]

Definition at line 106 of file RFANewMedianClip.h.

References casa::FlaggerEnums::CHAN, msl, and casa::RFABase::num().

void casa::RFANewMedianClip::makePlot ( PGPlotterInterface &  pgp,
uInt  ich 
) [protected]


Member Data Documentation

MedianSlider casa::RFANewMedianClip::globalmed [protected]

Definition at line 88 of file RFANewMedianClip.h.

FlagCubeIterator* casa::RFANewMedianClip::pflagiter [protected]

Definition at line 91 of file RFANewMedianClip.h.

FlagCubeIterator casa::RFANewMedianClip::flag_iter [protected]

Definition at line 92 of file RFANewMedianClip.h.

Double casa::RFANewMedianClip::threshold [protected]

Definition at line 93 of file RFANewMedianClip.h.

MedianSlider* casa::RFANewMedianClip::msl [protected]

Definition at line 95 of file RFANewMedianClip.h.

Referenced by slider().

RFCubeLattice<Float> casa::RFANewMedianClip::evalue [protected]

lattice of evaluated values [NCH,NIFR,NTIME]

Definition at line 98 of file RFANewMedianClip.h.

Matrix<Float> casa::RFANewMedianClip::stdev [protected]

matrix of standard deviation [NCH,NIFR]

Definition at line 100 of file RFANewMedianClip.h.

Bool casa::RFANewMedianClip::stdeved [protected]

Definition at line 101 of file RFANewMedianClip.h.

Double casa::RFANewMedianClip::globalsigma [protected]

Definition at line 102 of file RFANewMedianClip.h.


The documentation for this class was generated from the following file:
Generated on Thu Aug 27 21:32:09 2009 for NRAOCASA by  doxygen 1.5.1