Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
calc_destination_map [2011/05/16 23:15] hermann created |
calc_destination_map [2026/08/28 03:09] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor calculates destination cells taking into account some measure of attraction, as depicted on an attractiveness map. Non-null value cells represent selected destination cells. | + | This functor calculates a map of destination cells by selecting suitable cells in an attractiveness map. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Attraction | [[Map Type | Map]] | Attractiveness map. Values equal to or less than zero will be ignored. | | + | | Attraction | [[Map Type]] | Map of attractiveness. Attractiveness values less than or equal to zero are ignored. | |
| - | | Horizontal Quadrants | [[Positive Int Type | Positive Int]] | Number of horizontal segments into which the attractiveness map is divided. | | + | | Horizontal Quadrants | [[Positive Integer Value Type]] | Number of horizontal quadrants into which Attraction is divided. | |
| - | | Vertical Quadrants | [[Positive Int Type | Positive Int]] | Number of vertical segments into which the attractiveness map is divided. | | + | | Vertical Quadrants | [[Positive Integer Value Type]] | Number of vertical quadrants into which Attraction is divided. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Minimum Distance Between Destinations | [[Non Negative Int Type | Non Negative Int]] | Minimum distance buffer between adjacent destinations, in meters, is used as a constraint to impede the selection of additional destinations within this buffer. | 0 | | + | | Minimum Distance Between Destinations | [[Non Negative Integer Value Type]] | Minimum distance, in meters, between adjacent destinations. | 0 | |
| - | | Maximum Attempts Per Destinations | [[Positive Int Type | Positive Int]] | Maximum number of draws realized in order to pinpoint a valid destination. | 15 | | + | | Maximum Attempts Per Destination | [[Positive Integer Value Type]] | Maximum number of draws attempted for each destination to be chosen, until one is found that does not violate the minimum-distance constraint. This is an advanced port. | 15 | |
| - | | Destinations Per Quadrant | [[Non Negative Int Type | Non Negative Int]] | Maximum number of destinations chosen in each map quadrant. | 1 | | + | | Destinations Per Quadrant | [[Non Negative Integer Value Type]] | Maximum number of destinations chosen in each quadrant. This is an advanced port. | 1 | |
| - | | Cell Type | [[Cell Type Type | Cell Type]] | Data cell type of the output map. | Unsigned 8 Bit Integer | | + | | Cell Type | [[Cell Type Type]] | Cell type of the destination map. | Unsigned 8 Bit Integer | |
| - | | Null Value | [[Int Type | Int]] | Null value of the output map. | 0 | | + | | Null Value | [[Null Value Type]] | Null value of the destination map. | .default | |
| - | | Destination Is Sparse | [[Bool Type | Bool]] | If true, map of destination is represented as a sparse image. Sparse images have the advantage of storing only the cells containing non-null values, but they have worse access time. | True | | + | | Destination Is Sparse | [[Boolean Value Type]] | If true, the destination map is stored as a sparse raster. This is an advanced port. | Yes | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Destination | [[Map Type | Map]] | Map depicting destination cells. Destination cells are depicted using their attractiveness value. Map has the same dimensions of the attractiveness map. | | + | | Destination | [[Map Type]] | Map of the cells chosen as destinations. Destination has the same dimensions as Attraction, and cells chosen as destinations carry their attractiveness value. | |
| ===== Group ===== | ===== Group ===== | ||
| - | Map Algebra | + | [[Functor List#Map Algebra | Map Algebra]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | The number of destination cells is specified by the number of destinations per quadrant but not all potential destinations may be selected because some map regions do not show attractiveness greater than zero and some potential destinations are located within the minimum distance buffer. | + | This functor is outdated; prefer [[Select Random Points]], [[Select Random Point Cluster]], [[Patcher]], or [[Expander]] instead. |
| - | An attractiveness value represents a probability of a cell to be selected based on some desired quality. | + | For each quadrant into which Attraction is divided, as many destination cells are drawn as specified by Destinations Per Quadrant. A quadrant may draw fewer than that, or none at all, when it has no valid (non-null, greater-than-zero) attractiveness cells left, or when its remaining candidate cells all lie closer than Minimum Distance Between Destinations to a destination already drawn. |
| - | The attractiveness map must have integer values. | + | Attractiveness is used as a selection probability for each cell: the higher the attractiveness, the greater the chance that the corresponding cell is selected. |
| + | |||
| + | Attraction cannot have real-numbered values. | ||
| ===== Internal Name ===== | ===== Internal Name ===== | ||