The easiest way to use
MODIStsp is to use its powerful GUI (Graphical User Interface) for selection of processing options, and then run the processing.
To open the GUI, load the package and launch the MODIStsp function, with no parameters:
This opens a GUI from which processing options can be specified and eventually saved (or loaded) (Notes: 1, 2).
The GUI allows selecting all processing options required for the creation of the desired MODIS time series. The main available processing options are described in detail in the following.
Selecting Processing Parameters
MODIS Product, Platform and Layers
The top-most menus allow to specify details of the desired output time series:
“Category” and “Product”: Selects the MODIS product of interest;
MODIS platform(s): Selects if only TERRA, only AQUA or Both MODIS platforms should be considered for download and creation of the time series;
version: Selects whether processing version 5 or 6 (when available) of MODIS products has to be processed
After selecting the product and version, clicking the “Change Selection” button opens the Select Processing Layers GUI panel, from which the user must select which MODIS original layers and/or derived Quality Indexes (QI) and Spectral Indexes (SI) layers should be processed:
- The left-hand frame allows to select which original MODIS layers should be processed.
- The central frame allows to select which Quality Indicators should be extracted from the original MODIS Quality Assurance layers.
- For MODIS products containing surface reflectance data, the right-hand frame allows to select which additional Spectral Indexes should be computed. The following commonly used Spectral Indexes are available for computation by default:
You can however specify other SIs to be computed without modifying MODIStsp source code by clicking on the “Add Custom Index” button, which allow to provide info related to the new desired SI using a simple GUI interface.
Provided information (e.g., correct band-names, computable formula, etc…) is automatically checked upon clicking “Set New Index”. On success, the new index is added in the list of available ones for all products allowing its computation. Clicking “Done !” returns to the main.
NOTE All custom defined indexes can be removed by using the
Select the method to be used for download. Available choices are:
http: download through http from NASA lpdaac http archive (http://e4ftl01.cr.usgs.gov). This requires providing a user name and password, which can be obtained by registering an account at the address https://urs.earthdata.nasa.gov/profile;
offline: this option allows to process/reprocess HDF files already available on the user’s PC without downloading from NASA – useful if the user already has an archive of HDF images, or to reprocess data already downloaded via MODIStsp to create time series for an additional layer (It is fundamental that the HDFs are those directly downloaded from NASA servers ! (See here for additional details).
Checking the use_aria2c option allows to accelerate the download from NASA archives. This requires however that that the “aria2c” software is installed in your system. To download and install it, see: https://aria2.github.io/
NOTE: The best performances are usually achieved using http, though that may vary depending on network infrastructure.
Specify the starting and ending dates to be considered for the creation of the time in the series corresponding fields. Dates must be provided in the yyyy–mm–dd format (e.g., 2015-01-31)
The Period drop-down menu allows to choose between two options:
full: all available images between the starting and ending dates are downloaded and processed;
seasonal: data is downloaded only for one part of the year, but for multiple years. For example, if the starting date is 2005-03-01 and the ending is 2010-06-01, only the images of March, April and May for the years between 2005 and 2010 will be downloaded. This allows to easily process data concerning a particular season of interest.
Allows to define the area of interest for the processing. Two main options are possible:
Select MODIS Tiles: specify which MODIS tiles need to be processed either by:
- Using the “Start” and “End” horizontal and vertical sliders in the Required MODIS Tiles frame.
- pressing the “Select on Map” button. A map will open in a browser window, allowing interactive selection of the required tiles
During processing, data from the different tiles is mosaiced, and a single file covering the total area is produced for each acquisition date
Define Custom Area: specify a custom spatial extent for the desired outputs either by:
Manually inserting the coordinates of the Upper Left and Lower Right corners of the area of interest in the Bounding Box frame. Coordinates of the corners must be provided in the coordinate system of the selected output projection;
pressing the “Load Extent from a Spatial File” and selecting a raster or vector spatial file. In this case, the bounding box of the selected file is retrieved, converted in the selected output projection, and shown in the “Bounding Box” frame. Required input MODIS tiles are also automatically retrieved from the output extent, and the tiles selection sliders modified accordingly.
pressing the “Select on Map” button. A map will open in a browser window, allowing interactive selection of the spatial extent using the tools on the left.
Note: pressing the “show current extent” will open a browser window highlighting the currently selected spatial extent.
Reprojection and Resize
Specify the options to be used for reprojecting and resizing the MODIS images.
“Output Projection”: select either the Native MODIS projection (Default) or specify a user-defined one. To specify a user selected projection, select “User Defined” and then insert a valid “Proj4” string in the pop-up window. Validity of the Proj4 string is automatically checked, and error messages issued if the check fails;
“Output Resolution”, “Pixel Size” and “Reprojection Method”: specify whether output images should inherit their spatial resolution from the original MODIS files, or be resampled to a user-defined resolution. In the latter case, output spatial resolution must be specified in the measure units of the selected output projection. Resampling method can be chosen among “Nearest Neighbour” and “Mode” (Useful for down-sampling purposes). Other resampling methods (e.g., bilinear, cubic) are not currently supported since i) they cannot be used for resampling of categorical variables such as the QA and QI layers, and ii) using them on continuous variable (e.g., reflectance, VI values) without performing an a-priori data cleaning would risk to contaminate the values of high-quality observations with those of low-quality ones.
Several processing options can be set using check-boxes:
Output Files Format: Two of the most commonly formats used in remote sensing applications are available at the moment: ENVI binary and GeoTiff. If GeoTiff is selected, the type of file compression can be also specified among “None”, “PACKBITS”, “LZW” and “DEFLATE”.
Save Time Series as: Specify if virtual multitemporal files should be created. These virtual files allow access to the entire time series of images as a single file without the need of creating large multitemporal raster images. Available virtual files formats are “R” rasterStacks, ENVI meta-files and GDAL “vrt” files. In particular, “R” rasterStacks may be useful in order to easily access the preprocessed MODIS data within “R” scripts (see also http://ropensci.github.io/MODIStsp/articles/output.html).
Modify No Data: Specify if NoData values of MODIS layers should be kept at their original values, or changed to those specified within the “MODIStsp_Products_Opts” XML file. By selecting “Yes” in the “Change Original NoData values” check-box, NoData of outputs are set to the largest integer value possible for the data type of the processed layer (e.g., for 8-bit unsigned integer layers, NoData is set always to 255, for 16-bit signed integer layers to 32767, and for 16-bit unsigned integer layers to 65535). Information about the new NoData values is stored both in the output rasters, and in the XML files associated with them. NOTE: Some MODIS layers have multiple NoData (a.k.a. fill) values. if Modify No Data is set to “Yes”,
MODIStsp will convert all fill values to a common output NoData value!
Apply Scale/Offset: Specify if scale and offset values of the different MODIS layers should be applied. If selected, outputs are appropriately rescaled on the fly, and saved in the true “measure units” of the selected parameter (e.g., spectral indexes are saved as floating point values; Land Surface Temperature is saved in degrees Kelvin, etc.).
Main MODIStsp Output Folder
Select the main folder where the pre-processed time series data will be stored. All
MODIStsp outputs will be placed in specific sub-folders of this main folder (see http://ropensci.github.io/MODIStsp/articles/output.html for details on
MODIStsp naming conventions)-.
The “Reprocess Existing Data” check-box allows to decide if images already available should be reprocessed if a new run of MODIStsp is launched with the same output folder. If set to “No”, MODIStsp skips dates for which output files following the MODIStsp naming conventions are already present in the output folder. This allows to incrementally extend MODIS time series without reprocessing already available dates.
Folder for permanent storage of original MODIS HDF images
Select the folder where downloaded original MODIS HDF files downloaded from NASA servers will be stored.
The “delete original HDF files” check-box allows also to decide if the downloaded images should be deleted from the file system at the end of the processing. To avoid accidental file deletion, this is always set to “No” by default, and a warning is issued before execution whenever the selection is changed to “Yes”.
Saving and Loading Processing Options
Specified processing parameters can be saved to a JSON file for later use by clicking on the Save Options button.
Previously saved options can be restored clicking on the Load Options button and navigating to the previously saved JSON file.
(Note that at launch,
MODIStsp always reloads automatically the processing options used for its last successful run .
Starting the processing
Once you are happy with your choices, click on Start Processing.
MODIStsp will start accessing NASA servers to download and process the MODIS data corresponding to your choices.
For each date of the specified time period,
MODIStp downloads and preprocesses all hdf images required to cover the desired spatial extent. Informative messages concerning the status of the processing are provided on the console, as well as on a self-updating progress window.
The processed time series are saved in specific subfolders of the main selected output folder, as explained in detail HERE.
Note 1 PCs with a small screen can fail to visualize the whole GUI; in this case, the user can add scroll bars with
At the first execution of
MODIStsp, a Welcome screen will appear, signaling that
MODIStsp is searching for a valid GDAL installation. Press “OK” and wait for GDAL to be found. If nothing happens for a long time (e.g., several minutes),
MODIStsp (and in particular the gdalUtils package on which it relies) is not finding a valid GDAL installation in the more common locations. To solve the problem: 1. Ensure that GDAL is properly installed in your system 2. (On Windows) If it is installed, verify that GDAL is in your system PATH. and that the GDAL_DATA environment variable is correctly set (You can find simple instructions HERE) 3. If nothing works, signal it in the issues GitHub page of
MODIStsp and we’ll try to help!