@ngageoint/geopackage-mobile-optimizer — Optimize GeoPackages for mobile consumption

This utility will convert a GeoPackage into a GeoPackage which allows for friendly consumption on a web mercator mobile or web map. The utility will convert to EPSG:3857 and place tiles aligned with regular XYZ coordinates. This allows the clients to read the tiles from the tile tables without reprojecting or cropping.

Installation

$ npm install @ngageoint/geopackage-mobile-optimizer

Usage

Command Line

./mobile-optimizer /path/to/file/to/convert.gpkg /path/to/file/to/create.gpkg

Javascript

const fs = require('fs');
const { GeoPackageAPI, setCanvasKitWasmLocateFile } = require('@ngageoint/geopackage');
const GeoPackageOptimizer = require('@ngageoint/geopackage-mobile-optimizer');
const path = require('path');
const async = require('async');

const geoPackageFile = '/path/to/file/to/convert.gpkg';
const outputGeoPackageFile = '/path/to/file/to/create.gpkg';
const same = outputGeoPackageFile === geoPackageFile;

setCanvasKitWasmLocateFile(file => path.join(__dirname, 'node_modules', '@ngageoint', 'geopackage', 'dist', 'canvaskit', file));

async.series({
    fileExists: function(callback) {
      fs.stat(geoPackageFile, function(err, stats) {
        if (err || !stats || !stats.isFile()) {
          return callback('File does not exist.');
        } else {
          return callback(null, true);
        }
      });
    },
    geoPackage: function(callback) {
      GeoPackageAPI.open(geoPackageFile).then((result) => {
        console.log('Processing %s', geoPackageFile);
        return callback(null, result);
      }).catch(() => {
        return callback('Invalid GeoPackage file.');
      });
    },
    outputGeoPackage: function (callback) {
      GeoPackageAPI.create(outputGeoPackageFile).then((result) => {
        return callback(null, result);
      }).catch(() => {
        return callback('Invalid GeoPackage file.');
      });
    }
  },
  function(err, results) {
    if (err) {
      console.log('Failed to convert with error', err);
      process.exit(1);
    } else {
      GeoPackageOptimizer.optimize({inputGeoPackage: results.geoPackage, outputGeoPackage: results.outputGeoPackage, same: same}, (err) => {
        if (err) {
          console.error('Optimization Failed: ' + err);
        } else {
          console.log('Optimization Complete, optimized file: %s', outputGeoPackageFile);
        }
        process.exit(0);
      });
    }
  });

GeoPackage JS Library

The GeoPackage Libraries were developed at the National Geospatial-Intelligence Agency (NGA) in collaboration with BIT Systems. The government has "unlimited rights" and is releasing this software to increase the impact of government investments by providing developers with the opportunity to take things in new directions. The software use, modification, and distribution rights are stipulated within the MIT license.

Pull Requests

If you'd like to contribute to this project, please make a pull request. We'll review the pull request and discuss the changes. All pull request contributions to this project will be released under the MIT license.

Software source code previously released under an open source license and then modified by NGA staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open source license.

Changelog

4.1.0

• Update to GeoPackage JS 4.1.0.

1.0.0

• Initial release.