Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
calc_neighborhood [2026/01/06 19:13] admin [Output] |
calc_neighborhood [2026/08/28 03:11] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 8: | Line 8: | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Source | [[Categorical Map Type]] | Feature map. Cells containing values different from the null value represent features. If the map does not define a null value, an error will be reported. | | + | | Source | [[Categorical Map Type]] | Map whose non-null cells correspond to features. If Source does not define a null value, this functor reports an error. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | None. | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| + | | Only Orthogonals Are Allowed | [[Boolean Value Type]] | If true, only cells connected orthogonally (horizontally/vertically) are considered neighbors. This is an advanced port. | No | | ||
| + | | Window Lines | [[Positive Integer Value Type]] | Number of lines of the neighbor search window. Even values are rounded up to the nearest odd number. This is an advanced port. | 3 | | ||
| + | | Window Columns | [[Positive Integer Value Type]] | Number of columns of the neighbor search window. Even values are rounded up to the nearest odd number. This is an advanced port. | 3 | | ||
| + | |||
| + | ===== Outputs ===== | ||
| - | ===== Output ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| | Neighborhood | [[Neighborhood Table Type]] | Relationship of neighboring features. | | | Neighborhood | [[Neighborhood Table Type]] | Relationship of neighboring features. | | ||
| Line 24: | Line 28: | ||
| ===== Notes ===== | ===== Notes ===== | ||
| - | Only the values present in the feature map categorization are used in calculating the neighbors. Other values are ignored. | + | Only the values present in Source's categorization are used to calculate neighbors; other values are ignored. |
| - | A reflexive relationship is always defined for all values present in the categorization with weight 0.0, ensuring that even values without neighbors are represented in the resulting table. | + | A reflexive relationship, with weight 0.0, is always defined for every value present in the categorization, so that even values without neighbors are represented in the resulting table. |
| - | Relationships between two neighbors always have weight 1.0 and are represented by two relations: the found relationship and its symmetric relationship. | + | A relationship between two neighbors always has weight 1.0, and is represented by two entries: the relationship found and its symmetric counterpart. |
| ===== Internal Name ===== | ===== Internal Name ===== | ||