casa::RFAApplyFlags Class Reference

#include <RFAApplyFlags.h>

Inheritance diagram for casa::RFAApplyFlags:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 38 of file RFAApplyFlags.h.

Public Member Functions

 RFAApplyFlags (RFChunkStats &ch, const RecordInterface &parm)
virtual ~RFAApplyFlags ()
virtual void init ()
 This method is called after constructing the agent.
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 RFABase::IterMode iterTime (uInt it)
 Iteration methods for a data pass.
virtual RFABase::IterMode iterRow (uInt ir)
 iterRow() is called once per each row in the VisBuffer.
virtual void iterFlag (uInt it)
 Iteration method for a flag pass.
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 void startFlag ()
 Called before starting the fetch-flags pass.
virtual void endChunk ()
 Called once finished with a chunk.
virtual void endFlag ()
 Called after a flag pass is complete.
virtual RFABase::IterMode endData ()
 Called after a pass is completed successfully (i.e., not stopped by start or iter methods).
virtual RFABase::IterMode endDry ()
 Called after a dry pass is complete.

Static Public Member Functions

static const RecordInterface & getDefaults ()
static void setIndices (const std::vector< FlagIndex > *fi)
 virtual RFABase::IterMode iterTime ( uInt itime ) ;

Static Private Attributes

static const std::vector<
FlagIndex > * 
flagIndex


Constructor & Destructor Documentation

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

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


Member Function Documentation

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

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFAApplyFlags::init (  )  [virtual]

This method is called after constructing the agent.

Reimplemented from casa::RFABase.

virtual uInt casa::RFAApplyFlags::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::RFAApplyFlags::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 RFABase::IterMode casa::RFAApplyFlags::iterTime ( uInt  it  )  [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 RFABase::IterMode casa::RFAApplyFlags::iterRow ( uInt  ir  )  [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 void casa::RFAApplyFlags::iterFlag ( uInt  it  )  [virtual]

Iteration method for a flag pass.

Called once per each VisBuffer.

Reimplemented from casa::RFAFlagCubeBase.

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

Called before starting a data pass on a chunk.

Reimplemented from casa::RFAFlagCubeBase.

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

Called before starting a dry pass on a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFAApplyFlags::startFlag (  )  [virtual]

Called before starting the fetch-flags pass.

Reimplemented from casa::RFAFlagCubeBase.

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

Called once finished with a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFAApplyFlags::endFlag (  )  [virtual]

Called after a flag pass is complete.

Reimplemented from casa::RFABase.

virtual RFABase::IterMode casa::RFAApplyFlags::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 RFABase::IterMode casa::RFAApplyFlags::endDry (  )  [virtual]

Called after a dry pass is complete.

Reimplemented from casa::RFAFlagCubeBase.

static void casa::RFAApplyFlags::setIndices ( const std::vector< FlagIndex > *  fi  )  [static]

virtual RFABase::IterMode iterTime ( uInt itime ) ;

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. virtual RFABase::IterMode iterRow ( uInt irow ) ;

virtual String getDesc (); static const RecordInterface & getDefaults ();


Member Data Documentation

const std::vector<FlagIndex>* casa::RFAApplyFlags::flagIndex [static, private]

Definition at line 74 of file RFAApplyFlags.h.


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