casacore::MVEarthMagnetic Class Reference

A 3D Earth magnetic field vector. More...

#include <MVEarthMagnetic.h>

Inheritance diagram for casacore::MVEarthMagnetic:

Public Member Functions
	MVEarthMagnetic ()
	Default constructor generates a (0,0,0) EarthMagnetic.
	MVEarthMagnetic (const MVPosition &other)
	Copy constructor.
	MVEarthMagnetic (Double in0, Double in1, Double in2)
	Creates a specified vector.
	MVEarthMagnetic (Double in0)
	Creates a vector with specified length towards pole.
	MVEarthMagnetic (const Quantity &l)
	MVEarthMagnetic (const Quantity &l, Double angle0, Double angle1)
	Creates the EarthMagnetic from specified (azimuth,elevation) angles and length.
	MVEarthMagnetic (const Quantity &l, const Quantity &angle0, const Quantity &angle1)
	Creates the EarthMagnetic from specified angles and length.
	MVEarthMagnetic (const Quantum< Vector< Double > > &angle)
	If not enough angles: pole assumed (if none), or elevation =0 (if 1).
	MVEarthMagnetic (const Quantity &l, const Quantum< Vector< Double > > &angle)
	MVEarthMagnetic (const Vector< Double > &other)
	Create from specified length and/or angles and/or EarthMagnetic.
	MVEarthMagnetic (const Vector< Quantity > &other)
MVEarthMagnetic &	operator= (const MVEarthMagnetic &other)
	Copy assignment.
	~MVEarthMagnetic ()
	Destructor.
Double	operator* (const MVEarthMagnetic &other) const
	Multiplication defined as in-product.
Bool	operator== (const MVEarthMagnetic &other) const
	Equality comparisons.
Bool	operator!= (const MVEarthMagnetic &other) const
Bool	near (const MVEarthMagnetic &other, Double tol=1e-13) const
Bool	near (const MVEarthMagnetic &other, Quantity tol) const
Bool	nearAbs (const MVEarthMagnetic &other, Double tol=1e-13) const
MVEarthMagnetic	operator- () const
	Addition and subtraction.
MVEarthMagnetic &	operator+= (const MVEarthMagnetic &right)
MVEarthMagnetic	operator+ (const MVEarthMagnetic &right) const
MVEarthMagnetic &	operator-= (const MVEarthMagnetic &right)
MVEarthMagnetic	operator- (const MVEarthMagnetic &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 modulus of EarthMagnetic.
Vector< Double >	get () const
	Generate a 3-vector of coordinates (length(T), angles(rad)).
const Vector< Double > &	getValue () const
	Generate a 3-vector of x,y,z in tesla.
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	earthMagneticAngle (const MVEarthMagnetic &other) const
	Get the EarthMagnetic angle between the directions.
Quantity	earthMagneticAngle (const MVEarthMagnetic &other, const Unit &unit) const
Double	separation (const MVEarthMagnetic &other) const
	Get the angular separation between two directions.
Quantity	separation (const MVEarthMagnetic &other, const Unit &unit) const
MVEarthMagnetic	crossProduct (const MVEarthMagnetic &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 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 Earth magnetic field vector.

Intended use:

Internal

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Prerequisite

Etymology

From Measure, Value and Earth Magnetic field

Synopsis

A MVEarthMagnetic is a 3-vector of the Earth's magnetic flux density in a rectangular frame with the z-axis to astronomical North pole, and x-axis towards longitude zero, in internal Units of nano tesla (== 0.00001 G).
It can be constructed with:

MVEarthMagnetic() creates (0,0,0)
MVEarthMagnetic(MVEarthMagnetic) creates a copy
MVEarthMagnetic(Double, Double, Double) creates (x,y,z) with specified values in tesla
MVEarthMagnetic(Quantity length,Double, Double) creates an MVEarthMagnetic assuming that the two values are (in radians) angle along 'equator' and towards 'pole'.
MVEarthMagnetic(Quantity length, Quantity, Quantity) creates an MVEarthMagnetic assuming angles as in previous, or (x,y,z) fields
MVEarthMagnetic(Quantity, Quantum<Vector<Double> >) creates a MVEarthMagnetic from angle vector, using first two angles, and assuming second as zero if not present, and pole if length 0.
MVEarthMagnetic(Quantum<Vector<Double> > creates from angles or fields, 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 magnetic flux density, magnetic field components are assumed.
MVEarthMagnetic(Vector<Double> creates from angles (less than or equal to two elements) or x,y,z (3 elements).
MVEarthMagnetic(Vector<Quantity> creates from length+angles, angles, or x,y,z, depending on units.

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 EarthMagnetic vector; a getAngle() returns a Quantum 2-vector, (uInt) returns the indicated element, and getValue returns the vector.
EarthMagnetics can be added and subtracted.
The multiplication of two EarthMagnetics produces the in-product.

Example

See MEarthMagnetic class.

Motivation

To use in ionospheric effect calculations

To Do

nothing I know of

Definition at line 109 of file MVEarthMagnetic.h.

Constructor & Destructor Documentation

casacore::MVEarthMagnetic::MVEarthMagnetic ( )

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

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

Copy constructor.

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

Creates a specified vector.

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

Creates a vector with specified length towards pole.

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

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

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

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

Creates the EarthMagnetic from specified angles and length.

or EarthMagnetics

Thrown Exceptions

AipsError if quantities not in angle format

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

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

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

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

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

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

casacore::MVEarthMagnetic::~MVEarthMagnetic ( )

Destructor.

Member Function Documentation

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

Adjustment with returned factor.

Quantity casacore::MVEarthMagnetic::earthMagneticAngle	(	const MVEarthMagnetic &	other,
		const Unit &	unit
	)			const

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

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

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