CalInterpolation: a class to hold calibration interpolation parameters. More...

#include <CalInterpolation.h>

Public Types
enum	Type { LINEAR, NEAREST_NEIGHBOUR, POLYNOMIAL, SPLINE }
	Basic interpolation type. More...

enum	Weighting { WEIGHTED, UNWEIGHTED }
	Interpolation weighting type. More...

Public Member Functions
	CalInterpolation ()
	Default null constructor, and destructor. More...

virtual	~CalInterpolation ()

	CalInterpolation (const CalInterpolation &other)
	Copy constructor and assignment operator. More...

virtual CalInterpolation &	operator= (const CalInterpolation &other)

virtual void	setAxes (const casacore::Vector< casacore::Int > &axes)
	Set interpolation axes. More...

virtual void	setType (const Type &type)
	Set interpolation type. More...

virtual void	setWeighting (const Weighting &weighting)
	Set interpolation weighting. More...

virtual void	setWindows (const casacore::Vector< casacore::Quantity > &windows)
	Set interpolation window (per axis) More...

virtual void	setNpoly (const casacore::Int &npoly)
	Set polynomial order. More...

virtual void	setIndexMap (const casacore::Vector< casacore::MSSelection > &msIndex, const casacore::Vector< casacore::MSSelection > &calIndex)
	Set interpolation index mapping. More...

virtual casacore::Vector < casacore::Int >	axes ()
	Get number and type of interpolation axes. More...

virtual casacore::Int	nAxes ()

virtual Type	type ()
	Get interpolation type. More...

virtual Weighting	weighting ()
	Get interpolation weighting type. More...

virtual casacore::Vector < casacore::Quantity >	windows ()
	Get interpolation windows for each axis. More...

virtual casacore::Int	nPoly ()
	Get polynomial order. More...

virtual casacore::Vector < casacore::MSSelection >	msIndex ()
	Get interpolation index mapping. More...

virtual casacore::Vector < casacore::MSSelection >	calIndex ()

Private Attributes
casacore::Vector< casacore::Int >	axes_p
	Interpolation axes. More...

Type	type_p
	Interpolation type. More...

Weighting	weighting_p
	Interpolation weighting type. More...

casacore::Vector < casacore::Quantity >	windows_p
	Interpolation windows. More...

casacore::Int	npoly_p
	casacore::Polynomial order More...

casacore::Vector < casacore::MSSelection >	msIndex_p
	Interpolation index mapping. More...

casacore::Vector < casacore::MSSelection >	calIndex_p

Detailed Description

CalInterpolation: a class to hold calibration interpolation parameters.

Intended use:

Public interface

Prerequisite

MSCalEnums module
CalBuffer module
casacore::MSSelection module

Etymology

From "calibration" and "interpolation".

Synopsis

The CalInterpolation class holds calibration interpolation parameters which define how calibration is to be applied. Specializations for parametrized Jones matrices, which required sampling before interpolation, are provided through inheritance.

Example

Motivation

This class is used by the calibration interpolater classes.

Definition at line 78 of file CalInterpolation.h.

Member Enumeration Documentation

enum casa::CalInterpolation::Type

Basic interpolation type.

Enumerator
LINEAR	Linear two-point.
NEAREST_NEIGHBOUR	Nearest calibration solution only.
POLYNOMIAL	Fit a polynomial and interpolate.
SPLINE	Use natural cubic splines to interpolate.

Definition at line 82 of file CalInterpolation.h.

enum casa::CalInterpolation::Weighting

Interpolation weighting type.

Enumerator
WEIGHTED	Weight by the calibration solution weight.
UNWEIGHTED	Use unit weighting for all points.

Definition at line 97 of file CalInterpolation.h.

Constructor & Destructor Documentation

casa::CalInterpolation::CalInterpolation ( )

Default null constructor, and destructor.

virtual casa::CalInterpolation::~CalInterpolation ( )

virtual

casa::CalInterpolation::CalInterpolation ( const CalInterpolation & other )

Copy constructor and assignment operator.

Member Function Documentation

virtual casacore::Vector<casacore::Int> casa::CalInterpolation::axes ( )

inlinevirtual

Get number and type of interpolation axes.

Definition at line 136 of file CalInterpolation.h.

References axes_p.

Referenced by setAxes().

virtual casacore::Vector<casacore::MSSelection> casa::CalInterpolation::calIndex ( )

inlinevirtual

Definition at line 153 of file CalInterpolation.h.

References calIndex_p.

