RFFlagCube.h

void plotImage ( PGPlotterInterface &pgp,const Matrix<Float> &img, const char *labelx,const char *labely,const char *labeltop, Bool wedge = True,Float xbox=0,Float ybox=0,Bool xfreq=False)

uInt num ( StatEnums which )

static RFlagWord agent_corrmasks[sizeof(RFlagWord)*8]

Description

Prerequisite

RFCubeLattice

Synopsis

RFFlagCube implements an [NCHAN,NIFR,NTIME] cube of flags, stored in a TempLattice that is iterated alog the TIME axis. One static (i.e. global) cube is used to hold the actual flags. Individual instances (instantiated by flagging agents) have individual unique bitmasks and, possibly, individual iterators.

Example

Motivation

To Do

add this feature
fix this bug
start discussion of this possible extension

Member Description

RFFlagCube ( RFChunkStats &ch,Bool ignore=False,Bool reset=False,LogIO &os=default_sink )

constructor

~RFFlagCube ()

LogIO & logSink ()

returns reference to logsink

static uInt estimateMemoryUse ( const RFChunkStats &ch )

returns estimated size of flag cube for a given chunk.

void init ( RFlagWord polmsk,const String &name = "" )

creates flag cube for current chunk. name is name of agent.

void cleanup ()

cleans up at end of chunk

String getSummary ()

returns summary of stats in text form

void printStats ()

prints flagging stats to stderr

void plotStats (PGPlotterInterface &pgp)

produces a plot of the flagging stats

static Int numStatPlots (const RFChunkStats &chunk)

returns number of stat plots which will be done

FlagMatrix * reset ()

resets at start of pass

FlagMatrix * advance ( uInt it,Bool getFlags=False )

advances global flag iterator to time slot it (if required), sets the flag cursor from the iterator (see below). If getflags is true, also calls getDataFlags().

void getMSFlags ()

fills global flag lattice with apriori flags from a VisBuffer (if required)

void setMSFlags ()

transfers all flags from lattice into VisBuffer

FlagCubeIterator newCustomIter ()

creates a custom iterator

const FlagMatrix & flagMatrix ()

Returns full flag matrix (i.e. cursor of global iterator)

const FlagMatrix & rowFlagMatrix ()

Returns matrix of row flags

const LogicalMatrix rowFlagMap ()

Returns boolean NIFRxNT map of row flags

const LogicalMatrix rowAvailabilityMap ()

Returns boolean NIFRxNT map of rows actually present in the data

Bool setFlag ( uInt ich,uInt ifr,FlagCubeIterator &iter )

sets or clears a flag at the given flag cursor

Bool clearFlag ( uInt ich,uInt ifr,FlagCubeIterator &iter )

RFlagWord getFlag ( uInt ich,uInt ifr,FlagCubeIterator &iter )

Gets full flag word at the given flag cursor.

Bool setFlag ( uInt ich,uInt ifr )

Versions of above that use global flag cursor

Bool clearFlag ( uInt ich,uInt ifr )

RFlagWord getFlag ( uInt ich,uInt ifr )

Bool preFlagged ( uInt ich,uInt ifr )

the preFlagged() function uses the corr-mask to tell if any of this agent's correlations are pre-flagged. Uses internal cursor.

Bool agentFlagged ( uInt ich,uInt ifr )

The agentFlagged() uses the corr-flagmask to tell if any of my correlations are flagged by any agent (including myself). (i.e. has anyone flagged my correlations?). Uses internal cursor.

Bool anyFlagged ( uInt ich,uInt ifr )

This corresponds to preFlagged OR agentFlagged. Uses internal cursor.

Bool setRowFlag ( uInt ifr,uInt itime )

Sets or clears a row flag

Bool clearRowFlag ( uInt ifr,uInt itime )

RFlagWord getRowFlag ( uInt ifr,uInt itime )

Gets full row flag word

Bool rowPreFlagged ( uInt ifr,uInt itime )

tells if a row is pre-flagged in the MS (or does not exist)

Bool rowAgentFlagged ( uInt ifr,uInt itime )

tells if a row is flagged by any agent

Bool rowFlagged ( uInt ifr,uInt itime )

preFlagged OR agentFlagged

FlagCubeIterator & iterator ()

returns reference to internal iterator

RFlagWord flagMask ()

returns flag mask for this agent

RFlagWord corrMask ()

returns correlations mask for this agent

RFlagWord checkCorrMask ()

returns the checked-correlations mask for this agent (=0 for RESET/IGNORE policies, or =corrMask() for HONOR policy).

static RFlagWord fullCorrMask ()

returns mask of all correlations

RFlagWord corrFlagMask ()

returns combination of flag masks corresponding to agents that operate on correlations in this agent's corrmask (including myself). (in essence, flag&corrFlagMask() == has anyone flagged my correlations) Invalidated by init(), and only becomes valid at next reset()!

static RFlagWord corrFlagMask ( RFlagWord cmask )

for the given corr-mask, returns the corrFlagMask

static Int numInstances ()

returns the number of instances of the flag cube

static void setMaxMem ( Int maxmem )

sets the maximum memory usage for the flag cube

static int getMaxMem ()

returns the current maximum memory usage

void plotIfrMap ( PGPlotterInterface &pgp,const Matrix<Float> &img,const LogicalVector &ifrvalid)

helper methods for generating plots

void plotAntAxis ( PGPlotterInterface &pgp,const Vector<uInt> &antnums,Bool yaxis )

void plotImage ( PGPlotterInterface &pgp,const Matrix<Float> &img, const char labelx,const char labely,const char *labeltop, Bool wedge = True,Float xbox=0,Float ybox=0,Bool xfreq=False)

uInt num ( StatEnums which )

chunk shortcut to RFChunkStats::num

static RFlagWord agent_corrmasks[sizeof(RFlagWord)*8]

bitmask for all correlations in MS (low N bits) agent_corrmasks is an array of correlation masks for every object instance