TSAGeoMag

java.lang.Object
- geoMag.TSAGeoMag

```
public class TSAGeoMag
extends java.lang.Object
```
Downloaded from http://www.ngdc.noaa.gov/geomag/WMM/thirdpartycontributions.shtml on 26 April, 2011.
This is a class to generate the magnetic declination, magnetic field strength and inclination for any point on the earth. The true bearing = magnetic bearing + declination. This class is adapted from an Applet from the NOAA National Data Center at http://www.ngdc.noaa.gov/seg/segd.shtml. None of the calculations were changed. This class requires an input file named WMM-95.DAT, which must be in the same directory that the application is run from. NOTE: The original version of the applet, calculated the declination as a function of the date. This class assumes a date of 1 January 1999, using the 1995 geomagnetic data. The WMM-95.DAT file will probably be updated by NOAA in Dec 1999. This version assumes the calculation is wanted for an altitude of sea level. Using the correct date, the declination is accurate to about 0.5 degrees. This is the LANL D-3 version of the GeoMagnetic calculator from the NOAA National Data Center at http://www.ngdc.noaa.gov/seg/segd.shtml. Adapted by John St. Ledger, Los Alamos National Laboratory June 25, 1999 Verified by comparison to the source code downloaded from the web. The declination calculated by that source is exactly the same as this class. The applet on the web calculates a declination several minutes different than this class. Suspect this is the difference between the DOD model used in this class and the IGRF model of the magnetic field. Does not return the grid variation near the poles. These lines commented out, and can easily be restored. Version 2 Comments: The world magnetic model is updated every 5 years. The data for 2000 uses the same algorithm to calculate the magnetic field field variables. The only change is in the spherical harmonic coefficients in the input file. The input file has been renamed to WMM.COF. Once again, the date was fixed. This time to January 1, 2001. Also, a deprecated constructor for StreamTokenizer was replaced, and the error messages in the catch clause were changed. Methods to get the field strength and inclination were added.

Version:

3.0 January 19, 2000 Updated for 2000 data., 4.0 March 1, 2002 Changed so that if data file doesn't exist, it uses an internal version of the coefficients from the 2000 update., 5.0 June 1, 2005 Changed so that if data file doesn't exist, it uses an internal version of the coefficients from the 2005 update. Previously, only calculated the declination at sea level for one date. Now can return all of the variables as a function of date and altitude. Original version used float variables. All changed to type double. Does not check if the input date is within the valid block., 5.1 June 20, 2005 Fixed a bug discoverd by Alvin Liem. In my zeal to clean up compiler comments I deleted some double casts for integers that resulted in an integer division being made when double division was needed. References: JOHN M. QUINN, DAVID J. KERRIDGE AND DAVID R. BARRACLOUGH, WORLD MAGNETIC CHARTS FOR 1985 - SPHERICAL HARMONIC MODELS OF THE GEOMAGNETIC FIELD AND ITS SECULAR VARIATION, GEOPHYS. J. R. ASTR. SOC. (1986) 87, PP 1143-1157 DEFENSE MAPPING AGENCY TECHNICAL REPORT, TR 8350.2: DEPARTMENT OF DEFENSE WORLD GEODETIC SYSTEM 1984, SEPT. 30 (1987) JOSEPH C. CAIN, ET AL.; A PROPOSED MODEL FOR THE INTERNATIONAL GEOMAGNETIC REFERENCE FIELD - 1965, J. GEOMAG. AND GEOELECT. VOL. 19, NO. 4, PP 335-355 (1967) (SEE APPENDIX) ALFRED J. ZMUDA, WORLD MAGNETIC SURVEY 1957-1969, INTERNATIONAL ASSOCIATION OF GEOMAGNETISM AND AERONOMY (IAGA) BULLETIN #28, PP 186-188 (1971) JOHN M. QUINN, RACHEL J. COLEMAN, MICHAEL R. PECK, AND STEPHEN E. LAUBER; THE JOINT US/UK 1990 EPOCH WORLD MAGNETIC MODEL, TECHNICAL REPORT NO. 304, NAVAL OCEANOGRAPHIC OFFICE (1991) JOHN M. QUINN, RACHEL J. COLEMAN, DONALD L. SHIEL, AND JOHN M. NIGRO; THE JOINT US/UK 1995 EPOCH WORLD MAGNETIC MODEL, TECHNICAL REPORT NO. 314, NAVAL OCEANOGRAPHIC OFFICE (1995) WMM-2000 is a National Imagery and Mapping Agency (NIMA) standard product. It is covered under NIMA Military Specification: MIL-W-89500 (1993). For information on the use and applicability of this product contact DIRECTOR NATIONAL IMAGERY AND MAPPING AGENCY/HEADQUARTERS ATTN: CODE P33 12310 SUNRISE VALLEY DRIVE RESTON, VA 20191-3449 (703) 264-3002 The FORTRAN version of GEOMAG PROGRAMMED BY: JOHN M. QUINN 7/19/90 FLEET PRODUCTS DIVISION, CODE N342 NAVAL OCEANOGRAPHIC OFFICE (NAVOCEANO) STENNIS SPACE CENTER (SSC), MS 39522-5001 USA PHONE: COM: (601) 688-5828 AV: 485-5828 FAX: (601) 688-5521 NOW AT: GEOMAGNETICS GROUP U. S. GEOLOGICAL SURVEY MS 966 FEDERAL CENTER DENVER, CO 80225-0046 USA PHONE: COM: (303) 273-8475 FAX: (303) 273-8600 EMAIL: quinn@ghtmail.cr.usgs.gov

Constructor Summary

Constructors
Constructor and Description

TSAGeoMag()
Instantiates object by calling InitModel().

Constructors
Constructor and Description
`TSAGeoMag()` Instantiates object by calling InitModel().

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`getDeclination(double dlat, double dlong)` Returns the declination from the 2005 Department of Defense geomagnetic model and data, in degrees.
`double`	`getDeclination(double dlat, double dlong, double year, double altitude)` Returns the declination from the 2005 Department of Defense geomagnetic model and data, in degrees.
`double`	`getDip(double dlat, double dlong)` Returns the magnetic field dip angle from the 2000 Department of Defense geomagnetic model and data, in degrees.
`double`	`getDip(double dlat, double dlong, double year, double altitude)` Returns the magnetic field dip angle from the 2000 Department of Defense geomagnetic model and data, in degrees.
`double`	`getEastIntensity(double dlat, double dlong)` Returns the easterly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getEastIntensity(double dlat, double dlong, double year, double altitude)` Returns the easterly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getHorizontalIntensity(double dlat, double dlong)` Returns the horizontal magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getHorizontalIntensity(double dlat, double dlong, double year, double altitude)` Returns the horizontal magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getIntensity(double dlat, double dlong)` Returns the magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getIntensity(double dlat, double dlong, double year, double altitude)` Returns the magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getNorthIntensity(double dlat, double dlong)` Returns the northerly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getNorthIntensity(double dlat, double dlong, double year, double altitude)` Returns the northerly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getVerticalIntensity(double dlat, double dlong)` Returns the vertical magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`double`	`getVerticalIntensity(double dlat, double dlong, double year, double altitude)` Returns the vertical magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
`static void`	`main(java.lang.String[] args)` Prints out a table of test values for verification

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TSAGeoMag
```
public TSAGeoMag()
```
    Instantiates object by calling InitModel().
- Method Detail
  - getDeclination
```
public double getDeclination(double dlat,
                    double dlong)
```
    Returns the declination from the 2005 Department of Defense geomagnetic model and data, in degrees. The magnetic heading + declination = true heading. (True heading + variation = magnetic heading.)
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getDeclination
```
public double getDeclination(double dlat,
                    double dlong,
                    double year,
                    double altitude)
```
    Returns the declination from the 2005 Department of Defense geomagnetic model and data, in degrees. The magnetic heading + declination = true heading. (True heading + variation = magnetic heading.)
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - The date as a decimial year.
    altitude - The altitude in kilometers.
  - getIntensity
```
public double getIntensity(double dlat,
                  double dlong)
```
    Returns the magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getIntensity
```
public double getIntensity(double dlat,
                  double dlong,
                  double year,
                  double altitude)
```
    Returns the magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - Date of the calculation in decimal years.
    altitude - Altitude of the calculation in kilometers.
  - getHorizontalIntensity
```
public double getHorizontalIntensity(double dlat,
                            double dlong)
```
    Returns the horizontal magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getHorizontalIntensity
```
public double getHorizontalIntensity(double dlat,
                            double dlong,
                            double year,
                            double altitude)
```
    Returns the horizontal magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - Date of the calculation in decimal years.
    altitude - Altitude of the calculation in kilometers.
  - getVerticalIntensity
```
public double getVerticalIntensity(double dlat,
                          double dlong)
```
    Returns the vertical magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getVerticalIntensity
```
public double getVerticalIntensity(double dlat,
                          double dlong,
                          double year,
                          double altitude)
```
    Returns the vertical magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - Date of the calculation in decimal years.
    altitude - Altitude of the calculation in kilometers.
  - getNorthIntensity
```
public double getNorthIntensity(double dlat,
                       double dlong)
```
    Returns the northerly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getNorthIntensity
```
public double getNorthIntensity(double dlat,
                       double dlong,
                       double year,
                       double altitude)
```
    Returns the northerly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - Date of the calculation in decimal years.
    altitude - Altitude of the calculation in kilometers.
  - getEastIntensity
```
public double getEastIntensity(double dlat,
                      double dlong)
```
    Returns the easterly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getEastIntensity
```
public double getEastIntensity(double dlat,
                      double dlong,
                      double year,
                      double altitude)
```
    Returns the easterly magnetic field intensity from the 2005 Department of Defense geomagnetic model and data in nano Tesla.
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - Date of the calculation in decimal years.
    altitude - Altitude of the calculation in kilometers.
  - getDip
```
public double getDip(double dlat,
            double dlong)
```
    Returns the magnetic field dip angle from the 2000 Department of Defense geomagnetic model and data, in degrees. Uses default date (2007) and altitude (0).
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
  - getDip
```
public double getDip(double dlat,
            double dlong,
            double year,
            double altitude)
```
    Returns the magnetic field dip angle from the 2000 Department of Defense geomagnetic model and data, in degrees. Uses default date (2007) and altitude (0).
    
    Parameters:
    dlat - Latitude in decimal degrees.
    dlong - Longitude in decimal degrees.
    year - Date of the calculation in decimal years.
    altitude - Altitude of the calculation in kilometers.
  - main
```
public static void main(java.lang.String[] args)
```
    Prints out a table of test values for verification

Class TSAGeoMag

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TSAGeoMag

Method Detail

getDeclination

getDeclination

getIntensity

getIntensity

getHorizontalIntensity

getHorizontalIntensity

getVerticalIntensity

getVerticalIntensity

getNorthIntensity

getNorthIntensity

getEastIntensity

getEastIntensity

getDip

getDip

main