casa::RFATimeFreqCrop Class Reference

RFATimeFreqCrop : 2-Dimensional casacore::Time Frequency Autoflag agent. More...

#include <RFATimeFreqCrop.h>

Inheritance diagram for casa::RFATimeFreqCrop:

Public Member Functions
	RFATimeFreqCrop (RFChunkStats &ch, const casacore::RecordInterface &parm)
virtual	~RFATimeFreqCrop ()
virtual casacore::Bool	newChunk (casacore::Int &i)
	Called before iterating over a chunk. More...
virtual void	endChunk ()
	Called once finished with a chunk. More...
virtual void	startData (bool verbose)
	Called before starting a data pass on a chunk. More...
virtual IterMode	iterTime (casacore::uInt itime)
	Iteration methods for a data pass. More...
virtual IterMode	iterRow (casacore::uInt irow)
	iterRow() is called once per each row in the VisBuffer. More...
virtual IterMode	endData ()
	Called after a pass is completed successfully (i.e., not stopped by start or iter methods). More...
virtual void	startFlag (bool verbose)
	Called before starting the fetch-flags pass. More...
virtual void	iterFlag (casacore::uInt itime)
	Iteration method for a flag pass. More...
Public Member Functions inherited from casa::RFAFlagCubeBase
	RFAFlagCubeBase (RFChunkStats &ch, const casacore::RecordInterface &parm)
virtual	~RFAFlagCubeBase ()
virtual casacore::uInt	estimateMemoryUse ()
	This method is called before iterating over a chunk, to inquire the expected memory use. More...
virtual void	startDry (bool verbose)
	Called before starting a dry pass on a chunk. More...
virtual IterMode	iterDry (casacore::uInt it)
	Iteration method for a dry pass. More...
virtual IterMode	endDry ()
	Called after a dry pass is complete. More...
virtual casacore::String	getDesc ()
	called to obtain a short description of this RFA More...
virtual casacore::String	getStats ()
	called (before endChunk()) to obtain a statistics report More...
virtual casacore::String	getID ()
Public Member Functions inherited from casa::RFABase
	RFABase (RFChunkStats &ch, const casacore::RecordInterface &parm)
	An agent is always constructed from a chunk stats accessor, and a record of parameters. More...
virtual	~RFABase ()
	Destructor. More...
virtual void	init ()
	This method is called after constructing the agent. More...
virtual void	endFlag ()
	Called after a flag pass is complete. More...
virtual void	endRows (casacore::uInt)
	Called at end of time chunk. More...
virtual void	printFlaggingReport ()
const casacore::String &	name ()
	returns the name of this RFA (set in myname) More...
casacore::Bool	isActive ()
	returns the active status More...
casacore::LogIO &	logSink ()
	accessor to a casacore::LogIO for this agent More...
virtual casacore::Record	getResult ()
virtual void	finalize ()
virtual void	initialize ()
	Initialize chunk. More...
virtual void	initializeIter (casacore::uInt)
virtual void	finalizeIter (casacore::uInt)
virtual void	setNAgent (casacore::uInt n)
virtual void	setOnlySelector (bool only_sel)
Public Member Functions inherited from casa::RFDataMapper
	RFDataMapper (const casacore::String &col, DDMapper *map)
	construct from a column and a DDMapper More...
	RFDataMapper (const casacore::Vector< casacore::String > &expr, const casacore::String &defcol="")
	construct from a column and an expression More...
	~RFDataMapper ()
	destructor More...
MapperType	type ()
	returns type of mapper More...
