Skip to content
/ pyFmask Public

A user-friendly python CLI for Fmask 4.3 software (GERS Lab, UCONN).

License

Notifications You must be signed in to change notification settings

acoque/pyFmask

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyFmask

What is pyFmask

pyFmask is a user-friendly python CLI for Fmask 4.x software (GERS Lab, UCONN; https://github.com/GERSL/Fmask).

Fmask (Zhu et al., 2015; Qiu et al., 2017) is used for automated cloud, cloud shadow, snow, and water masking for Landsats 4-8 and Sentinel-2 images.

Requirements

You will need Python 3.8 and Fmask 4.3 to run pyFmask. You can have multiple Python versions (2.x and 3.x) installed on the same system without any problems.

Installation

pyFmask can be installed directly from GitHub:

$ python -m pip install git+https://github.com/acoque/pyFmask.git@main

Usage

You can use pyFmask through its CLI:

$ pyFmask process <image_path> [<image2_path> <image3_path>]

You can also use the two following commands for processing i) all the images located in the given directory or ii) the images listed in an input file (one path per line):

$ pyFmask process-fromdir <directory_path>
$ pyFmask process-fromfile <file_path>

About

A user-friendly python CLI for Fmask 4.3 software (GERS Lab, UCONN).

Topics

Resources

License

Stars

Watchers

Forks

Languages