casa::RFASelector Class Reference
[Flagging_internal_classes]

#include <RFASelector.h>

Inheritance diagram for casa::RFASelector:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

RFASelector: flags pixels/rows based on a specified selection.

Intended use:

Internal

Prerequisite

Etymology

RedFlaggerAgent Selector

Synopsis

RFASelector accepts a whole bunch of options to select a subset of the MS (by time, antenna, baseline, channel/frequency, etc.), and to flag/unflag the whole selection, or specific parts of it (autocorrelations, specific time slots, VLA quacks, etc.)

To Do

Definition at line 68 of file RFASelector.h.

Public Member Functions

 RFASelector (RFChunkStats &ch, const RecordInterface &parm)
 constructor.
virtual ~RFASelector ()
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 IterMode iterTime (uInt it)
 Iteration methods for a data pass.
virtual IterMode iterRow (uInt ir)
 iterRow() is called once per each row in the VisBuffer.
virtual void startData ()
 Called before starting a data pass on a chunk.
virtual String getDesc ()
 called to obtain a short description of this RFA
Bool fortestingonly_parseMinMax (Float &vmin, Float &vmax, const RecordInterface &spec, uInt f0)
void fortestingonly_parseClipField (const RecordInterface &spec, Bool clip)

Static Public Member Functions

static const RecordInterface & getDefaults ()

Protected Types

typedef casa::RFASelector::ClipInfo ClipInfo

Protected Member Functions

template<class T>
Bool reformRange (Matrix< T > &rng, const Array< T > &arr)
template<class T>
Bool parseRange (Matrix< T > &rng, const RecordInterface &parm, const String &id)
template<class T>
Bool find (uInt &index, const T &obj, const Vector< T > &arr)
Bool parseTimes (Array< Double > &times, const RecordInterface &parm, const String &id, Bool secs=False)
void addString (String &str, const String &s1, const char *sep=" ")
virtual void processRow (uInt ifr, uInt it)
Bool parseMinMax (Float &vmin, Float &vmax, const RecordInterface &spec, uInt f0)
void addClipInfo (const Vector< String > &expr, Float vmin, Float vmax, Bool clip)
void parseClipField (const RecordInterface &spec, Bool clip)
void addClipInfoDesc (const Block< ClipInfo > &clip)

Protected Attributes

Double diameter
 shadow mode
Vector< Double > diameters
ROMSAntennaColumns * ac
String desc_str
 description of agent
Matrix< Double > sel_freq
 selection arguments
Matrix< Double > sel_time
Matrix< Double > sel_timerng
Matrix< Double > sel_uvrange
Matrix< Int > sel_chan
Vector< Int > sel_corr
Vector< Int > sel_spwid
Vector< Int > sel_fieldid
Vector< String > sel_fieldnames
LogicalVector sel_ifr
LogicalVector flagchan
LogicalVector sel_feed
Bool sel_autocorr
Bool unflag
Block< ClipInfosel_clip
Block< ClipInfosel_clip_row
LogicalVector sel_clip_active
Bool sum_sel_clip_active
Double quack_si
Double quack_dt
String quack_mode
Bool quack_increment
Vector< Int > sel_scannumber
Vector< Int > sel_arrayid
String sel_column
Bool select_fullrow
Bool flag_everything
Bool shadow

Classes

struct  ClipInfo


Member Typedef Documentation

typedef struct casa::RFASelector::ClipInfo casa::RFASelector::ClipInfo [protected]


Constructor & Destructor Documentation

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

constructor.

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


Member Function Documentation

virtual uInt casa::RFASelector::estimateMemoryUse (  )  [inline, 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.

Definition at line 75 of file RFASelector.h.

References casa::RFAFlagCubeBase::estimateMemoryUse().

virtual Bool casa::RFASelector::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 IterMode casa::RFASelector::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 IterMode casa::RFASelector::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::RFASelector::startData (  )  [virtual]

Called before starting a data pass on a chunk.

Reimplemented from casa::RFAFlagCubeBase.

Reimplemented in casa::RFAFlagExaminer.

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

called to obtain a short description of this RFA

Reimplemented from casa::RFAFlagCubeBase.

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

Reimplemented from casa::RFAFlagCubeBase.

Bool casa::RFASelector::fortestingonly_parseMinMax ( Float &  vmin,
Float &  vmax,
const RecordInterface &  spec,
uInt  f0 
)

void casa::RFASelector::fortestingonly_parseClipField ( const RecordInterface &  spec,
Bool  clip 
)

template<class T>
Bool casa::RFASelector::reformRange ( Matrix< T > &  rng,
const Array< T > &  arr 
) [protected]

template<class T>
Bool casa::RFASelector::parseRange ( Matrix< T > &  rng,
const RecordInterface &  parm,
const String &  id 
) [protected]

template<class T>
Bool casa::RFASelector::find ( uInt &  index,
const T &  obj,
const Vector< T > &  arr 
) [protected]

Bool casa::RFASelector::parseTimes ( Array< Double > &  times,
const RecordInterface &  parm,
const String &  id,
Bool  secs = False 
) [protected]

void casa::RFASelector::addString ( String &  str,
const String &  s1,
const char *  sep = " " 
) [protected]

virtual void casa::RFASelector::processRow ( uInt  ifr,
uInt  it 
) [protected, virtual]

Reimplemented in casa::RFAFlagExaminer.

Bool casa::RFASelector::parseMinMax ( Float &  vmin,
Float &  vmax,
const RecordInterface &  spec,
uInt  f0 
) [protected]

void casa::RFASelector::addClipInfo ( const Vector< String > &  expr,
Float  vmin,
Float  vmax,
Bool  clip 
) [protected]

void casa::RFASelector::parseClipField ( const RecordInterface &  spec,
Bool  clip 
) [protected]

void casa::RFASelector::addClipInfoDesc ( const Block< ClipInfo > &  clip  )  [protected]


Member Data Documentation

Double casa::RFASelector::diameter [protected]

shadow mode

Definition at line 108 of file RFASelector.h.

Vector< Double > casa::RFASelector::diameters [protected]

Definition at line 111 of file RFASelector.h.

ROMSAntennaColumns* casa::RFASelector::ac [protected]

Definition at line 112 of file RFASelector.h.

String casa::RFASelector::desc_str [protected]

description of agent

Definition at line 115 of file RFASelector.h.

Matrix<Double> casa::RFASelector::sel_freq [protected]

selection arguments

Definition at line 117 of file RFASelector.h.

Matrix<Double> casa::RFASelector::sel_time [protected]

Definition at line 117 of file RFASelector.h.

Matrix<Double> casa::RFASelector::sel_timerng [protected]

Definition at line 117 of file RFASelector.h.

Matrix<Double> casa::RFASelector::sel_uvrange [protected]

Definition at line 117 of file RFASelector.h.

Matrix<Int> casa::RFASelector::sel_chan [protected]

Definition at line 118 of file RFASelector.h.

Vector<Int> casa::RFASelector::sel_corr [protected]

Definition at line 119 of file RFASelector.h.

Vector<Int> casa::RFASelector::sel_spwid [protected]

Definition at line 119 of file RFASelector.h.

Vector<Int> casa::RFASelector::sel_fieldid [protected]

Definition at line 119 of file RFASelector.h.

Vector<String> casa::RFASelector::sel_fieldnames [protected]

Definition at line 120 of file RFASelector.h.

LogicalVector casa::RFASelector::sel_ifr [protected]

Definition at line 121 of file RFASelector.h.

LogicalVector casa::RFASelector::flagchan [protected]

Definition at line 121 of file RFASelector.h.

LogicalVector casa::RFASelector::sel_feed [protected]

Definition at line 121 of file RFASelector.h.

Bool casa::RFASelector::sel_autocorr [protected]

Definition at line 122 of file RFASelector.h.

Bool casa::RFASelector::unflag [protected]

Definition at line 122 of file RFASelector.h.

Block<ClipInfo> casa::RFASelector::sel_clip [protected]

Definition at line 123 of file RFASelector.h.

Block<ClipInfo> casa::RFASelector::sel_clip_row [protected]

Definition at line 123 of file RFASelector.h.

LogicalVector casa::RFASelector::sel_clip_active [protected]

Definition at line 124 of file RFASelector.h.

Bool casa::RFASelector::sum_sel_clip_active [protected]

Definition at line 125 of file RFASelector.h.

Double casa::RFASelector::quack_si [protected]

Definition at line 126 of file RFASelector.h.

Double casa::RFASelector::quack_dt [protected]

Definition at line 126 of file RFASelector.h.

String casa::RFASelector::quack_mode [protected]

Definition at line 127 of file RFASelector.h.

Bool casa::RFASelector::quack_increment [protected]

Definition at line 128 of file RFASelector.h.

Vector<Int> casa::RFASelector::sel_scannumber [protected]

Definition at line 129 of file RFASelector.h.

Vector<Int> casa::RFASelector::sel_arrayid [protected]

Definition at line 129 of file RFASelector.h.

String casa::RFASelector::sel_column [protected]

Definition at line 130 of file RFASelector.h.

Bool casa::RFASelector::select_fullrow [protected]

Definition at line 132 of file RFASelector.h.

Bool casa::RFASelector::flag_everything [protected]

Definition at line 132 of file RFASelector.h.

Bool casa::RFASelector::shadow [protected]

Definition at line 132 of file RFASelector.h.


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