Posts

Landsliding Into PostGIS With KML Files

Landslide damaged roadway (2005)

In this post I will show, in repeatable steps, how to install PostGIS, load in geospatial data found in a KML file and run queries against that data. The focus of this geospatial data will be landslides and our resulting database will allow us to query, using longitude and latitude co-ordinates, the landslide status of a specific geographical point. The returned status for the given co-ordinates will be “Mostly Landslides”, “Few Landslides”, “Flat Land”, “Not Mapped”.

KML / KMZ Files

KML files define, in XML, geographical data in three dimensions. A KMZ file is simply a zipped KML file.

You can find many weird and wonderful KML files on the Internet, either via Google Search or via Google Earth Gallery.

Keyhole Markup Language (KML) is an XML schema for expressing geographic annotation and visualization within Internet-based, two-dimensional maps and three-dimensional Earth browsers. KML was developed for use with Google Earth, which was originally named Keyhole Earth Viewer. It was created by Keyhole, Inc, which was acquired by Google in 2004. The name “Keyhole” is an homage to the KH reconnaissance satellites, the original eye-in-the-sky military reconnaissance system first launched in 1976. KML is an international standard of the Open Geospatial Consortium. Google Earth was the first program able to view and graphically edit KML files.
KML Wikipedia

PostGIS

PostGIS is the number one architecture for dealing with geospatial data within a relational database. It works within PostgreSQL.

While working with netSIGN I had the opportunity to work briefly with PostGIS, which provides support for geographic objects within PostgreSQL. In that instance I was precisely identifying real-estate locations from longitude and latitude co-ordinates using The City Of Vancouver’s Area Boundary KML file. This time we will be looking at San Francisco Bay-Area Landslides.

Installing PostGIS

On Mac OS X you can install both PostGIS, and it’s dependency PostgreSQL, with Homebrew. For simplicity we assume that you already have PostgreSQL installed.

sudo brew install postgis

Configuring PostGIS

Login as the postgres user.

sudo su postgres

Create A PostGIS Template Database

Now we will create a template database for PostGIS within PostgreSQL from which we can create our own PostGIS database.

TEMPLATE_DB_NAME=template_postgis

# Create the template spatial database.
createdb -E UTF8 $TEMPLATE_DB_NAME

# Add PLPGSQL language support.
createlang -d $TEMPLATE_DB_NAME plpgsql

# Load the PostGIS extensions
for SQL_NAME in postgis postgis_comments spatial_ref_sys
do
    psql -d $TEMPLATE_DB_NAME -f /usr/local/Cellar/postgis/1.5.2/share/postgis/$SQL_NAME.sql
done

# Finalize our PostGIS template database
cat <<EOS | psql -d $TEMPLATE_DB_NAME
UPDATE pg_database SET datistemplate = TRUE WHERE datname = '$TEMPLATE_DB_NAME';
REVOKE ALL ON SCHEMA public FROM public;
GRANT USAGE ON SCHEMA public TO public;
GRANT ALL ON SCHEMA public TO postgres;
GRANT SELECT, UPDATE, INSERT, DELETE ON TABLE public.geometry_columns TO PUBLIC;
GRANT SELECT, UPDATE, INSERT, DELETE ON TABLE public.spatial_ref_sys TO PUBLIC;
VACUUM FULL FREEZE;
EOS

Create The Database From The Template

DB_NAME="landslide_db"
DB_USER="landslide_user"

createuser --no-superuser --createdb --no-createrole $DB_USER
createdb --template=template_postgis --encoding=UTF8 --owner=$DB_USER $DB_NAME
echo "GRANT ALL ON SCHEMA public TO $DB_USER" | psql $DB_NAME
for t in geography_columns geometry_columns spatial_ref_sys
do
    echo "ALTER TABLE $t OWNER TO $DB_USER" | psql -d $DB_NAME
done

Preparing The Geospatial Data For PostGIS

I will use some test data from San Francisco Bay-Area Landslides. From earthquake.usgs.gov we can download a KMZ file which contains the geographic information, in the form of 2-D polygons, of the landslide areas.

wget https://earthquake.usgs.gov/regional/nca/bayarea/kml/landslides.kmz

Converting KML File To ESRI Shapefile Using Ogr2ogr

We need to install the ogr2ogr command-line conversion tool. This is included with gdal and FWTools. If you install gdal-bin on Linux via apt-get then you will probably get an older version that does not decode KML 2.2 files (required in this example). I recommend building gdal-bin from source on Linux.

On my Mac I will install gdal, and hence ogr2ogr, using Homebrew.

We first have to install libkml, which is dependency of gdal if we want read KML 2.2 files. libkml is a KML file parsing engine written by Google and is used in Google Earth and Google Maps. Ogr2ogr can use libkml to read the KML files. It does have it’s own KML parser, but that will not work with the KML 2.2 file we will try to convert and generally is not as good as libkml at reading KML files. Usually, I would install libkml using Homebrew, but I found that you can only install libkml 1.2 and gdal 1.8.0beta1 requires libkml 1.3. Therefore, I will install libkml from the libkml source respository, which is currently only way to get libkml 1.3.

sudo brew install libkml # only version 1.2

svn checkout https://libkml.googlecode.com/svn/trunk libkml # currently version 1.3
cd libkml
./autogen.sh
./configure
make
sudo make install

That’s libkml installed. Now, let’s use Homebrew to install the latest version of gdal.

sudo brew install gdal --HEAD --complete

I use –complete to install all the additional file format parsers.

–HEAD is used to download the latest version from the gdal Subversion repository. I use –HEAD because, as of writing this, the current stable version is 1.7.3 and it does not provide libkml support, which is needed to read KML 2.2 files. The current version in Subversion is 1.8.0beta1.

Now the ogr2ogr conversion utility should be installed. KMZ is a zipped KML file. It is just a regular zip file, so we can unzip this by simply using the unzip command. libkml does recognize the kmz extension, so we would not usually need to do this step, but landslides.kmz does not contain the data we want, only references to it via several NetworkLinks to other KMZ files.

unzip landslides.kmz

If you have problems unzip a .kmz file, then simply rename to have a .zip extension

When we unzip landslides.kmz, we find it contains only one file called doc.kml. Here is a what the doc.kml looks like…

<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="https://www.opengis.net/kml/2.2" xmlns:gx="https://www.google.com/kml/ext/2.2" xmlns:kml="https://www.opengis.net/kml/2.2" xmlns:atom="https://www.w3.org/2005/Atom">
<Document>
  <name>Landslides</name>
  <LookAt>
    <longitude>-122.2499999599815</longitude>
    <latitude>37.62500001065743</latitude>
    <altitude>0</altitude>
    <range>413167.7811227545</range>
    <tilt>0</tilt>
    <heading>2.443095370245979e-008</heading>
    <altitudeMode>relativeToGround</altitudeMode>
  </LookAt>
  <Style>
    <ListStyle>
      <listItemType>checkHideChildren</listItemType>
      <bgColor>00ffffff</bgColor>
      <maxSnippetLines>2</maxSnippetLines>
    </ListStyle>
  </Style>
  <NetworkLink id="1">
    <name>Aetna_Springs</name>
    <Region>
      <LatLonAltBox>
        <north>38.75</north>
        <south>38.625</south>
        <east>-122.375</east>
        <west>-122.5</west>
        <minAltitude>0</minAltitude>
        <maxAltitude>0</maxAltitude>
      </LatLonAltBox>
      <Lod>
        <minLodPixels>450</minLodPixels>
        <maxLodPixels>-1</maxLodPixels>
        <minFadeExtent>128</minFadeExtent>
        <maxFadeExtent>128</maxFadeExtent>
      </Lod>
    </Region>
    <Link>
      <href>https://earthquake.usgs.gov/regional/nca/bayarea/kml/Landslides/Landslides_Aetna_Springs.kmz</href>
      <ViewRefreshMode>onRegion</ViewRefreshMode>
    </Link>
  </NetworkLink>
  <NetworkLink id="2">
    <name>Allendale</name>
    <Region>
      <LatLonAltBox>
        <north>38.5</north>
        <south>38.375</south>
        <east>-121.875</east>
        <west>-122</west>
        <minAltitude>0</minAltitude>
        <maxAltitude>0</maxAltitude>
      </LatLonAltBox>
      <Lod>
        <minLodPixels>450</minLodPixels>
        <maxLodPixels>-1</maxLodPixels>
        <minFadeExtent>128</minFadeExtent>
        <maxFadeExtent>128</maxFadeExtent>
      </Lod>
    </Region>
    <Link>
      <href>https://earthquake.usgs.gov/regional/nca/bayarea/kml/Landslides/Landslides_Allendale.kmz</href>
      <ViewRefreshMode>onRegion</ViewRefreshMode>
    </Link>
  </NetworkLink>
  <NetworkLink id="3">
    <name>Altamont</name>
    <Region>
      <LatLonAltBox>
        <north>37.75</north>
        <south>37.625</south>

