This repository has been archived by the owner. It is now read-only.
General CLI for DeepCore
C++ CMake
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cli
common
doc
.gitignore
CMakeLists.txt
LICENSE
README.md

README.md

OpenSpaceNet

Build Status Jenkins Build Status

OpenSpaceNet is an open-source application to perform object or terrain detection against orthorectified imagery using the DeepCore libraries. This application includes and is based on CUDA 8.0 and requires NVIDIA driver version 375 or higher to run using the GPU.

OpenSpaceNet takes a pre-trained neural network and applies it to imagery. It can use local files from your computer, or connect to DigitalGlobe servers to download maps. OpenSpaceNet uses your DigitalGlobe account to download the maps, so it can only use maps that you have already purchased. This guide will explain the basic usage of OpenSpaceNet.

Train a model

Train a model with Caffe or TensorFlow. OpenSpaceNet supports Caffe sliding window, DetectNet, and segmentation models, as well as limited TensorFlow support, currently limited to sliding window models. Once you have a trained model, you will need to package it as a gbdxm file, which is an archive format used by OpenSpaceNet.

Convert model to GBDXM

The GBDXM format stores a model in a compressed file which OSN uses. The gbdxm module acts as a link between Caffe and OSN. The executable is available on the DeepCore webpage. You will need to make it executable before you can run it chmod u+x gbdxm. Then you can convert your Caffe model to gbdxm format:

$ ./gbdxm pack -f out.gbdxm --caffe-model deploy.prototxt --caffe-trained model.caffemodel \
  --caffe-mean mean.binaryproto -t caffe -n "Airliner" -v 0 -d "Model Description" -l labels.txt \
  --image-type jpg -b -84.06163 37.22197 -84.038803 37.240162

For detailed documentation of the command line arguments, run ./gbdxm help or just ./gbdxm at the terminal.

Run with OpenSpaceNet

  1. Make sure CUDA 8.0 is installed (instructions). We are working on OSN for CUDA 9, but it will only run with 8.0 for now.

  2. Download OpenSpaceNet executable by clicking the link in the right column. You do not need to install DeepCore if you use the pre-compiled executable.

  3. Use OpenSpaceNet to apply models to map data

For descriptions of the command line arguments, consult the documentation for OpenSpaceNet. For basic usage, you can follow these examples.

If you have the images that you want to search in an image file, then you can use the --image option. This does not require any access keys.

Using a local file

Linux:

$ ./OpenSpaceNet detect --model MODEL.gbdxm --type POLYGON --format shp --output OUTPUT_FILENAME.shp \
  --nms --window-step 30 --image INPUT_IMAGE_FILENAME

Using the Maps API

If you access DigitalGlobe Maps API, then you can use your token to download maps. DeepCore will handle the maps for you, so all you need to provide is the API token, and the bounding box that you want to search in. More information on the Maps API is available on the DigitalGlobe platform page

Linux:

$ ./OpenSpaceNet detect --bbox -84.44579 33.63404 -84.40601 33.64583  --model MODEL.gbdxm \
  --type POLYGON --format shp --output OUTPUT_FILENAME.shp --confidence 99.9 --nms \
  --window-step 25 --num-downloads 200 --token API_TOKEN  --service maps-api

Using DigitalGlobe Cloud Services (DGCS)

If you have access to DigitalGlobe Cloud Services, then OpenSpaceNet can access maps using your account. You need to provide your username, password, and the appropriate token for the type of maps that you want to use. You can find information about the kinds of maps offered by DigitalGlobe of is available on our webpage.

Linux:

$ ./OpenSpaceNet detect --bbox -84.44579 33.63404 -84.40601 33.64583 --model MODEL.gbdxm \
  --type POLYGON --format shp --output OUTPUT_FILENAME.shp --confidence 99.9 --nms \
  --window-step 15 --num-downloads 200 --token MAP_TOKEN --credentials USER:PASS --service dgcs

Visualizing results

You can visualize your results using GIS software like ArcGIS or QGIS. You can configure QGIS to use DigitalGlobe maps by following these instructions. Then you can import the shapefile as a vector layer to see the model results.

Links

User Reference Guide

Building OpenSpaceNet