Planet Tools
User Guide
V1.2 Beta © esri 2017
3rd April 2017
Contents
Introduction...............................................................................................................................................................3
Installation.................................................................................................................................................................3
Installing third party modules. ..................................................................................... Error! Bookmark not defined.
Installing the GP Tool. ................................................................................................. Error! Bookmark not defined.
Installing the Planet Python Raster Type....................................................................... Error! Bookmark not defined.
Pre-requisites for GP Tool........................................................................................................................................3
Planet Tools toolbox. ..................................................................................................................................................4
Query Planet ..........................................................................................................................................................4
Activate Planet Imagery .............................................................................................. Error! Bookmark not defined.
Activation Status.....................................................................................................................................................6
Download Planet Imagery .......................................................................................................................................6
Defining an Amazon Profile using OptimizeRasters GP Tool....................................................................................7
Building a Mosaic Dataset........................................................................................................................................8
Introduction
Planet Tools is a Python toolbox with a set of tools to query, activate & download Planet Imagery. It leverages the
Planet API, requiring the user to have a uerID and API key to work. This can be obtained from Planet directly.
The toolbox can be used in ArcGIS desktop and ArcGIS Pro. Supported version of ArcGIS Desktop is 10.5. The toolbox is
currently in beta stage.
Installation
Double click on the file ‘Setup Planet Tools.exe’ to start the setup process.
If ArcGIS 10.5 is installed the option to install the tools for ArcGIS Desktop will be displayed and selected.
If ArcGIS Pro is installed the option to install the tools for ArcGIS Pro will be displayed and selected.
Note: Planet tools is currently not supported by ArcGIS Pro. The installation will only install the Planet raster type.
Pre-requisites for GP Tool
To successfully connect and query the planet API one must have Planet login and API ke y. Please contact your Planet
representative to obtain the same. Once you obtain the credentials, log in and retain the API key. See screen shot below.
The GP tool also downloads and transfers data to an Amazon S3 bucket using another GP Tool called O ptimizeRasters.
OptimizeRasters has been included in this package to facilitate this transfer. To upload to the Amazon bucket you need
to first specify Account key and secret key using the Profile Editor GP tool found within the OptimizeRasters toolbox.
Keep a note of the Profile Name defined in this profile editor. It will be needed later. Ignore this step if all downloads ar e
to be local.
Planet Tools toolbox.
Below is a list of the tools and the description. The order of the tools listed below is also the order in which the tools
need to be run in order to successfully download data from Planet.
1.
2.
3.
4.
Query Planet
Activation Status
Download Planet Imagery
Build Mosaic Dataset.
Query Planet
The Query tool allows you to connect to the Planet API and query the database for the images based on the following
criteria:
-
Area of Interest
Cloud Cover
Start and End Date
Also required is the API key or access code and output feature class.
Click on Show Help for any additional information.
The result from a query would be a feature class containing the footprints and attributes of the scene.
Activation Status
There is a chance that the scenes the user is requesting for may already be activated by another user. Use this tool with
the same feature class and selection set as used in the activation tool to check for the status of activation.
Download Planet Imagery
Planet Imagery can be downloaded locally or can be copied to Amazon S3 bucket using this tool. The tool uses
OptimizeRasters to download the imagery from Planet. To download the imagery locally is pretty straight forward.
The output paths specified in the Tool has to point to on disk paths on the machine that you are running the tool on.
To copy data from Planet to your own bucket you need to have entries as follows. The output location and cache
location will change according to your machine. You also need to have a Amazon Profile defined.
Defining an Amazon Profile using OptimizeRasters GP Tool.
To define a profile open up the OptimizeRasters GPTool and select Profile Editor.
Here, define the name of the profile that will be picked up by OptimizeRasters and enter Amazon provided access key
and secret key.
Building a Mosaic Dataset.
Use this tool to build a mosaic dataset of the data that has been download from Planet. Currently this will only work for
4 band PlanetScope Scenes. You also need to have the Planet Raster type installed as described in the installation
section above.
Below are typical entries in the dialog.