Yes, KML is XML.

You will notice several <NetworkLink> blocks that contain a <Link> block that contains <href> tags that contain a web link to another KMZ file. Ideally these would be sucked in libkml when we parse the KML/KMZ file, but as Google says in it’s documentation…

In their simplest form, network links are a useful way to split one large KML file into smaller, more manageable files on the same computer.

Despite the name, a <NetworkLink> does not necessarily load files from the network.

– Courtesy of Google’s KML documentation

For this example, I’m just going to grab the first of these referenced KMZ files, Landslides_Aetna_Springs.kmz.

We will first convert this KMZ into a ESRI Shapefile using ogr2ogr.

ogr2ogr -f "ESRI Shapefile" landslides.shp Landslides_Aetna_Springs.kmz

Although, we got a few warnings, we did get our shapefile (actually, several files).

Warning 6: Normalized/laundered field name: 'description' to 'descriptio'
Warning 6: Field timestamp create as date field, though DateTime requested.

Warning 6: Field begin create as date field, though DateTime requested.

Warning 6: Field end create as date field, though DateTime requested.

Warning 6: Normalized/laundered field name: 'altitudeMode' to 'altitudeMo'

The ESRI Shapefile comprises of these files, although we usually only need to reference the .shp file.

landslides.shp
landslides.shx
landslides.prj
landslides.dbf

Converting ESRI Shapefile To SQL Using Shp2pgsql

Since PostGIS runs inside PostgreSQL, we are going need some SQL, so I will convert that ESRI Shapefile to SQL using the shp2pgsql command-line tool. The shp2pgsql tool comes with the PostGIS install, so you can run this from anywhere that you have installed PostGIS.

shp2pgsql -s 4326 -I -c -W UTF-8 landslides.shp landslides > landslides.sql

This generates landslide.sql which contains the geolocation data from Landslides_Aetna_Springs.kmz as SQL statements.

-s specifies the SRID field. Since Google Maps uses SRID 4326 (“WGS84″) for this, we will use the same.

A Spatial Reference System Identifier (SRID) is a unique value used to unambiguously identify projected, unprojected, and local spatial coordinate system definitions. These coordinate systems form the heart of all GIS applications.
– Wikipedia

We also specifiy landslides as the name of database table that we will be inserting into. landslides.sql will contain a create table statement using this name and the subsequent INSERT statements within landslides.sql will insert into this table.

Here are the other options I have used for the shp2pgsql command.

-c Creates a new table and populates it, this is the default if you do not specify any options.
-I Create a spatial index on the geocolumn.
-S Generate simple geometries instead of MULTI geometries.
-W <encoding> Specify the character encoding of Shape’s attribute column. (default : “WINDOWS-1252″)

Multipolygons

Previously I have also used the -S switch with shp2pgsql, but for this KMZ file I got the following message.

We have a Multipolygon with 40 parts, can't use -S switch!
-S Generate simple geometries instead of MULTI geometries.

The SQL

Let’s take a look at the SQL generated…

SET CLIENT_ENCODING TO UTF8;
SET STANDARD_CONFORMING_STRINGS TO ON;
BEGIN;
CREATE TABLE "landslides" (gid serial PRIMARY KEY,
"name" varchar(80),
"descriptio" varchar(80),
"timestamp" date,
"begin" date,
"end" date,
"altitudemo" varchar(80),
"tessellate" numeric(10,0),
"extrude" numeric(10,0),
"visibility" numeric(10,0));
SELECT AddGeometryColumn('','landslides','the_geom','4326','MULTIPOLYGON',4);

