TP TreeAge Pro中文帮助中心

Python 访问模型数据

Python 函数可以直接访问模型内部的数据。上一节提到的特殊功能/Python 教程示例模型 PythonExample – Discount.trex 通过函数参数把数据传给 Python 函数。而示例模型 Python Example – GetTreeAgeData.trex 则通过 treeage 对象,把数据直接从模型中取入 Python 函数。

注意: 如果模型对性能要求较高,请尽量高效地使用 Python 解释器。例如,调用 treeage.eval() 比向函数传递参数更慢。

通过 treeage.eval 发送的表达式可以是模型中能够计算的任何有效表达式,包括变量、追踪器、分布等。请注意,变量的计算基于调用该 Python 函数时所处的节点上下文(node context)。对于特殊的蒙特卡洛关键字(例如 _monte_pre_trial_eval),则使用根节点上下文。

treeage 对象有许多方法/函数,而本示例模型只用到下面列出的两个最常用的方法。

  • treeage.eval(”expression”) 在模型中执行该表达式,并把计算得到的值返回给 Python 函数。

  • treeage.debug(“title”, "message”) 把调试输出发送到 TreeAge Pro 计算追踪控制台(Calculation Trace Console)。

treeage.debug 函数可用于调试函数,它允许您把与代码语法和/或计算值相关的文字发送到计算追踪控制台。下面的示例展示了如何为 Python 代码添加注释,以及如何使用 eval 与 debug 语法。

注释行(以“#”开头)提供了 Python 函数内部代码的说明。此处再补充一些说明:

  • def PythonGetTreeAgeData():。这是 PythonGetTreeAgeData() 的函数声明,该函数不接收任何参数。函数使用 treeage.eval() 从模型中获取所需信息。

  • treeage.debug("PythonFunctionGetTreeAgeData", "Start function")。这会把引号内的文字发送到计算追踪控制台。分隔两个引号的逗号表示另起一行。在控制台中,您据此可以判断该函数已被调用。

  • var1 = treeage.eval("myVar1");。Python 使用此语法从 TreeAge 模型计算并取得 myVar1 的值,并把该值赋给 Python 模型内部的变量 var1。下一行做同样的事——把 myVar2 在 TreeAge Pro 中的值赋给 var2。

  • product = var1 * var2;。该表达式把内部变量 product 赋值为变量 var1 与 var2 的乘积。

  • treeage.debug("PythonGetTreeAgeData","End of function, return value " + str( product))。这会把文字发送到控制台,具体内容是 product 的值,也就是 Python 函数返回给模型的值。

  • return product;。这最后一条命令把 product 的值返回给调用该函数的表达式。

计算追踪控制台会根据上述命令显示调试输出,如下图所示。

treeage 对象还提供其他若干函数,列于下表:Python treeage 对象语法。

Treeage 对象函数 说明
treeage.eval("expression") 返回树中 expression 的值。
treeage.debug("title","msg") 向该树的跟踪控制台视图(trace console view)输出信息(前提是已开启详细调试首选项)。
treeage.loadTable("TableName", python_array) 将 Python 中数组的数据加载到 TreeAge 模型的表格中。
pt = treeage.getParallelTrials() 在 Python 中创建一个对象,用于访问并行试验(parallel trials)信息。
pt.getTrialNTracker(trial_number, "tracker_name") 获取试验编号 trial_number 对应的追踪器(tracker)tracker_name 的当前值。

pt.setTrialNTracker(trial_number, "tracker_name", value)

将试验编号 trial_number 的追踪器 tracker_name 设为 value。
treeage.getGlobalTracker("GlobalTrackerName") 获取全局追踪器 GlobalTrackerName 的当前值。
treeage.setGlobalTracker("GlobalTrackerName", value) 将全局追踪器 GlobalTrackerName 设为 value。

matrix = treeage.getGlobalMatrixN(n)

设置对某个全局矩阵的引用,之后即可访问或修改该矩阵的数据。在 Python 中,该矩阵以 Python 数组的形式表示。

参见下面几行。

matrix.getRows()

matrix.getCols()

获取矩阵当前的行数和列数。
matrix.getElement(int row, int col) 获取矩阵中第 row 行、第 col 列单元格的值。

matrix.setElement(int row, int col, double val)

将矩阵中第 row 行、第 col 列单元格的值设为 val。

matrix.incrElement(int r, int c, double val)

将矩阵中该单元格的值增加 val。

matrix.fill(double val)

matrix.fillCol(double val, int col)

matrix.fillRow(double val, int col)

matrix.fillCol(double val, int col, int rowsUpperLimit)

matrix.fillRow(double val, int row, int columnsUpperLimit)

用给定的 val 填充整个矩阵。

用给定的 val 填充第 col 列的所有单元格。

用给定的 val 填充第 row 行的所有单元格。

用给定的 val 填充第 col 列中从第 1 行到第 rowsUpperLimit 行的单元格。

用给定的 val 填充第 row 行中从第 1 列到第 colsUpperLimit 列的单元格。

matrix.getIndex() 返回该矩阵的索引。
matrix.clear() 清空矩阵中的所有数据。