<< Managing CLaRiNet data structures: "FloatRaster", "FlowDirGrid" and "CellTree" structures Managing CLaRiNet data structures: "FloatRaster", "FlowDirGrid" and "CellTree" structures CreateConstantRaster >>

CLaRiNet 0.1 beta >> Managing CLaRiNet data structures: "FloatRaster", "FlowDirGrid" and "CellTree" structures > CreateCellTree

CreateCellTree

Builds a structure of type "CellTree" (linked list of pixels).

Calling Sequence

handle_tree = CreateCellTree ( handle_fdr , outlet [, handle_weight] )

Arguments

handle_fdr

integer: handle on the flow direction grid to be used for constructing the topology

outlet

integer: ID of the outlet pixel (root of the tree), as returned by XY2rec

handle_weight

(optional) integer: raster containing the weight to use for each pixel in the tree. If no raster is specified, all pixels will have a unit weight.

handle_tree

output, integer: handle on the newly created tree structure

Description

Builds a structure of type "CellTree" (linked list of pixels) having its root at an outlet cell. This structure makes it easier to search and sample among the pixels of the catchment.

Returns a handle on the object created.

Examples

References

See Also

Authors

<< Managing CLaRiNet data structures: "FloatRaster", "FlowDirGrid" and "CellTree" structures Managing CLaRiNet data structures: "FloatRaster", "FlowDirGrid" and "CellTree" structures CreateConstantRaster >>