casa::RFDataMapper Class Reference

RFDataMapper: maps complex visibilities to a single real value. More...

#include <RFDataMapper.h>

Inheritance diagram for casa::RFDataMapper:

Public Types
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...

Public Member Functions
	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...

Protected Member Functions
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
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
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

RFDataMapper: maps complex visibilities to a single real value.

Intended use:

Internal

Prerequisite

• DDMapper

Synopsis

RFDataMapper provides a mechanism to derive a single real value from a set of complex visibilities in a specific column, using a user-specified expression (i.e. ABS(XX), ABS(XX)-ABS(YY), etc.) This is used by many flagging agents.

Motivation

To provide a common mechanism for all flagging agents

To Do

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

Definition at line 73 of file RFDataMapper.h.

Member Typedef Documentation

typedef casacore::Cube<casacore::Complex>*(* casa::RFDataMapper::CubeMapperFunc)(VisBuffer &)

a cube mapper function maps a visbuffer to a data cube.

This belongs in private or protected, but the SGI compiler wouldn't hear of it

Definition at line 114 of file RFDataMapper.h.

Member Enumeration Documentation

enum casa::RFDataMapper::MapperType

type of data mapper: row or individual correlations

Enumerator
MAPROW
MAPCORR

Definition at line 77 of file RFDataMapper.h.

Constructor & Destructor Documentation

casa::RFDataMapper::RFDataMapper	(	const casacore::String &	col,
		DDMapper *	map
	)

construct from a column and a DDMapper

casa::RFDataMapper::RFDataMapper	(	const casacore::Vector< casacore::String > &	expr,
		const casacore::String &	defcol = ""
	)

construct from a column and an expression

casa::RFDataMapper::~RFDataMapper

(

)

destructor

Member Function Documentation

casacore::Float casa::RFDataMapper::AbsU_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::AbsV_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::AbsW_RowMapper ( casacore::uInt  )

protected

RFlagWord casa::RFDataMapper::corrMask

(

const VisibilityIterator &

vi

)

uses mapper to compute a correlations mask

Referenced by casa::RFADiffMapBase::newCorrMask().

casacore::String casa::RFDataMapper::descExpression ( ) const

inline

returns description of expression

Definition at line 162 of file RFDataMapper.h.

References expr_desc.

casacore::String casa::RFDataMapper::description ( ) const

inline

returns description

Definition at line 160 of file RFDataMapper.h.

References desc.

casacore::Float casa::RFDataMapper::dummyRowMapper ( casacore::uInt  )

protected

various row mappers

static CubeMapperFunc casa::RFDataMapper::getCubeMapper ( const casacore::String &  col, casacore::Bool  throw_excp = false  )

staticprotected

static helper function to interpret constructor parameters into a cube mapper

casacore::Double casa::RFDataMapper::getValueBase ( )

inline

Returns base of a cyclic value (e.g.

-180, if value is an angle -180..180) If value is non-cyclic, the result is undefined.

Definition at line 167 of file RFDataMapper.h.

References cycle_base.

casacore::Double casa::RFDataMapper::getValueCycle ( )

inline

If the value being mapped into is cyclic (i.e.

an angle), returns value of full cycle (e.g. 360); otherwise returns 0.

Definition at line 165 of file RFDataMapper.h.

References full_cycle.

casacore::Float casa::RFDataMapper::HA_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::mapValue ( casacore::uInt  ich, casacore::uInt  irow  )

inline

gets a value from the DDMapper

Definition at line 149 of file RFDataMapper.h.

References ddm, casa::DDMapper::map(), and pviscube.

casacore::Float casa::RFDataMapper::mapValue ( casacore::uInt  irow )

inline

gets a value from the row mapper

Definition at line 157 of file RFDataMapper.h.

References rowmapper.

void casa::RFDataMapper::setVisBuffer

(

VisBuffer &

vb

)

point the datamapper at a visbuffer - called for every new buffer

Referenced by casa::RFADiffMapBase::setupMapper().

RFDataMapper::MapperType casa::RFDataMapper::type ( )

inline

returns type of mapper

Definition at line 146 of file RFDataMapper.h.

References mytype.

casacore::Float casa::RFDataMapper::U_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::UVA_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::UVD_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::V_RowMapper ( casacore::uInt  )

protected

casacore::Float casa::RFDataMapper::W_RowMapper ( casacore::uInt  )

protected

Member Data Documentation

CubeMapperFunc casa::RFDataMapper::cubemap

protected

Definition at line 126 of file RFDataMapper.h.

casacore::Double casa::RFDataMapper::cycle_base

protected

Definition at line 128 of file RFDataMapper.h.

Referenced by getValueBase().

DDMapper* casa::RFDataMapper::ddm

protected

Definition at line 122 of file RFDataMapper.h.

Referenced by mapValue().

casacore::String casa::RFDataMapper::desc

protected

Definition at line 121 of file RFDataMapper.h.

Referenced by description().

casacore::String casa::RFDataMapper::expr_desc

protected

Definition at line 121 of file RFDataMapper.h.

Referenced by descExpression().

casacore::Double casa::RFDataMapper::full_cycle

protected

Definition at line 128 of file RFDataMapper.h.

Referenced by getValueCycle().

MapperType casa::RFDataMapper::mytype

protected

Definition at line 127 of file RFDataMapper.h.

Referenced by type().

casacore::Vector<casacore::RigidVector<casacore::Double,3> >* casa::RFDataMapper::puvw

protected

Definition at line 125 of file RFDataMapper.h.

casacore::Cube<casacore::Complex>* casa::RFDataMapper::pviscube

protected

Definition at line 124 of file RFDataMapper.h.

Referenced by mapValue().

RowMapperFunc casa::RFDataMapper::rowmapper

protected

Definition at line 123 of file RFDataMapper.h.

Referenced by mapValue().

casacore::Double casa::RFDataMapper::sin_dec

protected

required by the HA mapper - sin(declination) of phase center;

Definition at line 143 of file RFDataMapper.h.

---

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

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