- LICENSE AND COPYRIGHT
Geo::Compass::Variation - Accurately calculate magnetic declination and inclination
use Geo::Compass::Variation qw(mag_dec mag_inc); my $lat = 53.1234567; my $lon = -114.1234567; my $alt = 1098; my $declination = mag_dec($lat, $lon, $alt); my $inclination = mag_inc($lat, $lon, $alt);
This module calculates and returns the Magnetic declination and inclination (dip) calculations based on WMM earth magnetism model for a specified latitude and longitude pair.
See NOAA for details.
The WMM data is currently valid from January 1, 2015 through December 31, 2019. This module will be updated with new WMM data as it becomes available. (Last update was the 2015v2 dataset, implemented 2019-05-19).
All functions must be imported explicitly:
use Geo::Compass::Variation qw(mag_dec mag_inc); # or use Geo::Compass::Variation qw(:all);
mag_dec function has an alias of
mag_var which can be imported explicitly, or with the
Calculates and returns the magnetic declination of a pair of GPS coordinates.
Mandatory, Float: Latitude, in signed notation (eg:
53.1111111. Negative is South and positive is North of the Equator.
Mandatory, Float: Longitude, in signed notiation (eg:
-114.11111. Negative is West and positive is East of the Prime Meridian.
Optional, Integer: Altitude above sea level, in metres. Defaults to
Optional, Integer|Float: The year to base the calculation from. Defaults to
YYYY is the year from
M is the month number from
localtime(), normalized to a digit between 1-10.
die() if the year is out of range of the current WMM specification.
Return: A floating point number representing the magnetic declination.
Simply an alias for "mag_dec".
Calculates and returns the magnetic inclination of a pair of GPS coordinates.
Parameters are exactly the same as for the "mag_dec" function. Please review that documentation section for full details.
Return: A floating point number representing the magnetic inclination.
Core function that calcluates the raw magnetic field north component (
$X), the east component (
$Y) and the vertical component (
Takes the same parameters as "mag_dec". Please see that function's documentation for full details.
<steveb at cpan.org>
Copyright 2017 Steve Bertrand.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.