OSGeo Cartographic Engine

Summer of Code 2010: This project has been proposed for SoC 2010

JOIN MAILING LIST: A list is now available for discussion around these concepts/ideas: Carto list. - NOTE: This is not actually about building an API, rather about establishing from specifications for interaction between some common applications and a map production engine. -

Motivation
There are plans for new/rewritten cartographic tools (map composer) for QGIS, as well as for GRASS. We suggest to develop a joint library for the various functions which could be shared across GRASS, QGIS and other projects with bindings to Qt, Python etc. The concept applies to all OSGeo projects in general as well - so high quality production can be something all projects have access to without having to code it from scratch in their own applications.

This applies to web mapping applications as well as desktop ones where high resolution, large format printing is required. But it also applies generally to smaller print jobs as well, e.g. high resolution laser printers.

The GUI part for exporting layouts, etc. could be done within the individual software projects, while this project focuses on standard libraries or command line utilities to process compliant documents. The production of a printing interchange specification/standard is needed as well. An advanced layout tool in the form of a GUI would also be very useful.

The concepts and idea below are quite diverse and represent a broad range of input. If a SoC student takes on this project, part of their job would be to help focus on a particular part of the problem (and possible clarify some of the others into workable sized components).

Ideas for Summer of Code 2010 Project
This year the project will focus on building the capabilities using the http://mapnik.org Mapnik] package. It supports XML based configuration files, but needs additions to handle the needs of this project. The QGIS Quantumnik plugin is an excellent example of moving toward the end goal of this project.

Some further ideas to consider (add your own!!):
 * An approach for transforming XML files from other applications into format compatible with Mapnik or this project specs
 * How to handle caching web services at the proper resolution for printing?
 * Consider icon collision handling
 * Tweaking Mapnik and underlying Cairo library to handle text/font exporting better
 * ...what else....?

A workplan might look like this, but is totally open to new ideas:
 * 1) Review existing map definition standards (e.g. from a few desktop and web applications Configuration Files)
 * 2) Identify missing components from those standards.
 * 3) Create new specification or make a choice of existing one.  Document the primary components as necessary for other app developers to build to its specification.
 * 4) Identify print-specific options/configuration (and challenges) needed for producing a hard copy. (see Potential Components below for an idea of overall concept)
 * 5) Write scripts to consume a compliant document and produce a output file - e.g. postscript, PDF or raster.  (See discussion below re: output formats)
 * 6) If possible, write a sample GUI for one OSGeo project to use the specification.

Functionality
Shared functions may include


 * class breaks (various algorithms)
 * histogram analysis
 * color ramps
 * RGB and possibly CYMK support (aka color transformations) etc.
 * Algorithms for intelligent label placement -- for example, collision management based on rotated extent rectangles. Also, collision management against line and polygon and point features.  Provision for prioritized set of text placement rules, first one to prevent collision wins.
 * Symbology management
 * map surround
 * legend
 * cartographic templates (ie. predefined map styles)
 * parse and print map (geovisualization) description files

This paper might be worth looking at: Extended Cartographic Interfaces for Open Distributed Processing

Programming Language

 * C? C++?

Perhaps we could implement the core in C++, but provide a high level C API for applications and environments wanting to drive the library. C++ is a strong implementation language, but presenting a C API to the outside world reduces complexity calling from other languages or compiler versions and reduces "interface fragility".


 * Python bindings?

There has been talk on the GMT mailing list about Python bindings to the core C API. Since GMT already has a wealth of routines for plotting directly to PS|EPS format files, this route may give developers a great head-start. There has been some work on the integration of GRASS and GMT in the past, with several user-submitted modules.

Output Formats
What output formats do we want to target. I think at the core this question comes down to whether we want to render everything to a raster format or whether we wish to preserve linework, and text in non-raster form. That is, whether output output is a raster format, or a raster+vector+text format like postscript/pdf.

If a cartographic product is the objective, I think selection of an output format like PDF makes a lot of sense, but it does make interactive composition more complicated and it is possible we have limited pdf/postscript development expertise in our developer community (the GMT developers may be of help here...).

