Show/Hide Toolbars

CatchmentSIM Help

 

AddUserParameterZStats ( Name / Units / AddToTable / Numerical / ZStatsMethod / GridName / IgnoreNoData)

 

The AddUserParameterZStats command adds a new User Parameter based on zonal statistics.

 

Parameter

Description

Accepted Values / Data Type

Name

The name of the User Parameter.

String

Units

The units of the User Parameter.

String

AddToTable

Should the user parameter be added to the Subcatchment Manager form by default.

True, False

Numerical

Is this parameter only going to have numerical values.

True, False

ZStatsMethod

What method should be applied in the zonal statistics.

AVERAGE
MIN
MAX
COUNT

GridName

What is the grid name for the zonal statistics.

text representing a grid layer name

IgnoreNoData

Ignore no data (or assume no data = 0)

True, False

 

Eg., AddUserParameterZStats("IMP","%",True,True,Average,"impervious-areas.MIF_Impervious_%_Float",False)

 

AddUserParameterMacro (Name / Units / AddToTable / Numerical / MacroText)

 

The AddUserParameterMacro command adds a new User Parameter based on a macro command.

 

Parameter

Description

Accepted Values / Data Type

Name

The name of the User Parameter.

String

Units

The units of the User Parameter.

String

AddToTable

Should the user parameter be added to the Subcatchment Manager form by default.

True, False

Numerical

Is this parameter only going to have numerical values.

True, False

MacroText

The text of the macro command. The result should be assigned to &Result and the subcatchment number is available from &Sub.

String

 

Eg.,

 

AssignVariable(&UV,"AssignVariable(&Result,(%Subcatchment[&Sub].MaxEasting-%Subcatchment[&Sub].MinEasting)/1000)")
AddUserParameterMacro("Macro","%",True,True,&UV)