<< FlagCatchmentCells Catchment identification and extraction Ordering streams and traversing networks >>

CLaRiNet 0.1 beta >> Catchment identification and extraction > GetCatchmentCells

GetCatchmentCells

Identifies all cells belonging to a (sub)catchment and returns them in a vector

Calling Sequence

[C, BoundingBox [, INLETS] ] = GetCatchmentCells ( handle_fdr , outlet [, POT_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

POT_INLETS

(optional) vector of potential inlet IDs. By default, the function returns 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.

C

output: vector of (sub)catchement cells.

bb

output, matrix [4 x 1]: bounding box of the (sub)catchment in the form [colmin,colmax,rowmin,rowmax]

INLETS

output: vector of IDs of the inlet sites which have actually been encountered in the extraction

Description

Identifies all cells belonging to a (sub)catchment and return them in a vector

Examples

References

See Also

Authors

<< FlagCatchmentCells Catchment identification and extraction Ordering streams and traversing networks >>