easy_vic_build.tools.hydroanalysis_func.hydroanalysis_wbw.flow_accumulation

Flow-accumulation utilities for D8 flow-direction rasters.

Functions

d8_flowaccumulation(wbe, flow_direction[, ...])

Calculate D8 flow accumulation from a flow-direction raster.

easy_vic_build.tools.hydroanalysis_func.hydroanalysis_wbw.flow_accumulation.d8_flowaccumulation(wbe, flow_direction, output_file='flow_acc.tif', **kwargs)

Calculate D8 flow accumulation from a flow-direction raster.

Computes the number of upstream cells that drain into each cell, representing contributing area or flow accumulation.

Parameters:

• wbe (WbEnvironment) – WhiteboxTools workflow environment instance

• flow_direction (WbRaster) – D8 flow-direction raster path or WbRaster object.

• output_file (str, optional) – Output file path for flow accumulation raster (default=”flow_acc.tif”)

• **kwargs (dict, optional) –

  Additional parameters for d8_flow_accum:

  • out_type{‘cells’, ‘sca’, ‘specific’}, optional

    Output type (default=’cells’): - ‘cells’: Number of contributing cells - ‘sca’: Specific catchment area (cells * cell area) - ‘specific’: Same as ‘sca’

  • log_transformbool, optional

    Whether to apply logarithmic transform to output (default=False)

  • input_is_pointerbool, optional

    Whether input is pointer-type (default=True)

  • esri_pntrbool, optional

    Whether input uses ESRI pointer encoding (default=True)

  • num_procsint, optional

    Number of processors to use for calculation

Returns:

Flow-accumulation raster written to output_file and returned.

Return type:

WbRaster