INSERT INTO "landslides" ("name","descriptio","timestamp","begin","end","altitudemo",
"tessellate","extrude","visibility",the_geom) VALUES ('Mostly Landslide','Mostly Landslide',
NULL,NULL,NULL,NULL,'1','0','-1',
'01060000E0E61000002800000001030000E0E610000001000000060000009B559FABAD985EC0000000000060434000000
0000000F03F0000000000000000C0EC9E3C2C985EC00000000000604340000000000000F03F0000000000000000711B0DE
02D985EC032207BBDFB5F4340000000000000F03F0000000000000000386744696F985EC032207BBDFB5F4340000000000
000F03F000000000000000038F8C264AA985EC032207BBDFB5F4340000000000000F03F00000000000000009B559FABAD9
85EC00000000000604340000000000000F03F000000000000000001030000E0E61000000100000005000000613255302A9
95EC00000000000604340000000000000F03F00000000000000004CA60A4625995EC00000000000604340000000000000
F03F0000000000000000FED478E926995EC0DC291DACFF5F4340000000000000F03F0000000000000000B003E78C28995E
C00000000000604340000000000000F03F0000000000000000613255302A995EC00000000000604340000000000000F03F
0000000... (truncated)

INSERT INTO "landslides" ("name","descriptio","timestamp","begin","end","altitudemo",
"tessellate","extrude","visibility",the_geom) VALUES ('Few Landslides','Few Landslides',
NULL,NULL,NULL,NULL,'1','0','-1',
'01060000E0E61000001B00000001030000E0E610000004000000490600000000000000985EC0A83AE466B85D434000000
0000000F03F0000000000000000C7BAB88D06985EC068B3EA73B55D4340000000000000F03F000000000000000040A4DF
BE0E985EC0282CF180B25D4340000000000000F03F0000000000000000075F984C15985EC02F51BD35B05D434000000000
0000F03F00000000000000006ABC749318985EC076FD82DDB05D4340000000000000F03F00000000000000001CEBE2361
A985EC004560E2DB25D4340000000000000F03F0000000000000000CE1951DA1B985EC0D95A5F24B45D43400000000000
00F03F000000000000000095D4096822985EC0761A69A9BC5D4340000000000000F03F00000000000000004703780B249
85EC02849D74CBE5D4340000000000000F03F00000000000000005C8FC2F528985EC092CB7F48BF5D4340000000000000F
03F0000000000000000C0EC9E3C2C985EC0B6A1629CBF5D4340000000000000F03F0000000000000000234A7B832F985EC
092CB7F48BF5D4... (truncated)

The INSERT commands are pretty long, so I’ve truncated them here, but you can get the general idea.

Loading SQL Into PostGIS

We can now load the SQL we generated into our database. This is an easy step.

psql -d $DB_NAME $DB_USER < landslides.sql

You see something like this, if all goes well.

SET
SET
BEGIN
NOTICE:  CREATE TABLE will create implicit sequence "landslides_gid_seq" for serial column "landslides.gid"
NOTICE:  CREATE TABLE / PRIMARY KEY will create implicit index "landslides_pkey" for table "landslides"
CREATE TABLE
                       addgeometrycolumn
----------------------------------------------------------------
 public.landslides.the_geom SRID:4326 TYPE:MULTIPOLYGON DIMS:4
(1 row)

INSERT 0 1
INSERT 0 1
INSERT 0 1
INSERT 0 1
CREATE INDEX
COMMIT

Running SQL Queries Against Our PostGIS Database

DB_NAME="landslide_db"
DB_USER="landslide_user"

psql -d $DB_NAME $DB_USER

Our landslide database has four definitions of landslides, each mapping to a complex set of polgons (table column “the_geom” is TYPE:MULTIPOLYGON). Here are their names.

landslide_db=> SELECT name FROM landslides;
       name
------------------
 Mostly Landslide
 Few Landslides
 Flat Land
 Not Mapped
(4 rows)

Let’s look for landslides at latitude and longtitude position -122.3800, 38.7499. Here we find a bad location (meaning you would not build your house there) since this is in the bounds of “Mostly Landslide”.

landslide_db=> SELECT name FROM landslides WHERE ST_Contains(the_geom,
ST_GeomFromWKB(ST_AsEWKB('POINT(-122.3800 38.7499)'::geometry), 4326));
       name
------------------
 Mostly Landslide
(1 row)

Let’s find somewhere with less landslides. Maybe -122.3752, 38.7321?

landslide_db=> SELECT name FROM landslides WHERE ST_Contains(the_geom,
ST_GeomFromWKB(ST_AsEWKB('POINT(-122.3752 38.73215)'::geometry), 4326));
      name
----------------
 Few Landslides
(1 row)

That is pretty good, but flat land would be better.

landslide_db=> SELECT name FROM landslides WHERE ST_Contains(the_geom,
ST_GeomFromWKB(ST_AsEWKB('POINT(-122.4015 38.74941)'::geometry), 4326));
   name
-----------
 Flat Land
(1 row)

Bingo! We’ve found some flat land that is landslide free. This seems like a safe place to conclude this blog post.

Conclusion

In this blog post I went through the steps needed to convert and load a KML 2.2 file into a PostGIS enabled PostgreSQL database. We installed PostGIS and all the tools needed to convert our KML file into an ESRI Shapefile and then into SQL statements that could be ran in PostgreSQL. We can now run SQL queries against our database which will return the landslide status for any given longitude and latitude within the focus area.