casa::DDMapper Class Reference

Abstract Derived casacore::Data Mapper class. More...

#include <DDMapper.h>

Inheritance diagram for casa::DDMapper:

Public Member Functions
	DDMapper ()
virtual	~DDMapper ()
virtual casacore::Bool	reset (const casacore::Vector< casacore::Int > &corr)=0
	Given a vector of correlation types, recomputes internal indices. More...
virtual casacore::Float	map (const casacore::Cube< casacore::Complex > &vis, casacore::uInt ich, casacore::uInt irow) const =0
	Maps a slice of visibilities at (*,ich,irow) from the given viscube into a the derived value. More...
casacore::uShort	corrMask () const
	Returns the "mask" of correlations which are used by this mapper. More...
casacore::Bool	masked (casacore::uInt icorr) const
	Returns true if given correlations is masked. More...
casacore::Bool	isValid ()
	Tells if mapper is valid. More...

Protected Attributes
casacore::Bool	valid
casacore::uShort	corrmask

Detailed Description

Abstract Derived casacore::Data Mapper class.

Intended use:

Internal

Synopsis

The DDMapper class defines an interface for mapping complex visibilities into casacore::Float derived values. DDMappers are used by several flagging agents.

Motivation

A lot of algorithms are expressed in terms of some real value derived from a set of visibilities (i.e., |XX|, |XX|-|YY|, etc.). The DDMapper hierarchy provides a uniform interface for deriving such values.

To Do

• add this feature

Definition at line 62 of file DDMapper.h.

Constructor & Destructor Documentation

casa::DDMapper::DDMapper ( )

inline

Definition at line 69 of file DDMapper.h.

References valid.

virtual casa::DDMapper::~DDMapper ( )

inlinevirtual

Definition at line 70 of file DDMapper.h.

Member Function Documentation

casacore::uShort casa::DDMapper::corrMask ( ) const

inline

Returns the "mask" of correlations which are used by this mapper.

by this mapper. Bit "i" is set if corr. "i" is used.

Definition at line 82 of file DDMapper.h.

References corrmask.

casacore::Bool casa::DDMapper::isValid ( )

inline

Tells if mapper is valid.

Definition at line 88 of file DDMapper.h.

References valid.

virtual casacore::Float casa::DDMapper::map ( const casacore::Cube< casacore::Complex > &  vis, casacore::uInt  ich, casacore::uInt  irow  ) const

pure virtual

Maps a slice of visibilities at (*,ich,irow) from the given viscube into a the derived value.

Implemented in casa::DDDiffFunc, casa::DDFuncDiff, casa::DDFuncSum, casa::DDSumFunc, casa::DDFunc, and casa::DDDummy.

Referenced by casa::RFDataMapper::mapValue().

casacore::Bool casa::DDMapper::masked ( casacore::uInt  icorr ) const

inline

Returns true if given correlations is masked.

Definition at line 85 of file DDMapper.h.

References corrmask.

virtual casacore::Bool casa::DDMapper::reset ( const casacore::Vector< casacore::Int > &  corr )

pure virtual

Given a vector of correlation types, recomputes internal indices.

returns true if all indices were found successfully.

Implemented in casa::DDSumFunc, casa::DDFunc, and casa::DDDummy.

Member Data Documentation

casacore::uShort casa::DDMapper::corrmask

protected

Definition at line 66 of file DDMapper.h.

Referenced by corrMask(), and masked().

casacore::Bool casa::DDMapper::valid

protected

Definition at line 65 of file DDMapper.h.

Referenced by DDMapper(), and isValid().

---

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

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