├── .gitignore ├── Cakefile ├── package.json ├── src └── gpx.coffee ├── README.md ├── test ├── fixtures │ └── simple.gpx └── gpx.test.coffee ├── lib └── gpx.js └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .*.swp 3 | -------------------------------------------------------------------------------- /Cakefile: -------------------------------------------------------------------------------- 1 | {spawn, exec} = require 'child_process' 2 | 3 | task 'build', 'continually build the JavaScript code', -> 4 | coffee = spawn 'coffee', ['-cw', '-o', 'lib', 'src'] 5 | coffee.stdout.on 'data', (data) -> console.log data.toString().trim() 6 | 7 | task 'doc', 'rebuild the Docco documentation', -> 8 | exec([ 9 | 'docco src/xml2js.coffee' 10 | ].join(' && '), (err) -> 11 | throw err if err 12 | ) 13 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name" : "gpx.js", 3 | "description" : "A GPX parser for client and server-side JavaScript", 4 | "keywords" : ["xml", "gpx", "gps", "parser"], 5 | "homepage" : "https://github.com/Leonidas-from-XIV/gpx.js", 6 | "version" : "0.0.1", 7 | "author" : "Marek Kubica (http://xivilization.net)", 8 | "contributors" : [ 9 | "Joschka Fischer " 10 | ], 11 | "main" : "./lib/gpx", 12 | "directories" : { 13 | "lib": "./lib" 14 | }, 15 | "repository" : { 16 | "type" : "git", 17 | "url" : "https://github.com/Leonidas-from-XIV/gpx.js.git" 18 | }, 19 | "dependencies" : { 20 | "cheerio" : ">=0.8.3", 21 | "moment" : ">=1.6.2" 22 | }, 23 | "devDependencies" : { 24 | "coffee-script" : ">=1.2.0", 25 | "zap" : ">=0.2.4-1", 26 | "docco" : ">=0.3.0", 27 | "browserify" : ">=1.13.3" 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/gpx.coffee: -------------------------------------------------------------------------------- 1 | cheerio = require 'cheerio' 2 | # earth radius in km 3 | R = 6371 4 | # trying to use equatorial radius instad for now 5 | # R = 6378.1 6 | 7 | to_rad = (angle) -> 8 | angle * Math.PI / 180 9 | 10 | class exports.GPX 11 | constructor: -> 12 | undefined 13 | 14 | parseString: (xml, cb) => 15 | $ = cheerio.load xml.toString() 16 | result = [] 17 | trkpts = $('trkpt').each (i, item) -> 18 | lon = parseFloat $(item).attr 'lon' 19 | lat = parseFloat $(item).attr 'lat' 20 | elevation = $(item).find('ele') 21 | ele = parseFloat $(elevation).text() 22 | result.push {lat: lat, lon: lon, ele: ele} 23 | cb undefined, result 24 | 25 | class exports.Point 26 | constructor: (@lat, @lon, @ele) -> 27 | 28 | exports.distance2d = (a, b) -> 29 | # haversine 30 | dLat = to_rad (b.lat - a.lat) 31 | dLon = to_rad (b.lon - a.lon) 32 | lat1 = to_rad a.lat 33 | lat2 = to_rad b.lat 34 | a = Math.sin(dLat/2) * Math.sin(dLat/2) + 35 | Math.sin(dLon/2) * Math.sin(dLon/2) * Math.cos(lat1) * Math.cos(lat2) 36 | c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a)) 37 | R * c 38 | 39 | exports.distance3d = (a, b) -> 40 | planar = exports.distance2d a, b 41 | height = Math.abs a.ele - b.ele 42 | # wacky CoffeeScript precedence rules 43 | Math.sqrt Math.pow(planar, 2) + Math.pow height, 2 44 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | A parser for GPX files 2 | ====================== 3 | 4 | 5 | Beware, this is a rather early version and API is somehow still in a flux. We 6 | try to be most "correct" rather than carrying baggage. Expect things to be more 7 | stabilized once we start uploading releases to the NPM registry. 8 | 9 | 10 | Ok, so what exactly is it? 11 | -------------------------- 12 | 13 | The idea of GPX.js is to provide a friendly interface for working with GPX 14 | files. GPX files are the standard exchange format that is used for many GPS 15 | applications. Many tracks are recorded in GPX format. 16 | 17 | For some reason, there was no easy to find and use GPX library that can be used 18 | on client-side browsers and server-side code. Therefore, GPX.js was born. 19 | 20 | The idea of GPX.js is to be used to analyze and visualize GPX tracks for 21 | example using third-party libraries like 22 | [Leaflet](http://leaflet.cloudmade.com/). 23 | 24 | 25 | Roadmap 26 | ------- 27 | 28 | * Calculate speed calculation of the points 29 | * Display distance of track taken 30 | * Calculate average speed, also average moving speed 31 | * Analyze track for absolute and relative speed 32 | * Find fastest distance on track 33 | * Analyze the elevation gain and loss 34 | 35 | 36 | License 37 | ------- 38 | 39 | Apache License, Version 2.0. For easy contribution and legal security. 40 | -------------------------------------------------------------------------------- /test/fixtures/simple.gpx: -------------------------------------------------------------------------------- 1 | 2 | 3 | 9 | 10 | 11 | 12 | 1 13 | c0c0c0 14 | 15 | 16 | 84 17 | 18 | 19 | 20 | 84 21 | 22 | 23 | 24 | 83.7 25 | 26 | 27 | 28 | 83.2 29 | 30 | 31 | 32 | 83.7 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /test/gpx.test.coffee: -------------------------------------------------------------------------------- 1 | gpx = require '../lib/gpx' 2 | assert = require 'assert' 3 | fs = require 'fs' 4 | path = require 'path' 5 | 6 | assertSimilar = (expected, got, tolerance) -> 7 | assert.fail expected, got, "deviation too large", "=" if Math.abs(expected - got) > tolerance 8 | 9 | module.exports = 10 | 'test distance in 2D': (test) -> 11 | a = new gpx.Point 23, 42, 0 12 | a_high = new gpx.Point 23, 42, 200 13 | b = new gpx.Point 23.5, 42.5, 0 14 | # same point 15 | assert.equal 0, gpx.distance2d a, a 16 | # same point, different height 17 | assert.equal 0, gpx.distance2d a, a_high 18 | # different points 19 | distance = gpx.distance2d a, b 20 | assertSimilar distance, 75.5, 0.01 21 | test.finish() 22 | 23 | 'test distance in 3D': (test) -> 24 | a = new gpx.Point 10, 20, 10 25 | a_high = new gpx.Point 10, 20, 30 26 | b = new gpx.Point 15, 25, 10 27 | c = new gpx.Point 20, 30, 20 28 | # same point 29 | assert.equal 0, gpx.distance3d a, a 30 | # same point, different height 31 | assert.equal (a_high.ele - a.ele), gpx.distance3d a, a_high 32 | # different points, same height 33 | assert.equal (gpx.distance2d a, b), gpx.distance3d a, b 34 | # different points, different height 35 | distance = gpx.distance3d a, c 36 | dist2d = gpx.distance2d a, c 37 | # thx pythagoras 38 | true_distance = Math.sqrt(dist2d*dist2d + (c.ele - a.ele) * (c.ele - a.ele)) 39 | assertSimilar distance, true_distance, 0.01 40 | test.finish() 41 | 42 | 'parse GPX': (test) -> 43 | fileName = path.join __dirname, '/fixtures/simple.gpx' 44 | fs.readFile fileName, (err, data) -> 45 | parser = new gpx.GPX 46 | e = [ 47 | new gpx.Point(35.14662, 136.96714, 84), 48 | new gpx.Point(35.14665, 136.9671, 84), 49 | new gpx.Point(35.14669, 136.96706, 83.7), 50 | new gpx.Point(35.14672, 136.967, 83.2), 51 | new gpx.Point(35.14675, 136.96694, 83.7) 52 | ] 53 | parser.parseString data, (err, results) -> 54 | for i in [0...e.length] 55 | assert.deepEqual results[i], e[i] 56 | test.finish() 57 | 58 | -------------------------------------------------------------------------------- /lib/gpx.js: -------------------------------------------------------------------------------- 1 | // Generated by CoffeeScript 1.3.1 2 | (function() { 3 | var R, cheerio, to_rad, 4 | __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; }; 5 | 6 | cheerio = require('cheerio'); 7 | 8 | R = 6371; 9 | 10 | to_rad = function(angle) { 11 | return angle * Math.PI / 180; 12 | }; 13 | 14 | exports.GPX = (function() { 15 | 16 | GPX.name = 'GPX'; 17 | 18 | function GPX() { 19 | this.parseString = __bind(this.parseString, this); 20 | 21 | void 0; 22 | 23 | } 24 | 25 | GPX.prototype.parseString = function(xml, cb) { 26 | var $, result, trkpts; 27 | $ = cheerio.load(xml.toString()); 28 | result = []; 29 | trkpts = $('trkpt').each(function(i, item) { 30 | var ele, elevation, lat, lon; 31 | lon = parseFloat($(item).attr('lon')); 32 | lat = parseFloat($(item).attr('lat')); 33 | elevation = $(item).find('ele'); 34 | ele = parseFloat($(elevation).text()); 35 | return result.push({ 36 | lat: lat, 37 | lon: lon, 38 | ele: ele 39 | }); 40 | }); 41 | return cb(void 0, result); 42 | }; 43 | 44 | return GPX; 45 | 46 | })(); 47 | 48 | exports.Point = (function() { 49 | 50 | Point.name = 'Point'; 51 | 52 | function Point(lat, lon, ele) { 53 | this.lat = lat; 54 | this.lon = lon; 55 | this.ele = ele; 56 | } 57 | 58 | return Point; 59 | 60 | })(); 61 | 62 | exports.distance2d = function(a, b) { 63 | var c, dLat, dLon, lat1, lat2; 64 | dLat = to_rad(b.lat - a.lat); 65 | dLon = to_rad(b.lon - a.lon); 66 | lat1 = to_rad(a.lat); 67 | lat2 = to_rad(b.lat); 68 | a = Math.sin(dLat / 2) * Math.sin(dLat / 2) + Math.sin(dLon / 2) * Math.sin(dLon / 2) * Math.cos(lat1) * Math.cos(lat2); 69 | c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a)); 70 | return R * c; 71 | }; 72 | 73 | exports.distance3d = function(a, b) { 74 | var height, planar; 75 | planar = exports.distance2d(a, b); 76 | height = Math.abs(a.ele - b.ele); 77 | return Math.sqrt(Math.pow(planar, 2) + Math.pow(height, 2)); 78 | }; 79 | 80 | }).call(this); 81 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------