def watershed_delineation(np, dem, outlet_file=None, thresh=0, singlebasin=False,
workingdir=None, mpi_bin=None, bin_dir=None,
logfile=None, runtime_file=None, hostfile=None):
"""Watershed Delineation."""
# 1. Check directories
if not os.path.exists(dem):
TauDEM.error('DEM: %s is not existed!' % dem)
dem = os.path.abspath(dem)
if workingdir is None:
workingdir = os.path.dirname(dem)
namecfg = TauDEMFilesUtils(workingdir)
workingdir = namecfg.workspace
UtilClass.mkdir(workingdir)
# 2. Check log file
if logfile is not None and FileClass.is_file_exists(logfile):
os.remove(logfile)
# 3. Get predefined intermediate file names
filled_dem = namecfg.filldem
flow_dir = namecfg.d8flow
slope = namecfg.slp
flow_dir_dinf = namecfg.dinf
slope_dinf = namecfg.dinf_slp
dir_code_dinf = namecfg.dinf_d8dir
weight_dinf = namecfg.dinf_weight
acc = namecfg.d8acc
stream_raster = namecfg.stream_raster
default_outlet = namecfg.outlet_pre
modified_outlet = namecfg.outlet_m
stream_skeleton = namecfg.stream_pd
acc_with_weight = namecfg.d8acc_weight
stream_order = namecfg.stream_order
ch_network = namecfg.channel_net
ch_coord = namecfg.channel_coord
stream_net = namecfg.streamnet_shp
subbasin = namecfg.subbsn
dist2_stream_d8 = namecfg.dist2stream_d8
# 4. perform calculation
UtilClass.writelog(logfile, '[Output] %d..., %s' % (10, 'pitremove DEM...'), 'a')
TauDEM.pitremove(np, dem, filled_dem, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' %
(20, 'Calculating D8 and Dinf flow direction...'), 'a')
TauDEM.d8flowdir(np, filled_dem, flow_dir, slope, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
TauDEM.dinfflowdir(np, filled_dem, flow_dir_dinf, slope_dinf, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
DinfUtil.output_compressed_dinf(flow_dir_dinf, dir_code_dinf, weight_dinf)
UtilClass.writelog(logfile, '[Output] %d..., %s' % (30, 'D8 flow accumulation...'), 'a')
TauDEM.aread8(np, flow_dir, acc, None, None, False, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' %
(40, 'Generating stream raster initially...'), 'a')
min_accum, max_accum, mean_accum, std_accum = RasterUtilClass.raster_statistics(acc)
TauDEM.threshold(np, acc, stream_raster, mean_accum, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' % (50, 'Moving outlet to stream...'), 'a')
if outlet_file is None:
outlet_file = default_outlet
TauDEM.connectdown(np, flow_dir, acc, outlet_file, wtsd=None,
workingdir=workingdir, mpiexedir=mpi_bin, exedir=bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
TauDEM.moveoutletstostrm(np, flow_dir, stream_raster, outlet_file,
modified_outlet, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' %
(60, 'Generating stream skeleton...'), 'a')
TauDEM.peukerdouglas(np, filled_dem, stream_skeleton, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' %
(70, 'Flow accumulation with outlet...'), 'a')
tmp_outlet = None
if singlebasin:
tmp_outlet = modified_outlet
TauDEM.aread8(np, flow_dir, acc_with_weight, tmp_outlet, stream_skeleton, False,
workingdir, mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
if thresh <= 0: # find the optimal threshold using dropanalysis function
UtilClass.writelog(logfile, '[Output] %d..., %s' %
(75, 'Drop analysis to select optimal threshold...'), 'a')
min_accum, max_accum, mean_accum, std_accum = \
RasterUtilClass.raster_statistics(acc_with_weight)
if mean_accum - std_accum < 0:
minthresh = mean_accum
else:
minthresh = mean_accum - std_accum
maxthresh = mean_accum + std_accum
numthresh = 20
logspace = 'true'
drp_file = namecfg.drptxt
TauDEM.dropanalysis(np, filled_dem, flow_dir, acc_with_weight,
acc_with_weight, modified_outlet, minthresh, maxthresh,
numthresh, logspace, drp_file, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
if not FileClass.is_file_exists(drp_file):
raise RuntimeError('Dropanalysis failed and drp.txt was not created!')
with open(drp_file, 'r', encoding='utf-8') as drpf:
temp_contents = drpf.read()
(beg, thresh) = temp_contents.rsplit(' ', 1)
print(thresh)
UtilClass.writelog(logfile, '[Output] %d..., %s' % (80, 'Generating stream raster...'), 'a')
TauDEM.threshold(np, acc_with_weight, stream_raster, float(thresh),
workingdir, mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' % (90, 'Generating stream net...'), 'a')
TauDEM.streamnet(np, filled_dem, flow_dir, acc_with_weight, stream_raster,
modified_outlet, stream_order, ch_network,
ch_coord, stream_net, subbasin, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d..., %s' %
(95, 'Calculating distance to stream (D8)...'), 'a')
TauDEM.d8hdisttostrm(np, flow_dir, stream_raster, dist2_stream_d8, 1,
workingdir, mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %d.., %s' %
(100, 'Original subbasin delineation is finished!'), 'a')
def watershed_delineation(np,
dem,
outlet_file=None,
thresh=0,
singlebasin=False,
workingdir=None,
mpi_bin=None,
bin_dir=None,
logfile=None,
runtime_file=None,
hostfile=None):
"""Watershed Delineation."""
# 1. Check directories
if not os.path.exists(dem):
TauDEM.error('DEM: %s is not existed!' % dem)
dem = os.path.abspath(dem)
if workingdir is None:
workingdir = os.path.dirname(dem)
namecfg = TauDEMFilesUtils(workingdir)
workingdir = namecfg.workspace
UtilClass.mkdir(workingdir)
# 2. Check log file
if logfile is not None and FileClass.is_file_exists(logfile):
os.remove(logfile)
# 3. Get predefined intermediate file names
filled_dem = namecfg.filldem
flow_dir = namecfg.d8flow
slope = namecfg.slp
flow_dir_dinf = namecfg.dinf
slope_dinf = namecfg.dinf_slp
dir_code_dinf = namecfg.dinf_d8dir
weight_dinf = namecfg.dinf_weight
acc = namecfg.d8acc
stream_raster = namecfg.stream_raster
default_outlet = namecfg.outlet_pre
modified_outlet = namecfg.outlet_m
stream_skeleton = namecfg.stream_pd
acc_with_weight = namecfg.d8acc_weight
stream_order = namecfg.stream_order
ch_network = namecfg.channel_net
ch_coord = namecfg.channel_coord
stream_net = namecfg.streamnet_shp
subbasin = namecfg.subbsn
dist2_stream_d8 = namecfg.dist2stream_d8
# 4. perform calculation
UtilClass.writelog(logfile,
"[Output] %d..., %s" % (10, "pitremove DEM..."),
'a')
TauDEM.pitremove(np,
dem,
filled_dem,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile, "[Output] %d..., %s" %
(20, "Calculating D8 and Dinf flow direction..."), 'a')
TauDEM.d8flowdir(np,
filled_dem,
flow_dir,
slope,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
TauDEM.dinfflowdir(np,
filled_dem,
flow_dir_dinf,
slope_dinf,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
DinfUtil.output_compressed_dinf(flow_dir_dinf, dir_code_dinf,
weight_dinf)
UtilClass.writelog(
logfile, "[Output] %d..., %s" % (30, "D8 flow accumulation..."),
'a')
TauDEM.aread8(np,
flow_dir,
acc,
None,
None,
False,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile, "[Output] %d..., %s" %
(40, "Generating stream raster initially..."), 'a')
min_accum, max_accum, mean_accum, std_accum = RasterUtilClass.raster_statistics(
acc)
TauDEM.threshold(np,
acc,
stream_raster,
mean_accum,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile, "[Output] %d..., %s" % (50, "Moving outlet to stream..."),
'a')
if outlet_file is None:
outlet_file = default_outlet
TauDEM.connectdown(np,
flow_dir,
acc,
outlet_file,
wtsd=None,
workingdir=workingdir,
mpiexedir=mpi_bin,
exedir=bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
TauDEM.moveoutletstostrm(np,
flow_dir,
stream_raster,
outlet_file,
modified_outlet,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile,
"[Output] %d..., %s" % (60, "Generating stream skeleton..."), 'a')
TauDEM.peukerdouglas(np,
filled_dem,
stream_skeleton,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile,
"[Output] %d..., %s" % (70, "Flow accumulation with outlet..."),
'a')
tmp_outlet = None
if singlebasin:
tmp_outlet = modified_outlet
TauDEM.aread8(np,
flow_dir,
acc_with_weight,
tmp_outlet,
stream_skeleton,
False,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
if thresh <= 0: # find the optimal threshold using dropanalysis function
UtilClass.writelog(
logfile, "[Output] %d..., %s" %
(75, "Drop analysis to select optimal threshold..."), 'a')
min_accum, max_accum, mean_accum, std_accum = \
RasterUtilClass.raster_statistics(acc_with_weight)
if mean_accum - std_accum < 0:
minthresh = mean_accum
else:
minthresh = mean_accum - std_accum
maxthresh = mean_accum + std_accum
numthresh = 20
logspace = 'true'
drp_file = namecfg.drptxt
TauDEM.dropanalysis(np,
filled_dem,
flow_dir,
acc_with_weight,
acc_with_weight,
modified_outlet,
minthresh,
maxthresh,
numthresh,
logspace,
drp_file,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
if not FileClass.is_file_exists(drp_file):
raise RuntimeError(
"Dropanalysis failed and drp.txt was not created!")
drpf = open(drp_file, "r")
temp_contents = drpf.read()
(beg, thresh) = temp_contents.rsplit(' ', 1)
print(thresh)
drpf.close()
UtilClass.writelog(
logfile,
"[Output] %d..., %s" % (80, "Generating stream raster..."), 'a')
TauDEM.threshold(np,
acc_with_weight,
stream_raster,
float(thresh),
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile, "[Output] %d..., %s" % (90, "Generating stream net..."),
'a')
TauDEM.streamnet(np,
filled_dem,
flow_dir,
acc_with_weight,
stream_raster,
modified_outlet,
stream_order,
ch_network,
ch_coord,
stream_net,
subbasin,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile, "[Output] %d..., %s" %
(95, "Calculating distance to stream (D8)..."), 'a')
TauDEM.d8hdisttostrm(np,
flow_dir,
stream_raster,
dist2_stream_d8,
1,
workingdir,
mpi_bin,
bin_dir,
log_file=logfile,
runtime_file=runtime_file,
hostfile=hostfile)
UtilClass.writelog(
logfile, "[Output] %d.., %s" %
(100, "Original subbasin delineation is finished!"), 'a')
def watershed_delineation(np, dem, outlet_file=None, thresh=0, singlebasin=False,
workingdir=None, mpi_bin=None, bin_dir=None,
logfile=None, runtime_file=None, hostfile=None,
avoid_redo=False):
"""Watershed Delineation based on D8 flow direction.
Args:
np: process number for MPI
dem: DEM path
outlet_file: predefined outlet shapefile path
thresh: predefined threshold for extracting stream from accumulated flow direction
singlebasin: when set True, only extract subbasins that drains into predefined outlets
workingdir: directory that store outputs
mpi_bin: directory of MPI executable binary, e.g., mpiexec, mpirun
bin_dir: directory of TauDEM and other executable binaries
logfile: log file path
runtime_file: runtime file path
hostfile: host list file path for MPI
avoid_redo: avoid executing some functions that do not depend on input arguments
when repeatedly invoke this function
"""
# 1. Check directories
if not os.path.exists(dem):
TauDEM.error('DEM: %s is not existed!' % dem)
dem = os.path.abspath(dem)
if workingdir is None or workingdir is '':
workingdir = os.path.dirname(dem)
nc = TauDEMFilesUtils(workingdir) # predefined names
workingdir = nc.workspace
UtilClass.mkdir(workingdir)
# 2. Check log file
if logfile is not None and FileClass.is_file_exists(logfile):
os.remove(logfile)
# 3. perform calculation
# Filling DEM
if not (avoid_redo and FileClass.is_file_exists(nc.filldem)):
UtilClass.writelog(logfile, '[Output] %s' % 'remove pit...', 'a')
TauDEM.pitremove(np, dem, nc.filldem, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
# Flow direction based on D8 algorithm
if not (avoid_redo and FileClass.is_file_exists(nc.d8flow)):
UtilClass.writelog(logfile, '[Output] %s' % 'D8 flow direction...', 'a')
TauDEM.d8flowdir(np, nc.filldem, nc.d8flow, nc.slp, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
# Flow accumulation without stream skeleton as weight
if not (avoid_redo and FileClass.is_file_exists(nc.d8acc)):
UtilClass.writelog(logfile, '[Output] %s' % 'D8 flow accumulation...', 'a')
TauDEM.aread8(np, nc.d8flow, nc.d8acc, None, None, False, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
# Initial stream network using mean accumulation as threshold
UtilClass.writelog(logfile, '[Output] %s' % 'Generating stream raster initially...', 'a')
min_accum, max_accum, mean_accum, std_accum = RasterUtilClass.raster_statistics(nc.d8acc)
TauDEM.threshold(np, nc.d8acc, nc.stream_raster, mean_accum, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
# Outlets position initialization and adjustment
UtilClass.writelog(logfile, '[Output] %s' % 'Moving outlet to stream...', 'a')
if outlet_file is None: # if not given, take cell with maximum accumulation as outlet
outlet_file = nc.outlet_pre
TauDEM.connectdown(np, nc.d8flow, nc.d8acc, outlet_file, nc.outlet_m, wtsd=None,
workingdir=workingdir, mpiexedir=mpi_bin, exedir=bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
TauDEM.moveoutletstostrm(np, nc.d8flow, nc.stream_raster, outlet_file,
nc.outlet_m, workingdir=workingdir,
mpiexedir=mpi_bin, exedir=bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
# Stream skeleton by peuker-douglas algorithm
UtilClass.writelog(logfile, '[Output] %s' % 'Generating stream skeleton ...', 'a')
TauDEM.peukerdouglas(np, nc.filldem, nc.stream_pd, workingdir,
mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
# Weighted flow acculation with outlet
UtilClass.writelog(logfile, '[Output] %s' % 'Flow accumulation with outlet...', 'a')
tmp_outlet = None
if singlebasin:
tmp_outlet = nc.outlet_m
TauDEM.aread8(np, nc.d8flow, nc.d8acc_weight, tmp_outlet, nc.stream_pd, False,
workingdir, mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
# Determine threshold by input argument or dropanalysis function
if thresh <= 0: # find the optimal threshold using dropanalysis function
UtilClass.writelog(logfile, '[Output] %s' %
'Drop analysis to select optimal threshold...', 'a')
min_accum, max_accum, mean_accum, std_accum = \
RasterUtilClass.raster_statistics(nc.d8acc_weight)
if mean_accum - std_accum < 0:
minthresh = mean_accum
else:
minthresh = mean_accum - std_accum
maxthresh = mean_accum + std_accum
TauDEM.dropanalysis(np, nc.filldem, nc.d8flow, nc.d8acc_weight,
nc.d8acc_weight, nc.outlet_m, minthresh, maxthresh,
20, 'true', nc.drptxt, workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
if not FileClass.is_file_exists(nc.drptxt):
# raise RuntimeError('Dropanalysis failed and drp.txt was not created!')
UtilClass.writelog(logfile, '[Output] %s' %
'dropanalysis failed!', 'a')
thresh = 0.5 * (maxthresh - minthresh) + minthresh
else:
with open(nc.drptxt, 'r', encoding='utf-8') as drpf:
temp_contents = drpf.read()
(beg, thresh) = temp_contents.rsplit(' ', 1)
thresh = float(thresh)
UtilClass.writelog(logfile, '[Output] %s: %f' %
('Selected optimal threshold: ', thresh), 'a')
# Final stream network
UtilClass.writelog(logfile, '[Output] %s' % 'Generating stream raster...', 'a')
TauDEM.threshold(np, nc.d8acc_weight, nc.stream_raster, thresh,
workingdir, mpi_bin, bin_dir, log_file=logfile,
runtime_file=runtime_file, hostfile=hostfile)
UtilClass.writelog(logfile, '[Output] %s' % 'Generating stream net...', 'a')
TauDEM.streamnet(np, nc.filldem, nc.d8flow, nc.d8acc_weight, nc.stream_raster,
nc.outlet_m, nc.stream_order, nc.channel_net,
nc.channel_coord, nc.streamnet_shp, nc.subbsn,
workingdir, mpi_bin, bin_dir,
log_file=logfile, runtime_file=runtime_file, hostfile=hostfile)
# Serialize IDs of subbasins and the corresponding streams
UtilClass.writelog(logfile, '[Output] %s' % 'Serialize subbasin&stream IDs...', 'a')
id_map = StreamnetUtil.serialize_streamnet(nc.streamnet_shp, nc.streamnet_m)
RasterUtilClass.raster_reclassify(nc.subbsn, id_map, nc.subbsn_m, GDT_Int32)
StreamnetUtil.assign_stream_id_raster(nc.stream_raster, nc.subbsn_m, nc.stream_m)
# convert raster to shapefile (for subbasin and basin)
UtilClass.writelog(logfile, '[Output] %s' % 'Generating subbasin vector...', 'a')
VectorUtilClass.raster2shp(nc.subbsn_m, nc.subbsn_shp, 'subbasin', 'SUBBASINID')
# Finish the workflow
UtilClass.writelog(logfile, '[Output] %s' %
'Original subbasin delineation is finished!', 'a')