Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
patcher_continuous_state [2026/07/14 19:25] chrystian Fix functor documentation. |
patcher_continuous_state [2026/08/28 03:29] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Patcher Continuous State ===== | + | ====== Patcher Continuous State ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | Generate new patches of a certain class or category. | + | This functor generates new patches of a certain class or category, allocating a continuous quantity of stock, rather than a discrete number of cells, up to a specified quota. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Continuous Landscape | [[Map Type]] | Map of stocks. Each cell represent the amount of stock stored (in units per hectare). | | + | | Continuous Landscape | [[Map Type]] | Map of stocks. Each cell represents the amount of stock stored, in units per hectare. | |
| | Probabilities | [[Map Type]] | Map of spatial probabilities. | | | Probabilities | [[Map Type]] | Map of spatial probabilities. | | ||
| - | | Quota | [[Real Value Type]] | Accumulation quota (in units). | | + | | Quota | [[Real Value Type]] | Accumulation quota, in units. | |
| - | | Mean | [[Real Value Type]] | Patch mean (in hectares). | | + | | Mean | [[Real Value Type]] | Patch mean, in hectares. | |
| - | | Variance | [[Real Value Type]] | Patch variance (in hectares). | | + | | Variance | [[Real Value Type]] | Patch variance, in hectares. | |
| - | | Isometry | [[Real Value Type]] | Patch isometry. | | + | | Isometry | [[Real Value Type]] | Patch isometry. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Neighbor Window Lines | [[Positive Integer Value Type]] | Number of lines of the neighborhood search window. | 3 | | + | | Neighbor Window Lines | [[Positive Integer Value Type]] | Number of lines of the neighborhood search window. This is an advanced port. | 3 | |
| - | | Neighbor Window Columns | [[Positive Integer Value Type]] | Number of lines of the neighborhood search window. | 3 | | + | | Neighbor Window Columns | [[Positive Integer Value Type]] | Number of columns of the neighborhood search window. This is an advanced port. | 3 | |
| - | | Prune Factor | [[Real Value Type]] | A multiple of the quantity of cells to be changed. This is used in order to specify the size of the vector where cells are ranked for subsequent draw. Prune factor multiplies the expected number of cells to be changed to set the quantity of possible cells, based on their spatial probability, that take part in the selection mechanism of new patch nuclei. Typically, increasing this value also increases the stochasticity of selection of patch pivot cells. | 10 | | + | | Prune Factor | [[Real Value Type]] | A multiple of the quantity of stock to be allocated, used to size the vector where cells are ranked for the subsequent draw. This is an advanced port. | 10 | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Modified Continuous Landscape | [[ Map Type]] | Map of remaining stocks. | | + | | Modified Continuous Landscape | [[Map Type]] | Map of remaining stocks. | |
| - | | Modified Probabilities | [[Map Type]] | Map of depleted spatial probabilities. | | + | | Modified Probabilities | [[Map Type]] | Map of depleted spatial probabilities. | |
| - | | Remaining Quota | [[Real Value Type]] | ::: | | + | | Remaining Quota | [[Real Value Type]] | Quota that could not be accumulated. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 33: | Line 33: | ||
| [[Functor List#Simulation | Simulation]] | [[Functor List#Simulation | Simulation]] | ||
| + | ===== Notes ===== | ||
| - | ===== Internal Name ===== | + | This functor works like Patcher, but accumulates a continuous quantity of stock into new patches, up to Quota, instead of transitioning a discrete number of cells. |
| - | PatcherContinuousState | + | Patch isometry is a number varying from 0 to 2. Patches assume a more isometric form as this number increases. |
| + | ===== Internal Name ===== | ||
| + | |||
| + | PatcherContinuousState | ||