*Parameter() - plot macro

Specifies the label and variable type for a plot macro parameter.

Syntax

*Parameter (var_name, label, SCALAR|CURVE)

Application

HyperGraph

Inputs

var_name: The variable name of the plot macro parameter.
label: The descriptive label of the parameter.
SCALAR|CURVE: A scalar or curve data type.

Context

*BeginPlotMacros()

*DefinePlotMacro()

Example

*BeginPlotMacros()
   *DefinePlotMacro(macro_batch, curve, low, high, times )
      *Label( "batch general")
      *Parameter(curve, "Curve (time = sec)", CURVE)
      *Parameter(low, "Low cutoff", SCALAR)
      *Parameter(high, "High cutoff", SCALAR)
      *Parameter(times, "Time conv.", SCALAR, 1.0)
      *Set(X, "curve.x")
      *Set(Y, "batch(times*curve.x,curve.y,low,high)")
      *Set(LABEL, curve.label + "_" + low + "_" + high)
   *EndDefine()
*EndPlotMacros()

Comments

*Parameter() can also be used in a *DefineReport() block.

Parameters are variables inside the plot macro definition which can hold scalar or curve data.

The parameters in a plot macro are entered in the Plot Macros panel in the interface.