casacore::MVBaseline Class Reference

A 3D vector on Earth. More...

#include <MVBaseline.h>

Inheritance diagram for casacore::MVBaseline:

Public Member Functions
	MVBaseline ()
	Default constructor generates a (0,0,0) Baseline.
	MVBaseline (const MVPosition &other)
	Copy constructor.
	MVBaseline (Double in0, Double in1, Double in2)
	Creates a specified vector.
	MVBaseline (Double in0)
	Creates a vector with specified length towards pole.
	MVBaseline (const Quantity &l)
	MVBaseline (const Quantity &l, Double angle0, Double angle1)
	Creates the Baseline from specified (azimuth,elevation) angles and length.
	MVBaseline (const Quantity &l, const Quantity &angle0, const Quantity &angle1)
	Creates the Baseline from specified angles and length.
	MVBaseline (const Quantum< Vector< Double > > &angle)
	If not enough angles: pole assumed (if none), or elevation =0 (if 1).
	MVBaseline (const Quantity &l, const Quantum< Vector< Double > > &angle)
	MVBaseline (const Vector< Double > &other)
	Create from specified length and/or angles and/or Baseline.
	MVBaseline (const Vector< Quantity > &other)
	MVBaseline (const MVPosition &pos, const MVPosition &base)
	Baseline as difference between positions (first - second (default(0,0,0)).
MVBaseline &	operator= (const MVBaseline &other)
	Copy assignment.
	~MVBaseline ()
	Destructor.
Double	operator* (const MVBaseline &other) const
	Multiplication defined as in-product.
Bool	operator== (const MVBaseline &other) const
	Equality comparisons.
Bool	operator!= (const MVBaseline &other) const
Bool	near (const MVBaseline &other, Double tol=1e-13) const
Bool	near (const MVBaseline &other, Quantity tol) const
Bool	nearAbs (const MVBaseline &other, Double tol=1e-13) const
MVBaseline	operator- () const
	Addition and subtraction.
MVBaseline &	operator+= (const MVBaseline &right)
MVBaseline	operator+ (const MVBaseline &right) const
MVBaseline &	operator-= (const MVBaseline &right)
MVBaseline	operator- (const MVBaseline &right) const
virtual uInt	type () const
	Tell me your type.
virtual void	adjust ()
	Normalise direction aspects by adjusting the length to 1.
virtual void	adjust (Double &res)
	Adjustment with returned factor.
virtual void	readjust (Double res)
	Re-adjust using factor given.
virtual Double	radius ()
	Get radius of Baseline.
Vector< Double >	get () const
	Generate a 3-vector of coordinates (length(m), angles(rad)).
const Vector< Double > &	getValue () const
	Generate a 3-vector of x,y,z in m.
Quantum< Vector< Double > >	getAngle () const
	Generate angle 2-vector (in rad).
Quantum< Vector< Double > >	getAngle (const Unit &unit) const
	and with specified units
Quantity	getLength () const
	Generate the length.
Quantity	getLength (const Unit &unit) const
	and generate it with the specified units
Double	BaselineAngle (const MVBaseline &other) const
	Get the Baseline angle between the directions.
Quantity	BaselineAngle (const MVBaseline &other, const Unit &unit) const
Double	separation (const MVBaseline &other) const
	Get the angular separation between two directions.
Quantity	separation (const MVBaseline &other, const Unit &unit) const
MVBaseline	crossProduct (const MVBaseline &other) const
	Produce the cross product.
virtual void	print (ostream &os) const
	Print data.
virtual MeasValue *	clone () const
	Clone.
virtual Vector< Double >	getVector () const
	Get the value in internal units.
virtual void	putVector (const Vector< Double > &in)
	Set the value from internal units (set 0 for empty vector).
virtual Vector< Quantum< Double > >	getRecordValue () const
	Get the internal value as a `Vector<Quantity>`.
virtual Vector< Quantum< Double > >	getXRecordValue () const
virtual Vector< Quantum< Double > >	getTMRecordValue () const
virtual Bool	putValue (const Vector< Quantum< Double > > &in)
	Set the internal value if correct values and dimensions.
Static Public Member Functions
static void	assure (const MeasValue &in)

Detailed Description

A 3D vector on Earth.

Intended use:

Public interface

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25
Test programs:: tMBaseline

Prerequisite

MeasValue

Etymology

From Measure, Value and Baseline

Synopsis

A MVBaseline is a 3-vector of Baselines in a rectangular frame with internal units of m.
It can be constructed with:

MVBaseline() creates point at origin (0,0,0)
MVBaseline(MVBaseline) creates a copy
MVBaseline(Double, Double, Double) creates (x,y,z) with specified values (assuming meters)
MVBaseline(Quantity length,Double, Double) creates a MVBaseline assuming that the two values are (in radians) angle along 'equator' and towards 'pole'.
MVBaseline(Quantity length, Quantity, Quantity) creates a MVBaseline assuming angles as in previous, or Baselines
MVBaseline(Quantity, Quantum<Vector<Double> >) creates a MVBaseline from angle vector, using first two angles, and assuming second as zero if not present.
MVBaseline(Quantum<Vector<Double> > creates from angles or Baselines, depending on the units in the quantum vector. In the angle case, the data derived can be scaled with the readjust() function. If the unit of the quantum vector is length, Baseline is assumed.
MVBaseline(Vector<Double> creates from angles (less than or equal to two elements) or x,y,z (3 elements).
MVBaseline(Vector<Quantity> creates from length+angles, angles, or x,y,z, depending on units.
MVBaseline(MVPosition, MVPosition) creates a baseline pointing from second to first MVPosition
MVBaseline(MVPosition) creates a baseline as defined by the position given (e.g. as derived from an offset MPosition)

A void adjust(Double) function normalises the vector to a length of 1; a get() returns as a Double 3-vector the length and angles of the Baseline vector; a getAngle() returns a Quantum 2-vector, (uInt) returns the indicated element, and getValue returns the vector.
Baselines can be added and subtracted.
The multiplication of two Baselines produces the in-product.

Example

See MBaseline class.

Motivation

To do coordinate transformations

To Do

Nothing I know of

Definition at line 107 of file MVBaseline.h.

Constructor & Destructor Documentation

casacore::MVBaseline::MVBaseline ( )

Default constructor generates a (0,0,0) Baseline.

casacore::MVBaseline::MVBaseline ( const MVPosition & other )

Copy constructor.

casacore::MVBaseline::MVBaseline	(	Double	in0,
		Double	in1,
		Double	in2
	)

Creates a specified vector.

casacore::MVBaseline::MVBaseline ( Double in0 ) [explicit]

Creates a vector with specified length towards pole.

casacore::MVBaseline::MVBaseline ( const Quantity & l )

casacore::MVBaseline::MVBaseline	(	const Quantity &	l,
		Double	angle0,
		Double	angle1
	)

Creates the Baseline from specified (azimuth,elevation) angles and length.

casacore::MVBaseline::MVBaseline	(	const Quantity &	l,
		const Quantity &	angle0,
		const Quantity &	angle1
	)

Creates the Baseline from specified angles and length.

or Baselines

Thrown Exceptions

AipsError if quantities not in angle format

casacore::MVBaseline::MVBaseline ( const Quantum< Vector< Double > > & angle )

If not enough angles: pole assumed (if none), or elevation =0 (if 1).

casacore::MVBaseline::MVBaseline	(	const Quantity &	l,
		const Quantum< Vector< Double > > &	angle
	)

casacore::MVBaseline::MVBaseline ( const Vector< Double > & other )

Create from specified length and/or angles and/or Baseline.

casacore::MVBaseline::MVBaseline ( const Vector< Quantity > & other )

casacore::MVBaseline::MVBaseline	(	const MVPosition &	pos,
		const MVPosition &	base
	)

Baseline as difference between positions (first - second (default(0,0,0)).

casacore::MVBaseline::~MVBaseline ( )

Destructor.

Member Function Documentation

virtual void casacore::MVBaseline::adjust ( Double & res ) [virtual]

Adjustment with returned factor.

Quantity casacore::MVBaseline::BaselineAngle	(	const MVBaseline &	other,
		const Unit &	unit
	)			const

Bool casacore::MVBaseline::near	(	const MVBaseline &	other,
		Quantity	tol
	)			const

Bool casacore::MVBaseline::nearAbs	(	const MVBaseline &	other,
		Double	tol = `1e-13`
	)			const

Quantity casacore::MVBaseline::separation	(	const MVBaseline &	other,
		const Unit &	unit
	)			const