Static Public Member Functions | List of all members
seims.preprocess.sd_hillslope.DelineateHillslope Class Reference

Inherits object.

Static Public Member Functions

def get_subbasin_from_hillslope_id (hillslp_id, subbsin_num)
 
def cal_hs_codes (maxid, curid)
 
def downstream_method_whitebox (stream_raster, flow_dir_raster, hillslope_out, d8alg='taudem', stream_value_method=-1)
 

Detailed Description

Delineate hillslope for each subbasin, include header, left, and right hillslope

Member Function Documentation

◆ cal_hs_codes()

def seims.preprocess.sd_hillslope.DelineateHillslope.cal_hs_codes (   maxid,
  curid 
)
static 
Set hillslope encode IDs.

◆ downstream_method_whitebox()

def seims.preprocess.sd_hillslope.DelineateHillslope.downstream_method_whitebox (   stream_raster,
  flow_dir_raster,
  hillslope_out,
  d8alg = 'taudem',
  stream_value_method = -1 
)
static 
Algorithm modified from Whitebox GAT v3.4.0.

Args:
    stream_raster: Stream cell value greater than 0 is identified by stream
                      The input stream are recommended sequenced as 1, 2, 3...
    flow_dir_raster: D8 flow direction whose value dependents on `d8alg`
    hillslope_out: With the sequenced stream IDs, the output hillslope will be numbered:
                          - Header hillslope: MaxStreamID + (current_id - 1) * 3 + 1
                          - Right hillslope: MaxStreamID + (current_id - 1) * 3 + 2
                          - Left hillslope: MaxStreamID + (current_id - 1) * 3 + 3
    d8alg: Currently, "TauDEM", "ArcGIS", and "Whitebox" are supported.
    stream_value_method:  stream value assigned method, depend on this parameter,
                      the output hillslope will be appended as follows:
       -1 - all the four files will be output.
        0 - keep stream link code, which has the default file name
        1 - Set to the value of right hillslope and head hillslope, <name>_r.tif
        2 - Set to the value of left hillslope and head hillslope, <name>_l.tif
        3 - Set stream cell to NoData, <name>_n.tif

◆ get_subbasin_from_hillslope_id()

def seims.preprocess.sd_hillslope.DelineateHillslope.get_subbasin_from_hillslope_id (   hillslp_id,
  subbsin_num 
)
static 
Get subbasin ID from the hillslope ID and the subbasin number.
The documentation for this class was generated from the following file: