<< CreateAccumulationMap | Catchment identification and extraction | GetCatchmentCells >>

CLaRiNet 0.1 beta >> Catchment identification and extraction > FlagCatchmentCells

# FlagCatchmentCells

Identifies all cells belonging to a (sub)catchment and flags them in an existing raster

### Calling Sequence

    FlagCatchmentCells ( handle_fdr , outlet , handle_ras , flag [, INLETS] )

### Arguments

handle_fdr

  integer: handle on the flow direction grid defining the stream network

outlet

  integer: ID of the outlet pixel, as returned by `XY2rec`

handle_ras

  integer: handle on an existing raster in which catchment cells will be flagged. This raster is not created by the function, it must exist before and can be created with functions such as `CreateFloatRaster` or `CreateConstantRaster`

flag

  double: value to be used for flagging catchment cells in the raster

INLETS

  (optional) vector of inlet IDs. By default, the function flags all cells upstream the outlet pixel. If you want to exclude some subcatchments then provide a vector of inlet IDs defining those subcatchments. The recursive accumulation will not go further upstream whenever one of these inlets is met.

### Description

Identifies all cells belonging to a (sub)catchment and flags them in an existing raster

### Examples

### References

### See Also

- XY2rec, CreateFloatRaster, CreateConstantRaster

### Authors

- Nicolas LE MOINE

<< CreateAccumulationMap | Catchment identification and extraction | GetCatchmentCells >>