#include <RFAFlagCubeBase.h>
Inheritance diagram for casa::RFAFlagCubeBase:
Internal
RFAFlagCubeBase is derived from RFABase. It includes an RFFlagCube object, which is essentially an [NCHAN,NIFR,NTIME] lattice of flags. Approrpiate vritual methods for managing the cube are defined.
Definition at line 61 of file RFAFlagCubeBase.h.
Public Member Functions | |
| RFAFlagCubeBase (RFChunkStats &ch, const RecordInterface &parm) | |
| virtual | ~RFAFlagCubeBase () |
| 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 void | startFlag () |
| Called before starting the fetch-flags pass. | |
| virtual IterMode | iterTime (uInt it) |
| Iteration methods for a data pass. | |
| virtual IterMode | iterDry (uInt it) |
| Iteration method for a dry pass. | |
| virtual void | iterFlag (uInt it) |
| Iteration method for a flag 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 | |
| virtual String | getStats () |
| called (before endChunk()) to obtain a statistics report | |
| virtual void | plotFlaggingReport (PGPlotterInterface &pgp) |
| called (before endChunk()) to plots a graphical flagging report | |
| virtual String | getID () |
Static Public Member Functions | |
| static const RecordInterface & | getDefaults () |
Protected Attributes | |
| RFlagWord | corrmask |
| mask of active correlations. | |
| RFFlagCube | flag |
| flag cube lattice | |
| casa::RFAFlagCubeBase::RFAFlagCubeBase | ( | RFChunkStats & | ch, | |
| const RecordInterface & | parm | |||
| ) |
| virtual casa::RFAFlagCubeBase::~RFAFlagCubeBase | ( | ) | [virtual] |
| virtual uInt casa::RFAFlagCubeBase::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::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFANewMedianClip, casa::RFASelector, casa::RFASpectralRej, and casa::RFAUVBinner.
Referenced by casa::RFASpectralRej::estimateMemoryUse(), and casa::RFASelector::estimateMemoryUse().
| virtual Bool casa::RFAFlagCubeBase::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::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFATimeMedian, casa::RFAFreqMedian, casa::RFANewMedianClip, casa::RFASelector, casa::RFASpectralRej, casa::RFATimeFreqCrop, and casa::RFAUVBinner.
| virtual void casa::RFAFlagCubeBase::endChunk | ( | ) | [virtual] |
Called once finished with a chunk.
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFATimeMedian, casa::RFANewMedianClip, casa::RFASpectralRej, casa::RFATimeFreqCrop, and casa::RFAUVBinner.
| virtual void casa::RFAFlagCubeBase::startData | ( | ) | [virtual] |
Called before starting a data pass on a chunk.
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFAFlagExaminer, casa::RFATimeMedian, casa::RFANewMedianClip, casa::RFASelector, casa::RFASpectralRej, casa::RFATimeFreqCrop, and casa::RFAUVBinner.
Referenced by casa::RFAFlagExaminer::startData().
| virtual void casa::RFAFlagCubeBase::startDry | ( | ) | [virtual] |
Called before starting a dry pass on a chunk.
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFANewMedianClip, and casa::RFAUVBinner.
| virtual void casa::RFAFlagCubeBase::startFlag | ( | ) | [virtual] |
Called before starting the fetch-flags pass.
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAApplyFlags, and casa::RFAFlagExaminer.
| virtual IterMode casa::RFAFlagCubeBase::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::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFADiffMapBase, casa::RFATimeMedian, casa::RFANewMedianClip, casa::RFASelector, casa::RFASpectralRej, casa::RFATimeFreqCrop, and casa::RFAUVBinner.
| virtual IterMode casa::RFAFlagCubeBase::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::RFABase.
Reimplemented in casa::RFADiffBase, casa::RFANewMedianClip, and casa::RFAUVBinner.
| virtual void casa::RFAFlagCubeBase::iterFlag | ( | uInt | it | ) | [virtual] |
Iteration method for a flag pass.
Called once per each VisBuffer.
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFAFlagExaminer, and casa::RFATimeFreqCrop.
| virtual IterMode casa::RFAFlagCubeBase::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::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFATimeMedian, casa::RFANewMedianClip, casa::RFASpectralRej, casa::RFATimeFreqCrop, and casa::RFAUVBinner.
| virtual IterMode casa::RFAFlagCubeBase::endDry | ( | ) | [virtual] |
Called after a dry pass is complete.
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAApplyFlags, casa::RFADiffBase, casa::RFANewMedianClip, and casa::RFAUVBinner.
| virtual String casa::RFAFlagCubeBase::getDesc | ( | ) | [virtual] |
called to obtain a short description of this RFA
Reimplemented from casa::RFABase.
Reimplemented in casa::RFADiffBase, casa::RFADiffMapBase, casa::RFATimeMedian, casa::RFAFreqMedian, casa::RFANewMedianClip, casa::RFASelector, casa::RFASpectralRej, and casa::RFAUVBinner.
| virtual String casa::RFAFlagCubeBase::getStats | ( | ) | [virtual] |
| static const RecordInterface& casa::RFAFlagCubeBase::getDefaults | ( | ) | [static] |
| virtual void casa::RFAFlagCubeBase::plotFlaggingReport | ( | PGPlotterInterface & | pgp | ) | [virtual] |
| virtual String casa::RFAFlagCubeBase::getID | ( | ) | [inline, virtual] |
Reimplemented from casa::RFABase.
Reimplemented in casa::RFAFlagExaminer.
Definition at line 84 of file RFAFlagCubeBase.h.
References String.
RFlagWord casa::RFAFlagCubeBase::corrmask [protected] |
mask of active correlations.
Must be setup somewhere before calling newChunk()
Reimplemented from casa::RFABase.
Definition at line 84 of file RFAFlagCubeBase.h.
RFFlagCube casa::RFAFlagCubeBase::flag [protected] |
1.5.1