Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
calc_distance_allocation_map [2011/07/24 21:19] hermann [Group] |
calc_distance_allocation_map [2026/08/28 03:09] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor identifies a region of influence for a source feature employed as one of the foci points from which distances are calculated. For each source feature, a region is allocated, assigning cells to their closest source feature. | + | This functor identifies a region of influence for each source feature, used as one of the foci points from which distances are calculated. For each source feature, a region is allocated by assigning to it every cell whose closest source feature it is. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Source | [[Categorical Map Type | Categorical Map]] | Source feature map. Non-null value cells represent features. If null cell value is not defined, an error will be reported. | | + | | Source | [[Categorical Map Type]] | Map whose non-null cells correspond to source features. If Source does not define a null value, this functor reports an error. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Use Lottery | [[Bool Type | Bool]] | If there is more than one choice to reach the shortest source feature. Dinamica chooses randomly between both equal value options. | False | | + | | Mask | [[Map Type]] | Map indicating the cells for which the distance to the closest source feature is calculated: only cells whose corresponding value in Mask is non-null have their distance calculated. | .none | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Allocation | [[Categorical Map Type | Categorical Map]] | Map of shortest distance regions for each source feature. Each region is identified by its source feature cell category. Map has the same dimensions of the source feature map. | | + | | Allocation | [[Categorical Map Type]] | Map of the closest-source-feature regions. Each region is identified by the category of its source feature. Allocation has the same dimensions as Source. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 26: | Line 26: | ||
| ===== Notes ===== | ===== Notes ===== | ||
| - | The distance calculated between each cell and the closest source feature is the [[wp>Euclidean distance]]. | + | The distance used to determine each cell's closest source feature is the Euclidean distance. |
| - | It is recommended that features be unit cells, because the 2D tree algorithm used in this operator is optimized for this situation. | + | The calculated allocation map can differ across runs using different numbers of executors, but only for cells where more than one source feature is equally close. |
| + | |||
| + | It is recommended that source features be single cells, since the 2D-tree algorithm this functor uses is optimized for that case. | ||
| ===== Internal Name ===== | ===== Internal Name ===== | ||