casacore::Double	getValueCycle ()
	If the value being mapped into is cyclic (i.e. More...
casacore::Double	getValueBase ()
	Returns base of a cyclic value (e.g. More...
casacore::Float	mapValue (casacore::uInt ich, casacore::uInt irow)
	gets a value from the DDMapper More...
casacore::Float	mapValue (casacore::uInt irow)
	gets a value from the row mapper More...
RFlagWord	corrMask (const VisibilityIterator &vi)
	uses mapper to compute a correlations mask More...
void	setVisBuffer (VisBuffer &vb)
	point the datamapper at a visbuffer - called for every new buffer More...
casacore::String	description () const
	returns description More...
casacore::String	descExpression () const
	returns description of expression More...

Static Public Member Functions
static const casacore::RecordInterface &	getDefaults ()
Static Public Member Functions inherited from casa::RFAFlagCubeBase
static const casacore::RecordInterface &	getDefaults ()
Static Public Member Functions inherited from casa::RFABase
static void	setIndexingBase (casacore::uInt base)
	static method for setting the indexing base for agent arguments More...

Private Member Functions
casacore::Float	UMean (casacore::Vector< casacore::Float > vect, casacore::Vector< casacore::Bool > flag)
casacore::Float	UStd (casacore::Vector< casacore::Float > vect, casacore::Vector< casacore::Bool > flag, casacore::Vector< casacore::Float > fit)
casacore::Float	UStd (casacore::Vector< casacore::Float > vect, casacore::Vector< casacore::Bool > flag, casacore::Float mean)
void	CleanBand (casacore::Vector< casacore::Float > data, casacore::Vector< casacore::Float > fit)
void	PolyFit (casacore::Vector< casacore::Float > data, casacore::Vector< casacore::Bool > flag, casacore::Vector< casacore::Float > fit, casacore::uInt lim1, casacore::uInt lim2, casacore::uInt deg)
void	LineFit (casacore::Vector< casacore::Float > data, casacore::Vector< casacore::Bool > flag, casacore::Vector< casacore::Float > fit, casacore::uInt lim1, casacore::uInt lim2)
void	Ants (casacore::uInt bs, casacore::uInt *a1, casacore::uInt *a2)
casacore::uInt	BaselineIndex (casacore::uInt row, casacore::uInt a1, casacore::uInt a2)
void	Display_ds9 (casacore::Int xdim, casacore::Int ydim, casacore::Matrix< casacore::Float > &data, casacore::Int frame)
void	Plot_ds9 (casacore::Int dim, casacore::Vector< casacore::Float > data1, casacore::Vector< casacore::Float > data2)
void	AllocateMemory ()
void	FlagZeros ()
void	RunTFCrop ()
void	FlagTimeSeries (casacore::uInt pl, casacore::uInt bs)
void	FitCleanBandPass (casacore::uInt pl, casacore::uInt bs)
void	FlagBandPass (casacore::uInt pl, casacore::uInt bs)
void	GrowFlags (casacore::uInt pl, casacore::uInt bs)
RFA::IterMode	ShowFlagPlots ()
void	ExtendFlags ()
void	FillChunkFlags ()

Private Attributes
VisibilityIterator &	vi
	casacore::uInt itime; More...
VisBuffer &	vb
casacore::String	msname
	casacore::uInt TimeStamps; More...
casacore::Vector< casacore::Int >	ant1
casacore::Vector< casacore::Int >	ant2
casacore::Cube< casacore::Complex >	vc
	casacore::Cube <casacore::Complex> *vv; // visCube ptr - for one timestamp More...
casacore::Cube< casacore::Bool >	ff
casacore::Vector< casacore::Bool >	fr
casacore::Cube< casacore::Float >	visc
casacore::Cube< casacore::Bool >	flagc
casacore::Cube< casacore::Float >	meanBP
casacore::Cube< casacore::Float >	cleanBP
casacore::Vector< casacore::Bool >	rowflags
casacore::Vector< casacore::Bool >	baselineflags
casacore::Cube< casacore::Bool >	chunkflags
casacore::Vector< casacore::Float >	tempBP
casacore::Vector< casacore::Float >	tempTS
casacore::Vector< casacore::Bool >	flagBP
casacore::Vector< casacore::Bool >	flagTS
casacore::Vector< casacore::Float >	fitBP
casacore::Vector< casacore::Float >	fitTS
casacore::Float	T_TOL
casacore::Float	F_TOL
casacore::Float	ANT_TOL
casacore::Float	BASELN_TOL
casacore::uInt	FlagLevel
casacore::uInt	CorrChoice
casacore::uInt	NumTime
casacore::uInt	MaxNPieces
casacore::Bool	ShowPlots
casacore::Bool	DryRun
casacore::Bool	IgnorePreflags
casacore::Bool	FreqLineFit
	casacore::uInt nPol; More...
casacore::Bool	StopAndExit
casacore::String	Column
casacore::Vector < casacore::String >	Expr
casacore::Matrix< casacore::Bool >	RowFlags
casacore::IPosition	cubepos
casacore::IPosition	matpos
casacore::uInt	iterTimecnt
	casacore::uInt passcnt; casacore::uInt iterRowcnt; More...
casacore::uInt	timecnt
casacore::uInt	NumT
casacore::uInt	NumB
casacore::uInt	NumAnt
casacore::uInt	NumC
casacore::uInt	NumP
FlagCubeIterator	flag_iter

Additional Inherited Members
Public Types inherited from casa::RFABase
enum	IterMode {   STOP,   DRY,   DATA,   CONT }
	iteration modes More...
Public Types inherited from casa::FlaggerEnums
enum	StatEnums {   POLZN,   POL,   CORR,   CHAN,   IFR,   TIME,   ROW,   ANT,   FEED,   FEEDCORR,   NONE,   Num_StatEnums }
enum	PreFlagPolicy {   FL_HONOR,   FL_IGNORE,   FL_RESET }
Public Types inherited from casa::RFDataMapper
enum	MapperType {   MAPROW,   MAPCORR }
	type of data mapper: row or individual correlations More...
typedef casacore::Cube < casacore::Complex > *(*	CubeMapperFunc )(VisBuffer &)
	a cube mapper function maps a visbuffer to a data cube. More...
Protected Member Functions inherited from casa::RFABase
casacore::uInt	num (StatEnums which)
RFlagWord	corrMask ()
Protected Member Functions inherited from casa::RFDataMapper
casacore::Float	dummyRowMapper (casacore::uInt)
	various row mappers More...
casacore::Float	U_RowMapper (casacore::uInt)
casacore::Float	V_RowMapper (casacore::uInt)
casacore::Float	W_RowMapper (casacore::uInt)
casacore::Float	AbsU_RowMapper (casacore::uInt)
casacore::Float	AbsV_RowMapper (casacore::uInt)
casacore::Float	AbsW_RowMapper (casacore::uInt)
casacore::Float	UVD_RowMapper (casacore::uInt)
casacore::Float	UVA_RowMapper (casacore::uInt)
casacore::Float	HA_RowMapper (casacore::uInt)
Static Protected Member Functions inherited from casa::RFABase
static casacore::uInt	indexingBase ()
	global flag indicates that Glish (1-based) indexing is in use for agent arguments More...
Static Protected Member Functions inherited from casa::RFDataMapper
static CubeMapperFunc	getCubeMapper (const casacore::String &col, casacore::Bool throw_excp=false)
	static helper function to interpret constructor parameters into a cube mapper More...
Protected Attributes inherited from casa::RFAFlagCubeBase
RFlagWord	corrmask
	mask of active correlations. More...
RFFlagCube	flag
	flag cube lattice More...
Protected Attributes inherited from casa::RFABase
casacore::uInt	nAgent
RFChunkStats &	chunk
casacore::Record	params
casacore::String	myname
bool	only_selector
RFlagWord	corrmask
	Bit mask of correlations which are used & flagged by this RFA. More...
casacore::Bool	active
	flag: agent is active for this chunk (set in newChunk) More...
casacore::LogIO	os
Protected Attributes inherited from casa::RFDataMapper
casacore::String	expr_desc
casacore::String	desc
DDMapper *	ddm
RowMapperFunc	rowmapper
casacore::Cube < casacore::Complex > *	pviscube
casacore::Vector < casacore::RigidVector < casacore::Double, 3 > > *	puvw
CubeMapperFunc	cubemap
MapperType	mytype
casacore::Double	full_cycle
casacore::Double	cycle_base
casacore::Double	sin_dec
	required by the HA mapper - sin(declination) of phase center; More...

Detailed Description

RFATimeFreqCrop : 2-Dimensional casacore::Time Frequency Autoflag agent.

Intended use:

Internal

Prerequisite

• RFDataMapper
• RFFlagCubeBase
• RFCubeLattice

Synopsis

To Do

class RFATimeFreqCrop : public RFADiffMapBase

Definition at line 75 of file RFATimeFreqCrop.h.

Constructor & Destructor Documentation

casa::RFATimeFreqCrop::RFATimeFreqCrop	(	RFChunkStats &	ch,
		const casacore::RecordInterface &	parm
	)

virtual casa::RFATimeFreqCrop::~RFATimeFreqCrop ( )

virtual

Member Function Documentation

void casa::RFATimeFreqCrop::AllocateMemory ( )

private

void casa::RFATimeFreqCrop::Ants ( casacore::uInt  bs, casacore::uInt *  a1, casacore::uInt *  a2  )

private

casacore::uInt casa::RFATimeFreqCrop::BaselineIndex ( casacore::uInt  row, casacore::uInt  a1, casacore::uInt  a2  )

private

void casa::RFATimeFreqCrop::CleanBand ( casacore::Vector< casacore::Float >  data, casacore::Vector< casacore::Float >  fit  )

private

void casa::RFATimeFreqCrop::Display_ds9 ( casacore::Int  xdim, casacore::Int  ydim, casacore::Matrix< casacore::Float > &  data, casacore::Int  frame  )

private

virtual void casa::RFATimeFreqCrop::endChunk ( )

virtual

Called once finished with a chunk.

Reimplemented from casa::RFAFlagCubeBase.

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

void casa::RFATimeFreqCrop::ExtendFlags ( )

private

void casa::RFATimeFreqCrop::FillChunkFlags ( )

private

void casa::RFATimeFreqCrop::FitCleanBandPass ( casacore::uInt  pl, casacore::uInt  bs  )

private

void casa::RFATimeFreqCrop::FlagBandPass ( casacore::uInt  pl, casacore::uInt  bs  )

private

void casa::RFATimeFreqCrop::FlagTimeSeries ( casacore::uInt  pl, casacore::uInt  bs  )

private

void casa::RFATimeFreqCrop::FlagZeros ( )

private

static const casacore::RecordInterface& casa::RFATimeFreqCrop::getDefaults ( )

static

void casa::RFATimeFreqCrop::GrowFlags ( casacore::uInt  pl, casacore::uInt  bs  )

private

virtual void casa::RFATimeFreqCrop::iterFlag ( casacore::uInt  )

virtual

Iteration method for a flag pass.

Called once per each VisBuffer.

Reimplemented from casa::RFAFlagCubeBase.

virtual IterMode casa::RFATimeFreqCrop::iterRow ( casacore::uInt  )

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::RFATimeFreqCrop::iterTime ( casacore::uInt  )

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.

void casa::RFATimeFreqCrop::LineFit ( casacore::Vector< casacore::Float >  data, casacore::Vector< casacore::Bool >  flag, casacore::Vector< casacore::Float >  fit, casacore::uInt  lim1, casacore::uInt  lim2  )

private

virtual casacore::Bool casa::RFATimeFreqCrop::newChunk ( casacore::Int &  )

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 casacore::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. nAgent is the total number of agents.

Reimplemented from casa::RFAFlagCubeBase.

void casa::RFATimeFreqCrop::Plot_ds9 ( casacore::Int  dim, casacore::Vector< casacore::Float >  data1, casacore::Vector< casacore::Float >  data2  )

private

void casa::RFATimeFreqCrop::PolyFit ( casacore::Vector< casacore::Float >  data, casacore::Vector< casacore::Bool >  flag, casacore::Vector< casacore::Float >  fit, casacore::uInt  lim1, casacore::uInt  lim2, casacore::uInt  deg  )

private

void casa::RFATimeFreqCrop::RunTFCrop ( )

private

RFA::IterMode casa::RFATimeFreqCrop::ShowFlagPlots ( )

private

virtual void casa::RFATimeFreqCrop::startData ( bool  )

virtual

Called before starting a data pass on a chunk.

Reimplemented from casa::RFAFlagCubeBase.

virtual void casa::RFATimeFreqCrop::startFlag ( bool  )

virtual

Called before starting the fetch-flags pass.

Reimplemented from casa::RFAFlagCubeBase.

casacore::Float casa::RFATimeFreqCrop::UMean ( casacore::Vector< casacore::Float >  vect, casacore::Vector< casacore::Bool >  flag  )

private

casacore::Float casa::RFATimeFreqCrop::UStd ( casacore::Vector< casacore::Float >  vect, casacore::Vector< casacore::Bool >  flag, casacore::Vector< casacore::Float >  fit  )

private

casacore::Float casa::RFATimeFreqCrop::UStd ( casacore::Vector< casacore::Float >  vect, casacore::Vector< casacore::Bool >  flag, casacore::Float  mean  )

private

Member Data Documentation

casacore::Vector<casacore::Int> casa::RFATimeFreqCrop::ant1

private

Definition at line 121 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Int> casa::RFATimeFreqCrop::ant2

private

Definition at line 121 of file RFATimeFreqCrop.h.

casacore::Float casa::RFATimeFreqCrop::ANT_TOL

private

Definition at line 143 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Bool> casa::RFATimeFreqCrop::baselineflags

private

Definition at line 132 of file RFATimeFreqCrop.h.

casacore::Float casa::RFATimeFreqCrop::BASELN_TOL

private

Definition at line 143 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Bool> casa::RFATimeFreqCrop::chunkflags

private

Definition at line 134 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Float> casa::RFATimeFreqCrop::cleanBP

private

Definition at line 130 of file RFATimeFreqCrop.h.

casacore::String casa::RFATimeFreqCrop::Column

private

Definition at line 149 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::CorrChoice

private

Definition at line 144 of file RFATimeFreqCrop.h.

casacore::IPosition casa::RFATimeFreqCrop::cubepos

private

Definition at line 154 of file RFATimeFreqCrop.h.

casacore::Bool casa::RFATimeFreqCrop::DryRun

private

Definition at line 145 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::String> casa::RFATimeFreqCrop::Expr

private

Definition at line 150 of file RFATimeFreqCrop.h.

casacore::Float casa::RFATimeFreqCrop::F_TOL

private

Definition at line 143 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Bool> casa::RFATimeFreqCrop::ff

private

Definition at line 125 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Float> casa::RFATimeFreqCrop::fitBP

private

Definition at line 140 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Float> casa::RFATimeFreqCrop::fitTS

private

Definition at line 141 of file RFATimeFreqCrop.h.

FlagCubeIterator casa::RFATimeFreqCrop::flag_iter

private

Definition at line 167 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Bool> casa::RFATimeFreqCrop::flagBP

private

Definition at line 138 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Bool> casa::RFATimeFreqCrop::flagc

private

Definition at line 128 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::FlagLevel

private

Definition at line 144 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Bool> casa::RFATimeFreqCrop::flagTS

private

Definition at line 139 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Bool> casa::RFATimeFreqCrop::fr

private

Definition at line 126 of file RFATimeFreqCrop.h.

casacore::Bool casa::RFATimeFreqCrop::FreqLineFit

private

casacore::uInt nPol;

Definition at line 147 of file RFATimeFreqCrop.h.

casacore::Bool casa::RFATimeFreqCrop::IgnorePreflags

private

Definition at line 145 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::iterTimecnt

private

casacore::uInt passcnt; casacore::uInt iterRowcnt;

Definition at line 158 of file RFATimeFreqCrop.h.

casacore::IPosition casa::RFATimeFreqCrop::matpos

private

Definition at line 154 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::MaxNPieces

private

Definition at line 144 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Float> casa::RFATimeFreqCrop::meanBP

private

Definition at line 129 of file RFATimeFreqCrop.h.

casacore::String casa::RFATimeFreqCrop::msname

private

casacore::uInt TimeStamps;

Definition at line 120 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::NumAnt

private

Definition at line 163 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::NumB

private

Definition at line 162 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::NumC

private

Definition at line 164 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::NumP

private

Definition at line 165 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::NumT

private

Definition at line 161 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::NumTime

private

Definition at line 144 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Bool> casa::RFATimeFreqCrop::rowflags

private

Definition at line 131 of file RFATimeFreqCrop.h.

casacore::Matrix<casacore::Bool> casa::RFATimeFreqCrop::RowFlags

private

Definition at line 152 of file RFATimeFreqCrop.h.

casacore::Bool casa::RFATimeFreqCrop::ShowPlots

private

Definition at line 145 of file RFATimeFreqCrop.h.

casacore::Bool casa::RFATimeFreqCrop::StopAndExit

private

Definition at line 148 of file RFATimeFreqCrop.h.

casacore::Float casa::RFATimeFreqCrop::T_TOL

private

Definition at line 143 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Float> casa::RFATimeFreqCrop::tempBP

private

Definition at line 136 of file RFATimeFreqCrop.h.

casacore::Vector<casacore::Float> casa::RFATimeFreqCrop::tempTS

private

Definition at line 137 of file RFATimeFreqCrop.h.

casacore::uInt casa::RFATimeFreqCrop::timecnt

private

Definition at line 159 of file RFATimeFreqCrop.h.

VisBuffer& casa::RFATimeFreqCrop::vb

private

Definition at line 118 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Complex> casa::RFATimeFreqCrop::vc

private

casacore::Cube <casacore::Complex> *vv; // visCube ptr - for one timestamp

Definition at line 124 of file RFATimeFreqCrop.h.

VisibilityIterator& casa::RFATimeFreqCrop::vi

private

casacore::uInt itime;

Definition at line 117 of file RFATimeFreqCrop.h.

casacore::Cube<casacore::Float> casa::RFATimeFreqCrop::visc

private

Definition at line 127 of file RFATimeFreqCrop.h.

---

The documentation for this class was generated from the following file:

• casa/code/flagging/Flagging/RFATimeFreqCrop.h