What about the possibility of exporting SVG and using Inkscape for cartographic styling and design? Inkscape is written in C++ and already has a wealth of vector graphics functionality. You could also consider using Scribus for map layout. I believe Scribus is also written in C++. Why implement the great functionality that already exists in open source programs?

Coming from the Web Mapping angle it will be interesting to be able to acquire OGC WMS maps with a pixel sizes < 0.28 mm (which is the current standard of ~ 72 or 90 dpi). This option has been suggested as a change request and is currently being discussed. It will allow to compose high resolution print maps also using OGC WMS.

Actually (2008) some GIS desktop allow to export the view to SVG format (QGIS, OpenJUMP, etc). While almost all software could save to SVG throughtPDF/Postscript drivers (ex PDF creator, opensurce). Implementing a complete symbology in Inkscape would be preferable and would solve many problem of compatibility between GIS desktops. There are some proposal available on the web: GFOSS (in Italian).

Existing code to be recycled
There will be code in GRASS, QGIS, the Python Cartographic Library (http://zcologia.org/cartography) and other sources which could be integrated (check license compatibility). Please indicate precisely where to find the source code, license, programming language. Please keep in mind that this is underlying library, not the graphical user interface.


 * Label placement code:
 * Mapserver labeling code (MapServer License, C language)
 * GRASS v.label.sa (GPL, C language)
 * PAL/JPAL cartographic labelling library (GPL, C++ language, JNI wrapper)
 * Color management:
 * MapGuide Color (LGPL.C++)
 * OpenJump ?


 * Stylization
 * Cartagen Geo Style Sheets: http://wiki.cartagen.org/wiki/show/HomePage (more)


 * Symbology
 * S-52 standard for nautical chart (ENC) symbology and cartography from the International Hydrographic Bureau
 * GPL library implementing the S-52 standard (OpenEV)


 * Class breaks:
 * GRASS different algorithms for class breaks (GPL, C)
 * MapGuide CalculateDistribution (LGPL.C++)


 * Data access:
 * GDAL WMS driver can help grab tiles at appropriate scale/size/resolution (to what extent?)


 * Output:
 * Postscript/PDF output:
 * GRASS ps.map (Postscript output) and PS driver (GPL, C)
 * GeoFunctions: Geographic XML to PDF. Not sure what specific code, but the project leaders might have some insight.
 * PNG output:
 * GRASS PNG driver (GPL, C)
 * See AGG below
 * CAIRO output
 * GRASS CAIRO driver (GPL, C)
 * Cairo Graphics Library (LGPL or MPL)
 * Mapnik is a Free Toolkit for developing mapping applications, that can also output via Cairo
 * Mapnik configure file format (XML)
 * Many applicable utilities for handling Mapnik stuff.. here - e.g cascadenik css for styling and nik2img for command line testing!

End User Needs

 * Print to small format medium (eg 8.5in x 11in, 11in x 14in) and large format (eg 34 x 44in)
 * Interactive layout
 * High quality printing
 * Storage of cartographic symbolizing
 * Symbols library
 * Separate cartographic and geographic representation (eg changes to carto does not affect geo).
 * Generalization on-the-fly, based on current scale.
 * Rules based cartography stored in RDBMS (eg series 400 highways are blue with double lines)
 * Multiple export formats
 * Geotiff
 * PNG
 * PDF / GeoPDF
 * Postscript (need for directly sending files to printers)
 * SVG
 * Layout Functionality
 * Text-based configuration file that applications can output to or humans can manually hack/script
 * Common, interoperable data file input options
 * Customizable legend with Symbology representation (textures, object symbols, etc.)

Design Modeling
Issues of layout will always be important in creating the final cartographic product. Layout templating such as that used in Natural Resources Canada's (NRCAN) Cartographic Design Specifications (http://ess.nrcan.gc.ca/pubs/carto/downloads/design_specs.pdf#page=13).

Perhaps we can learn from the desktop publishing world from the likes of the Scribus project (http://www.scribus.net/). Maybe being able to export a certain portion to scribus to handle some the major layout hurdles. A link between the cartographic library and scribus could allow for auto generation of some layout features and text such as changing declination, Projection info, and others.

XML and PDF
OSGEO might be able to get behind the Geo Functions project. "Geo Functions is an open-source library of XSLT-2 / XQuery functions, templates, stylesheets and classes devoted to the processing of geographic data in XML." I understand that the original purpose of the project is to produce PDF maps from XML based data.

Potential Components
Breaking the end goal into some components will help to recognise which area(s) there is greatest need. There seems to be at least four primary components to the proposal.

Style & Layout Configuration Standards

 * Specifications for styling of features and layout of a map composition
 * Could re-use existing approaches where applicable (e.g. SLD, WMC, MapServer Mapfile, OGR Feature Styles)
 * Specifications to be used in map definition/configuration files

Graphical Style & Layout Editor

 * To create styles interactively
 * To define map layout
 * Could be stand-alone
 * Could be adopted as part of another application
 * Saves a style/layout definition document according to above standards

Graphical Map Composition Editor

 * Implemented by existing applications (e.g. GRASS, QGIS, etc.)
 * Sets up pointers to data layers
 * Assigns styles definitions to the layers
 * Applies layout definition to maps
 * Outputs a map composition configuration file

Rendering Engine

 * Stand-alone application (no GUI)
 * Reads standard map composition configuration file
 * Reads and applies the required style/layout definition documents
 * Outputs final graphics to specific files

Libraries

 * Sets of libraries could be created to implement parts of the above sections
 * Add more here...

Technologies

 * Examples of application Configuration Files
 * AGG (sophisticated rendering of vector/text graphics to raster format - used by MapServer, MapGuide, Mapnik).
 * Freetype - text management and rendering library
 * Cairo graphics library - vector, text and raster input, various output including Postscript
 * OpenGIS Symbology Encoding Schema A language for describing coverage and feature styles
 * MapFish print module

Workflow
By working from the end product to a workflow might let us identify specific libraries to help with each task in the workflow required to produce a map. Edit at will.


 * read geo data
 * geometries
 * projection
 * metadata (if required)
 * apply styling
 * feature to style coding
 * Cartographic edits
 * overide some of the geometry if required (eg roads don't run through lakes)
 * manual edits / retouching
 * Produce other cartographic edits objects
 * create suround
 * create grids
 * create legend
 * create scale bar
 * create north arrow
 * Copyright notices from text file or DB
 * Licensing notices from text fiel or DB
 * Other
 * Output size

Other Workflow Models

 * Generic GRASS-GMT Workflow
 * Quality Digital Cartography with GMT and GRASS

License
It is proposed to license the OSGeo Cartographic Library under LGPL. The license needs to be GPL compliant.

Interested people

 * Markus Neteler (proposer)
 * Horst Düster
 * Martin Landa: GRASS developer
 * Marco Hugentobler
 * Frank Warmerdam
 * Agustin Diez
 * Moritz Lennert
 * Dave Sampson: End User, Search and Rescue Maps,
 * Dylan Beaudette: Soil Science Researcher, OSGeo evangelist
 * Tyler Mitchell: Interested in Cairo through Mapnik
 * Robert Hollingsworth
 * Wolf Bergenheim: v.label.sa developer
 * Hamish Bowman: ps.map developer
 * Giuseppe Aruta: Geologist
 * Roy Braam: Software Engineer
 * Ionut Iosifescu
 * Ari Jolma: Wants to go ahead with Cairo
 * Vasile Crăciunescu
 * Peter Rushforth
 * Bjorn Sandvik: thematicmapping.org
 * Jo Cook
 * Mateusz Loskot (potential tester, contributor and user)
 * Dimitris Kotzinos
 * Robert Barta: semantic aspects of visualisation
 * Giovanni Allegri: Environmental Geologist, (Web)GIS and RS Researcher
 * Maksim Sestic
 * Olivier Ertz: PAL/JPAL project, OGC Symbology Encoding conformance
 * Brian Lee: cartographer,GISer.
 * Alessandro Frigeri: Researcher (geophysics, planetary sciences).
 * Dane Springmeyer: Mapnik Dev, keen on addressing gap in high-res printing from OS GIS
 * Allan Hollander: GIS analyst and GRASS user