This tool measures the depth that each grid cell in a raster digital elevation model (DEM) lies within a sink feature (i.e. a topographic depression). A sink, or depression, is a bowl-like landscape feature, which is characterized by interior drainage and groundwater recharge. The Depth in Sink tool is implemented as a python script, which calls the Fill Depressions tool and then measures the difference between the filled DEM and the original surface model.
In addition to the names of the input DEM and the output raster, the user must specify whether the background value (i.e. the value assigned to grid cells that are not contained within sinks) should be set to the NoData value. If this is unchecked (set to 'false') then the background value will be zero.
This is an example of a Python script using this tool:
wd = pluginHost.getWorkingDirectory()
input_file = wd + "input.dep"
output_file = wd + "output.dep"
background_nodata = "true"
args = [input_file, output_file, background_nodata]
pluginHost.runPlugin("DepthInSink", args, False)
And the following is a Groovy script also using this tool:
def wd = pluginHost.getWorkingDirectory()
def inputFile = wd + "input.dep"
def outputFile = wd + "output.dep"
def background_nodata = "false"
String[] args = [inputFile, outputFile, background_nodata]
pluginHost.runPlugin("DepthInSink", args, false)