DoSyntheticStreams (InitiationMethod, SAT, PointsLayer, GridLayerName, ThresholdValue, RestrictCatchments, MSCL)
The DoSyntheticStreams procedure runs CatchmentSIM's generate streams algorithm.
Parameter |
Description |
Accepted Values / Data Type |
InitiationMethod |
The initiation method for the vector stream generation. |
SAT - Use a Number of Accumulated Pixels |
SAT |
The number of pixels before a stream is initiated (SAT initiation method only). |
Integer |
PointsLayer |
The name for the points layer (POINTS initiation method only). |
String |
GridLayerName |
The name for the decimal/integer grid layer (GRID initiation method only). |
True, False |
ThresholdValue |
The minimum value in the grid before the point (pixel centroid) is considered a potential initiation point (GRID initiation method only). |
Decimal |
RestrictCatchments |
Should the vector streams be restricted to mapped catchments. |
True, False |
MSCL |
Should a Minimum Source Channel Length (MSCL) be applied. If no, then set to 0, otherwise set > 0 in metres. |
Decimal (metres) |
EXAMPLE
DoSyntheticStreams(SAT,100,"","",0,TRUE,0)
DoSyntheticStreams(POINTS,0,"PointsFile.shp","",0,TRUE,0)
DoSyntheticStreams(GRID,0,"","MyCalculatedGrid",5.4,TRUE,0)
