Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
load_weights [2011/07/31 20:18] hermann [Optional Inputs] |
load_weights [2026/08/28 03:25] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Load Weights ====== | + | ====== Load Weights ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor loads Weights of Evidence coefficients or ranges for selected spatial variables from a file. The file name and its path must be specified. | + | Loads Weights of Evidence coefficients or ranges from a file. The file format is determined automatically from the filename's extension. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Filename | [[ Weights Filename Type|Weights Filename ]] | The name of the file that contains the Weights of Evidence coefficients or ranges. | | + | | Filename | [[Weights Filename Type]] | Name and path of the file to load. If no path is given, the file is located relative to the model script. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Suffix Digits | [[Non Negative Int Type|Non Negative Int ]] | Number of digits used to represent the file name suffix. | 0 | | + | | Suffix Digits | [[Non Negative Integer Value Type]] | Number of digits used to render Step as a filename suffix. If Step needs more digits than this, it is used unmodified. If zero, no suffix is added. This is an advanced port. | 0 | |
| - | | step | [[Non Negative Int Type|Non Negative Int ]] | Current step or model iteration. Files with the same name and numbered suffixes will be loaded sequentially according to the model step. | None | | + | | Step | [[Non Negative Integer Value Type]] | Current step or model iteration, appended to Filename as a numeric suffix; automatically bound to the innermost compatible container. This is an advanced port. | .none | |
| - | | Workdir | [[Workdir Type|Workdir]] | Workdir folder path. | None | | + | | Workdir | [[Workdir Type]] | Work directory Filename is relative to; may be a folder or a Zip archive. When not bound, the directory containing the script is used. This is an advanced port. | .none | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Weights | [[ Weights Type|Weights ]] | Weights of Evidence coefficients or ranges loaded by the functor. | | + | | Weights | [[Weights Type]] | Weights of Evidence coefficients or ranges loaded from the file. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Input/Output | Input/Output]] | + | [[Functor List#Input / Output | Input / Output]] |
| - | ===== Notes ===== | + | ===== Notes ===== |
| - | The Weights of Evidence coefficients or ranges can be edited by clicking on its editor. | + | Two file formats are supported: the legacy DCF/TXT format, and CSV. In CSV format, the coefficients or ranges are represented as a table in the format "From*:real, To*:real, Variable*:string, Range_Lower_Limit*:real, Range_Upper_Limit*:real, Weight:real" (the Range_Upper_Limit column is optional). |
| - | ===== Internal Name ===== | + | If Step is .none, the loaded filename has no numeric suffix. |
| + | |||
| + | The loaded Weights of Evidence coefficients or ranges can be edited directly by clicking on this functor's editor. | ||
| + | |||
| + | Workdir may point to a folder or to a Zip archive, allowing Weights files to be loaded directly from a Zip file. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| LoadWeights | LoadWeights | ||