Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

measures.earthmagnetic - Function

	Package	general
	Module	measures
	Tool	measures

define an earthmagnetic measure

Synopsis
earthmagnetic(rf, v0, v1, v2, off)

Arguments

rf	in	reference code
		Allowed:	coded string
v0	in	longitude or x
		Allowed:	quantity
		Default:	0G
v1	in	latitude or y
		Allowed:	quantity
		Default:	0..
v2	in	height or z
		Allowed:	quantity
		Default:	90..
off	in	optional offset
		Allowed:	earthmagnetic measure
		Default:	F

Returns
earthmagnetic measure

Description
earthmagnetic defines an earthmagnetic measure from the CLI. It needs a reference code, earthmagnetic quantity values (see introduction for the action on a scalar quantity with either a vector or scalar value, and when a vector of quantities is given) if the reference code is not for a model, and optionally it can specify an offset, which in itself has to be a earthmagnetic. In general you specify a model (IGRF is the default and the only one known) and convert it to an explicit field. (See

 http://fdd.gsfc.nasa.gov/IGRF.html

for information on the International Geomagnetic Reference Field). The earthmagnetic quantity values should be either longitude (angle), latitude(angle) and length(field strength); or x,y,z (field). See quantity for possible angle formats.

Example

- dm.earthmagnetic('igrf')
[type=earthmagnetic, refer=IGRF, m2=[value=1e-06, unit=nT],
		      m1=[unit=nT, value=0], m0=[unit=nT, value=6.123234e-23]]
- dm.measure(dm.earthmagnetic('igrf'), 'j2000')
[type=earthmagnetic, refer=J2000, m2=[value=47232.741, unit=nT],
		      m1=[unit=nT, value=-14627.3775],
		       m0=[unit=nT, value=25892.4992]]