Download Scenes module


Quick linksDescription :: Parameters :: Parameter descriptions :: Details

Back to top

Description


Perform a query using a third-party sensor data service, and download the data that matches the query.
Back to top

Parameters


Name Caption
Output Folder Output folder
Overwrite Results Overwrite existing results
Delete Output Folder Contents Whether to delete the contents of the output folder before processing
Sensor Format The data format to download and the service to use
Acquisition Start Date Acquisition start date in the format YYYY-MM-DD
Acquisition End Date Acquisition end date in the format YYYY-MM-DD
List of Acquisition Dates A list of acquisition dates the format YYYY-MM-DD, separated by comma (,)
Choose specific acquistion dates When selected, specific dates can be specified, otherwise a date range is specified
Download MODIS scenes with adjacent dates [-8, +7] When selected, all available scenes from 8 days before the selected dates until 7 days after.
Download MODIS scenes based on grid tiles When selected, then MODIS tiles are downloaded based on specified grid tiles, otherwise they are downloaded based on an area of interest
Horizontal Tile Number The MODIS grid horizontal tile number
Vertical Tile Number The MODIS grid vertical tile number
Area of Interest A vector file name, WKT string, or GeoJSON string
Maximum Cloud Cover Scenes with a cloud cover less than or equal to the value are downloaed
Back to top

Parameter descriptions

Output Folder

The path and name of the folder to which to write the output files.

Overwrite Results

Select this check box to overwrite the existing output files, if any exist. If this check box is left clear, and an output file exists in the relevant folder, the status of the job displays a message informing you of the existence and name of the output file. The message is also written to the event log of the job.

Delete Output Folder Contents

If checked, the contents of the output folder will be deleted before downloading any data.

Sensor Format

Choose the data format you wish to download and the service from which it will be downloaded.

Available options are:

Acquisition Start Date

When querying a date range, this parameter is used as the first date of the range.

Acquisition End Date

When querying a date range, this parameter is used as the last date of the range.

List of Acquisition Dates

When querying a specific list of dates, this parameter should contain a comma separated list of dates.

Choose specific acquistion dates

When selected, the "List of Acquisition Dates" field will be used in the query. Otherwise, the "Acquisition Start Date" and "Acquisition End Date" will be used in the query.

Download MODIS scenes with adjacent dates [-8, +7]

By default, when querying MODIS scenes, a list of scenes starting 8 days before and 7 days after the requested dates will be returned. When selected all of these scenes will be downloaded, otherwise the exact dates in the query will be downloaded, and not the additional scenes.

Download MODIS scenes based on grid tiles

When selected, the "Horizontal Tile Number" and "Vertical Tile Number" will be used to query MODIS scenes. Otherwise the "Area of Interest" will be used.

Horizontal Tile Number

The horizontal grid tile number of the MODIS tile to query.

Vertical Tile Number

The vertical grid tile number of the MODIS tile to query.

Area of Interest

The area of interest to query. It can be any of the following:

Maximum Cloud Cover

The maximum allowed threshold for cloud cover to query. Only scenes with a cloud cover less than or equal to this value (if specified) will be downloaded.

Back to top

Details

General job details

Preprocessing requirements

Before running this module, the following requirements must be met to ensure the job processes successfully and produces accurate results:

Some of the services used by this job require an account and authentication. In order to use these services, please modify, in the CATALYST Enterprise install, the file named "PGS/config/custom_settings.py"

Module details

The module performs a query to the specified service, and downloads scenes that match the query, and places them in the specified "Output Folder".

The module has the ability to use four different services to query and download data.
  • CMR: Common Metadata Repositry is NASA's spatial and temporal metadata registry that stores metadata from a variety of science disciplines and domain. CMR can be used by this module to download MODIS data. More information about CMR is available at https://earthdata.nasa.gov/eosdis/science-system-description/eosdis-components/cmr
  • Copernicus:ESA's Copernicus Open Access Hub provides free and open data access to earth observation data, and can be used by this module to download Sentinel-1 and Sentinel-2 data. More information on Copernicus is available at https://scihub.copernicus.eu/
  • Development Seed sat-api: Development's sat-api is an open-source library for querying geospatial data. They run their own instance that can be queried, and can be used by this module to download Landsat 7 and Landsat 8 data that is stored on the Amazon cloud. More information on Development Seed's sat-api is available at https://medium.com/devseed/sat-utils-cf8710e4521c
  • Planet Data API: The Planet Data API allows users to access Planet Labs' imagery archive, and can be used by this module to download RapidEye data. More information on the Planet Data API is available at https://developers.planet.com/docs/data/

Job results

On successful completion of the Download Scenes module, the "Output Folder" is populated with scenes that match the query, based on the selected query options and parameters.

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.