casa::RFDataMapper Class Reference

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

#include <RFDataMapper.h>

Inheritance diagram for casa::RFDataMapper:
casa::RFADiffMapBase casa::RFANewMedianClip casa::RFASpectralRej casa::RFATimeFreqCrop casa::RFAUVBinner casa::RFAFreqMedian casa::RFATimeMedian

List of all members.

Public Types

enum  MapperType {
  MAPROW,
  MAPCORR
}
 

type of data mapper: row or individual correlations

More...
typedef Cube< Complex > *(* CubeMapperFunc )(VisBuffer &)
 a cube mapper function maps a visbuffer to a data cube.

Public Member Functions

 RFDataMapper (const String &col, DDMapper *map)
 construct from a column and a DDMapper
 RFDataMapper (const Vector< String > &expr, const String &defcol="")
 construct from a column and an expression
 ~RFDataMapper ()
 destructor
MapperType type ()
 returns type of mapper
Double getValueCycle ()
 If the value being mapped into is cyclic (i.e.
Double getValueBase ()
 Returns base of a cyclic value (e.g.
Float mapValue (uInt ich, uInt irow)
 gets a value from the DDMapper
Float mapValue (uInt irow)
 gets a value from the row mapper
RFlagWord corrMask (const VisibilityIterator &vi)
 uses mapper to compute a correlations mask
void setVisBuffer (VisBuffer &vb)
 point the datamapper at a visbuffer - called for every new buffer
String description () const
 returns description
String descExpression () const
 returns description of expression

Protected Member Functions

Float dummyRowMapper (uInt)
 various row mappers
Float U_RowMapper (uInt)
Float V_RowMapper (uInt)
Float W_RowMapper (uInt)
Float AbsU_RowMapper (uInt)
Float AbsV_RowMapper (uInt)
Float AbsW_RowMapper (uInt)
Float UVD_RowMapper (uInt)
Float UVA_RowMapper (uInt)
Float HA_RowMapper (uInt)

Static Protected Member Functions

static CubeMapperFunc getCubeMapper (const String &col, Bool throw_excp=False)
 static helper function to interpret constructor parameters into a cube mapper

Protected Attributes

String expr_desc
String desc
DDMapperddm
RowMapperFunc rowmapper
Cube< Complex > * pviscube
Vector< RigidVector< Double, 3 > > * puvw
CubeMapperFunc cubemap
MapperType mytype
Double full_cycle
Double cycle_base
Double sin_dec
 required by the HA mapper - sin(declination) of phase center;

Detailed Description

RFDataMapper: maps complex visibilities to a single real value.

Intended use:

Internal

Prerequisite

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

Definition at line 73 of file RFDataMapper.h.


Member Typedef Documentation

typedef Cube<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

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 String &  col,
DDMapper map 
)

construct from a column and a DDMapper

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

construct from a column and an expression

casa::RFDataMapper::~RFDataMapper (  ) 

destructor


Member Function Documentation

Float casa::RFDataMapper::AbsU_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::AbsV_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::AbsW_RowMapper ( uInt   )  [protected]
RFlagWord casa::RFDataMapper::corrMask ( const VisibilityIterator vi  ) 

uses mapper to compute a correlations mask

String casa::RFDataMapper::descExpression (  )  const [inline]

returns description of expression

Definition at line 162 of file RFDataMapper.h.

References expr_desc.

String casa::RFDataMapper::description (  )  const [inline]

returns description

Definition at line 160 of file RFDataMapper.h.

References desc.

Float casa::RFDataMapper::dummyRowMapper ( uInt   )  [protected]

various row mappers

static CubeMapperFunc casa::RFDataMapper::getCubeMapper ( const String &  col,
Bool  throw_excp = False 
) [static, protected]

static helper function to interpret constructor parameters into a cube mapper

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.

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.

Float casa::RFDataMapper::HA_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::mapValue ( uInt  irow  )  [inline]

gets a value from the row mapper

Definition at line 157 of file RFDataMapper.h.

References rowmapper.

Float casa::RFDataMapper::mapValue ( uInt  ich,
uInt  irow 
) [inline]

gets a value from the DDMapper

Definition at line 149 of file RFDataMapper.h.

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

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.

Float casa::RFDataMapper::U_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::UVA_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::UVD_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::V_RowMapper ( uInt   )  [protected]
Float casa::RFDataMapper::W_RowMapper ( uInt   )  [protected]

Member Data Documentation

Definition at line 126 of file RFDataMapper.h.

Double casa::RFDataMapper::cycle_base [protected]

Definition at line 128 of file RFDataMapper.h.

Referenced by getValueBase().

Definition at line 122 of file RFDataMapper.h.

Referenced by mapValue().

String casa::RFDataMapper::desc [protected]

Definition at line 121 of file RFDataMapper.h.

Referenced by description().

String casa::RFDataMapper::expr_desc [protected]

Definition at line 121 of file RFDataMapper.h.

Referenced by descExpression().

Double casa::RFDataMapper::full_cycle [protected]

Definition at line 128 of file RFDataMapper.h.

Referenced by getValueCycle().

Definition at line 127 of file RFDataMapper.h.

Referenced by type().

Vector<RigidVector<Double,3> >* casa::RFDataMapper::puvw [protected]

Reimplemented in casa::RFAUVBinner.

Definition at line 125 of file RFDataMapper.h.

Cube<Complex>* casa::RFDataMapper::pviscube [protected]

Definition at line 124 of file RFDataMapper.h.

Referenced by mapValue().

Definition at line 123 of file RFDataMapper.h.

Referenced by mapValue().

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1