GBDX

ENVI® Calculate Cloud Mask Using Fmask

This task calculates a cloud mask for the following sensors: Landsat 4-5 TM, Landsat 7 ETM+, Landsat 8, and Sentinel-2.

GBDX Registered Name: ENVI_CalculateCloudMaskUsingFmask
Provider: Harris Geospatial Solutions

Inputs

The following table lists all ENVI_CalculateCloudMaskUsingFmask inputs.
Mandatory (optional) settings are listed as Required = True (Required = False).

Name Required Default Valid Values Description
file_types False N/A string GBDX Option. Comma seperated list of permitted file type extensions. Use this to filter input files -- Value Type: STRING[*]
input_reflectance_raster True N/A See ENVIRASTER input type Specify a raster containing the multispectral bands, calibrated to top-of-atmosphere (TOA) reflectance. -- Value Type: ENVIRASTER
input_reflectance_raster_format False N/A string Provide the format of the image, for example: landsat-8. -- Value Type: STRING
input_reflectance_raster_band_grouping False N/A string Provide the name of the band grouping to be used in the task, ie - panchromatic. -- Value Type: STRING
input_reflectance_raster_filename False N/A string Provide the explicit relative raster filename that ENVI will open. This overrides any file lookup in the task runner. -- Value Type: STRING
input_cirrus_raster False N/A See ENVIRASTER input type Specify a cirrus band raster, calibrated to top-of-atmosphere (TOA) reflectance. -- Value Type: ENVIRASTER
input_cirrus_raster_format False N/A string Provide the format of the image, for example: landsat-8. -- Value Type: STRING
input_cirrus_raster_band_grouping False N/A string Provide the name of the band grouping to be used in the task, ie - panchromatic. -- Value Type: STRING
input_cirrus_raster_filename False N/A string Provide the explicit relative raster filename that ENVI will open. This overrides any file lookup in the task runner. -- Value Type: STRING
input_brightness_temperature_raster False N/A See ENVIRASTER input type Specify a thermal band raster, calibrated to brightness temperatures. -- Value Type: ENVIRASTER
input_brightness_temperature_raster_format False N/A string Provide the format of the image, for example: landsat-8. -- Value Type: STRING
input_brightness_temperature_raster_band_grouping False N/A string Provide the name of the band grouping to be used in the task, ie - panchromatic. -- Value Type: STRING
input_brightness_temperature_raster_filename False N/A string Provide the explicit relative raster filename that ENVI will open. This overrides any file lookup in the task runner. -- Value Type: STRING
cloud_threshold False 22.5 string Specify a floating-point threshold for cloud probability over clear-land and clear-water regions. -- Value Type: DOUBLE -- Default Value: 22.5
kernel_size False 7 string Specify the number of pixels along one side of a square kernel. The default value is 7 (to create a 7 x 7 array). Cloud regions are dilated by this kernel size before output. -- Value Type: UINT -- Default Value: 7
output_raster_uri_filename False N/A string Specify a string with the fully-qualified path and filename for OUTPUT_RASTER. -- Value Type: STRING

Outputs

The following table lists all ENVI_CalculateCloudMaskUsingFmask outputs.
Mandatory (optional) settings are listed as Required = True (Required = False).

Name Required Default Valid Values Description
task_meta_data False N/A directory GBDX Option. Output location for task meta data such as execution log and output JSON
output_raster_uri True N/A directory Output for OUTPUT_RASTER. -- Value Type: ENVIURI

Output structure

The output_raster_uri file will be written to the specified S3 Customer Account Location.

Background

For additional background information on this task please refer to the Harris Geospatial ENVI documentation and
ENVI® Calculate Cloud Mask Using Fmask.

Contact

If you have any questions or issues with this task, please contact gbdx-support@digitalglobe.com.