Referenced by setIndexMap().

virtual casacore::Vector<casacore::MSSelection> casa::CalInterpolation::msIndex ( )

inlinevirtual

Get interpolation index mapping.

Definition at line 152 of file CalInterpolation.h.

References msIndex_p.

Referenced by setIndexMap().

virtual casacore::Int casa::CalInterpolation::nAxes ( )

inlinevirtual

Definition at line 137 of file CalInterpolation.h.

References axes_p, and casacore::ArrayBase::nelements().

virtual casacore::Int casa::CalInterpolation::nPoly ( )

inlinevirtual

Get polynomial order.

Definition at line 149 of file CalInterpolation.h.

References npoly_p.

virtual CalInterpolation& casa::CalInterpolation::operator= ( const CalInterpolation & other )

virtual

virtual void casa::CalInterpolation::setAxes ( const casacore::Vector< casacore::Int > & axes )

inlinevirtual

Set interpolation axes.

Definition at line 114 of file CalInterpolation.h.

References axes(), and axes_p.

virtual void casa::CalInterpolation::setIndexMap	(	const casacore::Vector< casacore::MSSelection > &	msIndex,
		const casacore::Vector< casacore::MSSelection > &	calIndex
	)

inlinevirtual

Set interpolation index mapping.

Definition at line 131 of file CalInterpolation.h.

References calIndex(), calIndex_p, msIndex(), and msIndex_p.

virtual void casa::CalInterpolation::setNpoly ( const casacore::Int & npoly )

inlinevirtual

Set polynomial order.

Definition at line 128 of file CalInterpolation.h.

References npoly_p.

virtual void casa::CalInterpolation::setType ( const Type & type )

inlinevirtual

Set interpolation type.

Definition at line 117 of file CalInterpolation.h.

References type(), and type_p.

virtual void casa::CalInterpolation::setWeighting ( const Weighting & weighting )

inlinevirtual

Set interpolation weighting.

Definition at line 120 of file CalInterpolation.h.

References weighting(), and weighting_p.

virtual void casa::CalInterpolation::setWindows ( const casacore::Vector< casacore::Quantity > & windows )

inlinevirtual

Set interpolation window (per axis)

Definition at line 124 of file CalInterpolation.h.

References windows(), and windows_p.

virtual Type casa::CalInterpolation::type ( )

inlinevirtual

Get interpolation type.

Definition at line 140 of file CalInterpolation.h.

References type_p.

Referenced by setType().

virtual Weighting casa::CalInterpolation::weighting ( )

inlinevirtual

Get interpolation weighting type.

Definition at line 143 of file CalInterpolation.h.

References weighting_p.

Referenced by setWeighting().

virtual casacore::Vector<casacore::Quantity> casa::CalInterpolation::windows ( )

inlinevirtual

Get interpolation windows for each axis.

Definition at line 146 of file CalInterpolation.h.

References windows_p.

Referenced by setWindows().

Member Data Documentation

casacore::Vector<casacore::Int> casa::CalInterpolation::axes_p

private

Interpolation axes.

Definition at line 153 of file CalInterpolation.h.

Referenced by axes(), nAxes(), and setAxes().

casacore::Vector<casacore::MSSelection> casa::CalInterpolation::calIndex_p

private

Definition at line 174 of file CalInterpolation.h.

Referenced by calIndex(), and setIndexMap().

casacore::Vector<casacore::MSSelection> casa::CalInterpolation::msIndex_p

private

Interpolation index mapping.

Definition at line 174 of file CalInterpolation.h.

Referenced by msIndex(), and setIndexMap().

casacore::Int casa::CalInterpolation::npoly_p

private

casacore::Polynomial order

Definition at line 171 of file CalInterpolation.h.

Referenced by nPoly(), and setNpoly().

Type casa::CalInterpolation::type_p

private

Interpolation type.

Definition at line 162 of file CalInterpolation.h.

Referenced by setType(), and type().

Weighting casa::CalInterpolation::weighting_p

private

Interpolation weighting type.

Definition at line 165 of file CalInterpolation.h.

Referenced by setWeighting(), and weighting().

casacore::Vector<casacore::Quantity> casa::CalInterpolation::windows_p

private

Interpolation windows.

Definition at line 168 of file CalInterpolation.h.

Referenced by setWindows(), and windows().

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

casa/code/synthesis/CalTables/CalInterpolation.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Intended use:

Prerequisite

Etymology

Synopsis

Example

Motivation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation