Skip to content

Commit

Permalink
Update to 2015 WMM
Browse files Browse the repository at this point in the history 
Added 2015 WMM.COF
Updated GeomagnetismLibrary to current
Updated DeclinationTests to 2015 results
  • Loading branch information
@garmstro
garmstro committed May 29, 2015
1 parent 081ab08 commit b022da3
Show file tree
Hide file tree
Showing 6 changed files with 1,060 additions and 514 deletions.
18 changes: 18 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Xcode
#
build/
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata
*.xccheckout
*.moved-aside
DerivedData
*.hmap
*.ipa
*.xcuserstate
166 changes: 116 additions & 50 deletions ObjectiveWMM/WMM/GeomagnetismHeader.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
* 3. Sun Solaris with GCC Compiler
*
*
* Revision Number: $Revision: 833 $
* Revision Number: $Revision: 1288 $
* Last changed by: $Author: awoods $
* Last changed on: $Date: 2012-04-16 14:01:51 -0600 (Mon, 16 Apr 2012) $
* Last changed on: $Date: 2014-12-09 16:43:07 -0700 (Tue, 09 Dec 2014) $
*
*
*/
Expand All @@ -17,21 +17,45 @@
#define _POSIX_C_SOURCE
#endif

//#ifndef EPOCHRANGE
//#define EPOCHRANGE (int)5
//#endif
/*
#ifndef EPOCHRANGE
#define EPOCHRANGE (int)5
#endif
*/

#ifndef GEOMAGHEADER_H
#define GEOMAGHEADER_H

#define READONLYMODE "r"
#define MAXLINELENGTH (1024)
#define NOOFPARAMS (15)
#define NOOFCOEFFICIENTS (7)


#define _DEGREE_NOT_FOUND (-2)
#define CALCULATE_NUMTERMS(N) (N * ( N + 1 ) / 2 + N)

#ifndef WMMHEADER_H
#define WMMHEADER_H
/*These error values come from the ISCWSA error model:
*http://www.copsegrove.com/Pages/MWDGeomagneticModels.aspx
*/
#define INCL_ERROR_BASE (0.20)
#define DECL_ERROR_OFFSET_BASE (0.36)
#define F_ERROR_BASE (130)
#define DECL_ERROR_SLOPE_BASE (5000)
#define WMM_ERROR_MULTIPLIER 1.21
#define IGRF_ERROR_MULTIPLIER 1.21

/*These error values are the NGDC error model
*
*/
#define WMM_UNCERTAINTY_F 152
#define WMM_UNCERTAINTY_H 133
#define WMM_UNCERTAINTY_X 138
#define WMM_UNCERTAINTY_Y 89
#define WMM_UNCERTAINTY_Z 165
#define WMM_UNCERTAINTY_I 0.22
#define WMM_UNCERTAINTY_D_OFFSET 0.24
#define WMM_UNCERTAINTY_D_COEF 5432


#ifndef M_PI
#define M_PI ((2)*(acos(0.0)))
Expand All @@ -44,11 +68,13 @@
#ifndef TRUE
#define TRUE ((int)1)
#endif

#ifndef FALSE
#define FALSE ((int)0)
#endif




#define MAG_PS_MIN_LAT_DEGREE -55 /* Minimum Latitude for Polar Stereographic projection in degrees */
#define MAG_PS_MAX_LAT_DEGREE 55 /* Maximum Latitude for Polar Stereographic projection in degrees */
#define MAG_UTM_MIN_LAT_DEGREE -80.5 /* Minimum Latitude for UTM projection in degrees */
Expand All @@ -68,16 +94,17 @@ [email protected]*/

typedef struct {
double EditionDate;
double epoch; //Base time of Geomagnetic model epoch (yrs)
double epoch; /*Base time of Geomagnetic model epoch (yrs)*/
char ModelName[32];
double *Main_Field_Coeff_G; // C - Gauss coefficients of main geomagnetic model (nT)
double *Main_Field_Coeff_H; // C - Gauss coefficients of main geomagnetic model (nT)
double *Secular_Var_Coeff_G; // CD - Gauss coefficients of secular geomagnetic model (nT/yr)
double *Secular_Var_Coeff_H; // CD - Gauss coefficients of secular geomagnetic model (nT/yr)
int nMax; // Maximum degree of spherical harmonic model
int nMaxSecVar; //Maxumum degree of spherical harmonic secular model
int SecularVariationUsed; //Whether or not the magnetic secular variation vector will be needed by program
double CoefficientFileEndDate; //
double *Main_Field_Coeff_G; /* C - Gauss coefficients of main geomagnetic model (nT) Index is (n * (n + 1) / 2 + m) */
double *Main_Field_Coeff_H; /* C - Gauss coefficients of main geomagnetic model (nT) */
double *Secular_Var_Coeff_G; /* CD - Gauss coefficients of secular geomagnetic model (nT/yr) */
double *Secular_Var_Coeff_H; /* CD - Gauss coefficients of secular geomagnetic model (nT/yr) */
int nMax; /* Maximum degree of spherical harmonic model */
int nMaxSecVar; /* Maximum degree of spherical harmonic secular model */
int SecularVariationUsed; /* Whether or not the magnetic secular variation vector will be needed by program*/
double CoefficientFileEndDate;

} MAGtype_MagneticModel;

typedef struct {
Expand All @@ -90,9 +117,9 @@ typedef struct {
} MAGtype_Ellipsoid;

typedef struct {
double lambda; // longitude
double phi; // geodetic latitude
double HeightAboveEllipsoid; // height above the ellipsoid (HaE)
double lambda; /* longitude */
double phi; /* geodetic latitude */
double HeightAboveEllipsoid; /* height above the ellipsoid (HaE) */
double HeightAboveGeoid; /* (height above the EGM96 geoid model ) */
int UseGeoid;
} MAGtype_CoordGeodetic;
Expand All @@ -110,14 +137,6 @@ typedef struct {
double DecimalYear; /* decimal years */
} MAGtype_Date;

/*typedef struct {
int MAG_Mercator;
int MAG_LambertConformalConic;
int MAG_PolarStereographic;
int MAG_TransverseMercator;
} MAGtype_MapProjectionCode;
Deprecated, Will be removed in the next revision.*/

typedef struct {
double *Pcup; /* Legendre Function */
double *dPcup; /* Derivative of Legendre fcn */
Expand Down Expand Up @@ -165,6 +184,13 @@ typedef struct {
int UseGeoid; /*Is the Geoid being used?*/
} MAGtype_Geoid;

typedef struct {
int UseGradient;
MAGtype_GeoMagneticElements GradPhi; /* phi */
MAGtype_GeoMagneticElements GradLambda; /* lambda */
MAGtype_GeoMagneticElements GradZ;
} MAGtype_Gradient;

typedef struct {
char Longitude[40];
char Latitude[40];
Expand Down Expand Up @@ -216,28 +242,39 @@ enum YYYYMMDD {

/*Prototypes */

/*Functions that should be Magnetic Model member functions*/



/*Wrapper Functions*/
int MAG_Geomag(MAGtype_Ellipsoid Ellip,
MAGtype_CoordSpherical CoordSpherical,
MAGtype_CoordGeodetic CoordGeodetic,
MAGtype_MagneticModel *TimedMagneticModel,
MAGtype_GeoMagneticElements *GeoMagneticElements);

void MAG_Gradient(MAGtype_Ellipsoid Ellip,
MAGtype_CoordGeodetic CoordGeodetic,
MAGtype_MagneticModel *TimedMagneticModel,
MAGtype_Gradient *Gradient);

int MAG_Grid(MAGtype_CoordGeodetic minimum,
MAGtype_CoordGeodetic maximum,
double step_size,
double altitude_step_size,
double time_step,
MAGtype_MagneticModel *MagneticModel,
MAGtype_Geoid *geoid,
MAGtype_Ellipsoid Ellip,
MAGtype_Date StartDate,
MAGtype_Date EndDate,
int ElementOption,
int PrintOption,
MAGtype_CoordGeodetic maximum,
double cord_step_size,
double altitude_step_size,
double time_step,
MAGtype_MagneticModel *MagneticModel,
MAGtype_Geoid *Geoid,
MAGtype_Ellipsoid Ellip,
MAGtype_Date StartDate,
MAGtype_Date EndDate,
int ElementOption,
int UncertaintyOption,
int PrintOption,
char *OutputFile);

int MAG_robustReadMagneticModel_Large(char *filename, char* filenameSV, MAGtype_MagneticModel **MagneticModel, int array_size);

int MAG_robustReadMagneticModel_Large(char *filename, char* filenameSV, MAGtype_MagneticModel **MagneticModel);

int MAG_robustReadMagModels(char *filename, MAGtype_MagneticModel *(*magneticmodels)[], int array_size);

Expand Down Expand Up @@ -268,12 +305,16 @@ int MAG_GetUserInput(MAGtype_MagneticModel *MagneticModel,
MAGtype_CoordGeodetic *CoordGeodetic,
MAGtype_Date *MagneticDate);

void MAG_PrintGradient(MAGtype_Gradient Gradient);

void MAG_PrintUserData(MAGtype_GeoMagneticElements GeomagElements,
MAGtype_CoordGeodetic SpaceInput,
MAGtype_Date TimeInput,
MAGtype_MagneticModel *MagneticModel,
MAGtype_Geoid *Geoid);



int MAG_ValidateDMSstringlat(char *input, char *Error);

int MAG_ValidateDMSstringlong(char *input, char *Error);
Expand Down Expand Up @@ -304,34 +345,47 @@ void MAG_PrintWMMFormat(char *filename, MAGtype_MagneticModel *MagneticModel);

void MAG_PrintEMMFormat(char *filename, char *filenameSV, MAGtype_MagneticModel *MagneticModel);

void MAG_PrintSHDFFormat(char *filename, MAGtype_MagneticModel *(*MagneticModel)[], int epochs);

int MAG_readMagneticModel(char *filename, MAGtype_MagneticModel *MagneticModel);

int MAG_readMagneticModel_Large(char *filename, char *filenameSV, MAGtype_MagneticModel *MagneticModel);

int MAG_readMagneticModel_SHDF(char *filename, MAGtype_MagneticModel *(*magneticmodels)[], int array_size);

int MAG_swab_type();

char *MAG_Trim(char *str);

float MAG_FloatSwap(float f);

/*Conversions, Transformations, and other Calculations*/
void MAG_BaseErrors(double DeclCoef, double DeclBaseline, double InclOffset, double FOffset, double Multiplier, double H, double* DeclErr, double* InclErr, double* FErr);

int MAG_CalculateGeoMagneticElements(MAGtype_MagneticResults *MagneticResultsGeo, MAGtype_GeoMagneticElements *GeoMagneticElements);

void MAG_CalculateGradientElements(MAGtype_MagneticResults GradResults, MAGtype_GeoMagneticElements MagneticElements, MAGtype_GeoMagneticElements *GradElements);

int MAG_CalculateSecularVariationElements(MAGtype_MagneticResults MagneticVariation, MAGtype_GeoMagneticElements *MagneticElements);

int MAG_CalculateGridVariation(MAGtype_CoordGeodetic location, MAGtype_GeoMagneticElements *elements);

void MAG_CartesianToGeodetic(MAGtype_Ellipsoid Ellip, double x, double y, double z, MAGtype_CoordGeodetic *CoordGeodetic);

MAGtype_CoordGeodetic MAG_CoordGeodeticAssign(MAGtype_CoordGeodetic CoordGeodetic);

int MAG_DateToYear(MAGtype_Date *Calendar_Date, char *Error);

void MAG_DegreeToDMSstring(double DegreesOfArc, int UnitDepth, char *DMSstring);

void MAG_DMSstringToDegree(char *DMSstring, double *DegreesOfArc);

void MAG_ErrorCalc(MAGtype_GeoMagneticElements B, MAGtype_GeoMagneticElements* Errors);

int MAG_GeodeticToSpherical(MAGtype_Ellipsoid Ellip, MAGtype_CoordGeodetic CoordGeodetic, MAGtype_CoordSpherical *CoordSpherical);

MAGtype_GeoMagneticElements MAG_GeoMagneticElementsAssign(MAGtype_GeoMagneticElements Elements);

MAGtype_GeoMagneticElements MAG_GeoMagneticElementsScale(MAGtype_GeoMagneticElements Elements, double factor);

MAGtype_GeoMagneticElements MAG_GeoMagneticElementsSubtract(MAGtype_GeoMagneticElements minuend, MAGtype_GeoMagneticElements subtrahend);

int MAG_GetTransverseMercator(MAGtype_CoordGeodetic CoordGeodetic, MAGtype_UTMParameters *UTMParameters);

int MAG_GetUTMParameters(double Latitude,
Expand All @@ -349,10 +403,12 @@ int MAG_RotateMagneticVector(MAGtype_CoordSpherical,

void MAG_SphericalToCartesian(MAGtype_CoordSpherical CoordSpherical, double *x, double *y, double *z);

void MAG_SphericalToGeodetic(MAGtype_Ellipsoid Ellip, MAGtype_CoordSpherical CoordSpherical, MAGtype_CoordGeodetic *CoordGeodetic);

void MAG_TMfwd4(double Eps, double Epssq, double K0R4, double K0R4oa,
double Acoeff[], double Lam0, double K0, double falseE,
double falseN, int XYonly, double Lambda, double Phi,
double *X, double *Y, double *pscale, double *CoM); //Rewrite this?
double *X, double *Y, double *pscale, double *CoM);

int MAG_YearToDate(MAGtype_Date *Date);

Expand All @@ -368,6 +424,11 @@ int MAG_ComputeSphericalHarmonicVariables(MAGtype_Ellipsoid Ellip,
int nMax,
MAGtype_SphericalHarmonicVariables * SphVariables);

void MAG_GradY(MAGtype_Ellipsoid Ellip, MAGtype_CoordSpherical CoordSpherical, MAGtype_CoordGeodetic CoordGeodetic,
MAGtype_MagneticModel *TimedMagneticModel, MAGtype_GeoMagneticElements GeoMagneticElements, MAGtype_GeoMagneticElements *GradYElements);

void MAG_GradYSummation(MAGtype_LegendreFunction *LegendreFunction, MAGtype_MagneticModel *MagneticModel, MAGtype_SphericalHarmonicVariables SphVariables, MAGtype_CoordSpherical CoordSpherical, MAGtype_MagneticResults *GradY);

int MAG_PcupHigh(double *Pcup, double *dPcup, double x, int nMax);

int MAG_PcupLow(double *Pcup, double *dPcup, double x, int nMax);
Expand Down Expand Up @@ -398,9 +459,6 @@ int MAG_TimelyModifyMagneticModel(MAGtype_Date UserDate, MAGtype_MagneticModel *

/*Geoid*/

int MAG_InitializeGeoid(MAGtype_Geoid *Geoid);



int MAG_ConvertGeoidToEllipsoidHeight(MAGtype_CoordGeodetic *CoordGeodetic, MAGtype_Geoid *Geoid);
/*
Expand Down Expand Up @@ -428,9 +486,17 @@ int MAG_GetGeoidHeight(double Latitude, double Longitude, double *DeltaHeight, M
*
*/

void MAG_EquivalentLatLon(double lat, double lon, double *repairedLat, double *repairedLon);

void MAG_WMMErrorCalc(double H, MAGtype_GeoMagneticElements *Uncertainty);
void MAG_PrintUserDataWithUncertainty(MAGtype_GeoMagneticElements GeomagElements,
MAGtype_GeoMagneticElements Errors,
MAGtype_CoordGeodetic SpaceInput,
MAGtype_Date TimeInput,
MAGtype_MagneticModel *MagneticModel,
MAGtype_Geoid *Geoid);




#endif /*WMMHEADER_H*/
#endif /*GEOMAGHEADER_H*/
Loading

0 comments on commit b022da3

Please sign in to comment.