Add Numeric Parameter Function
- Updated2022-11-22
- 1 minute(s) read
Add Numeric Parameter Function
add_numeric_parameter adds a numeric parameter to the metadata object property parameters in the data log. These parameters document test conditions that apply to a measurement taken during the test run. If a parameter with the same name has already been added, the parameter value is replaced.
with run.Metadata() as data:
for mode in modes:
data.add_string_parameter("Mode", mode)
for voltage in Vin:
data.add_numeric_parameter("Vin", voltage, "V") # with unit
Note Specifying the unit of measure is optional when using the
add_numeric_parameter
function.
data.add_numeric_parameter("IForce", 12) # without unit | Parameter | Required? | Data Type | Description |
|---|---|---|---|
| parameter_name | Yes | String | Name of the numeric parameter to add. If parameter_name is set to an existing value, this function overwrites the existing parameter. |
| parameter_value | Yes | Float | Value of the numeric parameter to add. |
| parameter_unit | No | String | Unit of measure for the numeric parameter. |