Difference between revisions of "User:Wenslayer/KMLGenerator"

From Geohashing
imported>Wenslayer
m (→‎Solution)
imported>Wenslayer
(Update reflecting new version of script; move to-do's to discussion page)
Line 8: Line 8:
  
 
Kudos to [[User:Polysylabic Pseudonym|Psud]] for providing the [http://www.amipsychic.net/geohashing.html Geohashing historical coordinates].
 
Kudos to [[User:Polysylabic Pseudonym|Psud]] for providing the [http://www.amipsychic.net/geohashing.html Geohashing historical coordinates].
 +
 +
See [[User_talk:{{PAGENAME}}|discussion page]] for to-do's.
  
 
== Usage ==
 
== Usage ==
 
<pre>
 
<pre>
−
Usage: ./gen_geohash_kml.pl -g <graticule> [-i <input file>] [-n <name>] [-l] [-v]
+
Usage: ./gen_geohash_kml.pl -g <graticule[:<graticule>]> [-i <input file>] [-n <name>] [-l] [-v]
−
        -g: graticule of interest (format: <latitude,longitude>)
+
-g: graticule of interest (format: "<latitude>,<longitude>")
−
        -i: input file to use (file format: YYYY-MM-DD,<DOW>,<LAT>,<LON>)
+
add more with colon separator
−
                default: '-' for standard input
+
-i: input file to use (file format: "YYYY-MM-DD,<DOW>,<LAT>,<LON>")
−
        -n: name of top-level KML folder holding place markers
+
default: '-' for standard input
−
                default: "Geohash History for {graticule}"
+
-n: name of top-level KML folder holding place markers
−
                ("{graticule}" is replaced with actual graticule supplied)
+
default: "Geohash History for {graticule}"
−
        -l: generate a label for each place marker corresponding to its date
+
"{graticule}" is replaced with actual graticule(s) supplied
−
                default is to suppress a label for the place marker
+
-l: generate a label for each place marker corresponding to its date
−
        -v: enable verbose logging
+
default is to suppress a label for the place marker
 +
-v: enable verbose logging
  
 
Notes:
 
Notes:
Line 26: Line 29:
 
   http://www.amipsychic.net/geohashing.html
 
   http://www.amipsychic.net/geohashing.html
 
* Resulting KML file is displayed to standard out.
 
* Resulting KML file is displayed to standard out.
−
* You may wish to pre-process the source file to only show dates of interest.
+
* The resulting KML file will organize the place markers into folders by:
−
   E.g.: grep "^2009" allcoords.csv | ./gen_geohash_kml.pl -g 49,-123 > 2009.kml
+
   Graticule -> Year -> Year-Month
  
 
Reference:
 
Reference:
−
* http://wiki.xkcd.com/geohashing</pre>
+
* http://wiki.xkcd.com/geohashing
  
−
== Examples ==
+
Examples:
 +
* You can choose to generate a resulting KML file from the source data all
 +
  in one command, like this:
 +
  $ wget -O - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
 +
    bzip2 -d | gen_geohash_kml.pl -g 49,-123 > 49,-123_all.kml
  
−
Using the source data, Geohash coordinates can be generated for every day since October 1st, 1928 (over 80 years worth), so with a little filtering, you should be able to generate a KML file for whatever date range and graticule you'd like.
+
  ...or first stage the data to a local file:
 +
  $ wget -O - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
 +
    bzip2 -d > allcoords.csv
  
−
[[Image:KML Generator - Google Earth screen shot 1.jpg|thumb|right|Victoria Geohash coordinates since 2008-05-21. Note how few Geohash coordinates actually fall in Victoria and the Saanich Peninsula?]]
+
  ...and then generate the KML file from the local file:
 +
  $ gen_geohash_kml.pl -g 48,-123:49,-123 -i allcoords.csv > VicVan_all.kml
  
−
Examples:
+
* You may wish to pre-process the source file to only show dates of interest:
−
* Generate a KML for the [[Surrey, British Columbia|Surrey]] graticule of all possible Geohash coordinates since October 1st, 1928 (over 29,000 points!):
+
  $ grep "^2009" allcoords.csv |  
−
<pre>
+
    gen_geohash_kml.pl -g 49,-122:49,-123:48,-123 > VanSurBham_2009.kml
−
$ wget -qO - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
 
−
      bzip2 -d | gen_geohash_kml.pl -g 49,-122 > 49,-122_all.kml
 
−
</pre>
 
  
−
* Generate a KML for the [[Vancouver, British Columbia|Vancouver]] graticule of all Canada Day and Christmas Day dates, with each place marker having a label (its date), and modifying the name of the set of place markers:
+
* Use of -l and -n flag:
−
<pre>
+
  $ sed -nre '/-(07-01|12-25)/p' allcoords.csv | gen_geohash_kml.pl  
−
$ wget -qO - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
+
    -g 48,-123 -l -n "Canada/Xmas Day in {graticule}" > Van_7.1_12.25.kml
−
      bzip2 -d | sed -nre '/-(07-01|12-25)/p' |
 
−
      gen_geohash_kml.pl -g 48,-123 -l -n "Geohash coords for Canada/Christmas Day in {graticule}" > 48,-123_7.1_12.25.kml
 
−
</pre>
 
  
−
* Generate a KML for the [[Victoria, British Columbia|Victoria]] graticule of all dates since the original Geohash webcomic (May 21st, 2008):
+
* Multiple graticules since a particular date:
−
<pre>
+
  $ sed -ne '/^2008-05-21/,$p' allcoords.csv | gen_geohash_kml.pl  
−
$ wget -qO - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
+
    -g 49,-123:48,-123:49,-122:48,-122 > VanVicSurBham_since_2009-05-21.kml
−
      bzip2 -d | sed -ne '/^2008-05-21/,$p' |
 
−
      gen_geohash_kml.pl -g 49,-123 > 49,-123_since_2009-05-21.kml
 
 
</pre>
 
</pre>
−
 
−
== To Do ==
 
−
 
−
# <s>Convert script from Bash to Perl to run faster.</s>
 
−
#* '''Done''', parsing all the data only takes a few seconds now, as opposed to many minutes.
 
−
# <s>Automate retrieval and decompression of source data.</s>
 
−
#* '''Punted'''; I'd rather not, mostly due to [http://www.faqs.org/docs/artu/ch01s06.html#id2877684 The Art of Unix Programming's Rule of Composition: Design programs to be connected with other programs].
 
−
# <s>Pretty-up each placemark's description to include hyperlinks to this Wiki and peeron map.</s>
 
−
#* '''Done'''; don't need link to peeron map (you're in a mapping application already!).
 
−
# Add format checking of source data.
 
−
#* A few regex's, combined with some numeric range testing ought to do the trick.
 
−
# <s>Properly account for W30 graticules.</s>
 
−
#* '''Punted''', due to #2, this would be left for an exercise to the user.
 
−
# <s>Add option to display labels for each place marker.</s>
 
−
#* '''Done'''.
 
−
# <s>Add option to override default <name> tag for KML document.</s>
 
−
#* '''Done'''.
 
−
# Add ability to specify more than one graticule at a time.
 
−
#* May involve adding support to read from a config file.
 

Revision as of 00:11, 8 July 2009

Problem

Have you wondered what historical Geohashes have occurred in your graticule? Have you wanted to see them all at once, instead of typing each date in via peeron? Well this script might help you out here.

Solution

I've submitted a script to the Perforce Public Depot; the script can be downloaded here:

Kudos to Psud for providing the Geohashing historical coordinates.

See discussion page for to-do's.

Usage

Usage: ./gen_geohash_kml.pl -g <graticule[:<graticule>]> [-i <input file>] [-n <name>] [-l] [-v]
	-g: graticule of interest (format: "<latitude>,<longitude>")
		add more with colon separator
	-i: input file to use (file format: "YYYY-MM-DD,<DOW>,<LAT>,<LON>")
		default: '-' for standard input
	-n: name of top-level KML folder holding place markers
		default: "Geohash History for {graticule}"
		"{graticule}" is replaced with actual graticule(s) supplied
	-l: generate a label for each place marker corresponding to its date
		default is to suppress a label for the place marker
	-v: enable verbose logging

Notes:
* You can get *all* retro Geohash data from:
  http://www.amipsychic.net/geohashing.html
* Resulting KML file is displayed to standard out.
* The resulting KML file will organize the place markers into folders by:
  Graticule -> Year -> Year-Month

Reference:
* http://wiki.xkcd.com/geohashing

Examples:
* You can choose to generate a resulting KML file from the source data all
  in one command, like this:
   $ wget -O - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
     bzip2 -d | gen_geohash_kml.pl -g 49,-123 > 49,-123_all.kml

  ...or first stage the data to a local file:
   $ wget -O - http://www.amipsychic.net/coords/allcoords.csv.bz2 |
     bzip2 -d > allcoords.csv

  ...and then generate the KML file from the local file:
   $ gen_geohash_kml.pl -g 48,-123:49,-123 -i allcoords.csv > VicVan_all.kml

* You may wish to pre-process the source file to only show dates of interest:
   $ grep "^2009" allcoords.csv | 
     gen_geohash_kml.pl -g 49,-122:49,-123:48,-123 > VanSurBham_2009.kml

* Use of -l and -n flag:
   $ sed -nre '/-(07-01|12-25)/p' allcoords.csv | gen_geohash_kml.pl 
     -g 48,-123 -l -n "Canada/Xmas Day in {graticule}" > Van_7.1_12.25.kml

* Multiple graticules since a particular date:
   $ sed -ne '/^2008-05-21/,$p' allcoords.csv | gen_geohash_kml.pl 
     -g 49,-123:48,-123:49,-122:48,-122 > VanVicSurBham_since_2009-05-21.kml
Retrieved from "https://geohashing.site/index.php?title=User:Wenslayer/KMLGenerator&oldid=207532"
Powered by MediaWiki