Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
calc_cost_allocation_map [2011/07/24 21:17]
hermann [Group] 		calc_cost_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 used as one of the foci points from which an accumulated cost surface is calculated. For each source feature, a region is allocated, assigning to it all cells that present the lowest costs when compared ​to all other source features.+This functor identifies a region of influence for each source feature, used as one of the foci points from which an accumulated cost surface is calculated. For each source feature, a region is allocated ​by assigning to it every cell that has a lower cost to reach that feature than any other.
  
 ===== 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 value is not defined, an error will be reported. | +| Sources  ​| [[Categorical Map Type]] ​ | Map whose non-null cells correspond to source ​features. If Sources does not define a null value, ​this functor reports ​an error. ​ | 
-| Cost     | [[Categorical ​Map Type | Categorical ​Map]] | Accumulated ​cost surface calculated from source features. |+| Costs Or Directions  ​| [[Map Type]]  ​| Map of accumulated cost per cell, or of its corresponding cost directions. ​ | 
 +| Input Represents Directions ​ | [[Boolean Value Type]]  | If true, Costs Or Directions is assumed to represent ​cost directions; otherwise, it is assumed to represent costs. A cost-direction cell can only take the eight values corresponding to the directions of a Moore neighborhood:​ None=0, NW=1, N=2, NE=3, E=4, SE=5, S=6, SW=7, and W=8.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name         ​^ Type                 ​^ Description ​                                                                          ​^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Use Lottery ​ | [[Bool Type | Bool]] | If true, Dinamica chooses randomly between two or more equal smallest values of cost. | True          ​|+| Use Lottery ​ | [[Boolean Value Type]] ​ | If true, ties for the lowest ​cost are broken randomly. This is an advanced port.  ​| No  ​|
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name      ^ Type                                        ^ Description ​                                                                                                                                                                                                       ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Allocation | [[Categorical Map Type | Categorical Map]] | Similar to a watershed, a map of cost regions ​for each source feature ​is created. Each region is identified by its source feature ​cell category. The output map has the same dimensions ​of the source feature map. |+| Allocation ​ | [[Categorical Map Type]] ​ | Map of cost regions, one per source feature ​— similar to a watershed. Each region is identified by the category of its source feature. ​Allocation ​has the same dimensions ​as Sources.  |
  
 ===== Group ===== ===== Group =====
Line 27: Line 28:
 ===== Notes ===== ===== Notes =====
  
-This calculation will report ​an error if a local minimum is found on the cost map.+This functor reports ​an error if a local minimum is found on the cost map.
  
 ===== Internal Name ===== ===== Internal Name =====