Differences

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

Link to this comparison view

Next revision
Previous revision
calc_distance_to_feature_map [2011/07/25 15:04]
hermann created
calc_distance_to_feature_map [2020/02/13 15:25] (current)
danilo
Line 7: Line 7:
 ===== Inputs ===== ===== Inputs =====
  
-^ Name   ​^ Type                                       ​^ Description ​                                                                                                                                                                                                                                                                   +^ Name  ^ Type  ^ Description ​ 
-| Source | [[Categorical Map Type|Categorical Map  ​]] | Map containing the features to which distances will be calculated. A feature is represented by a non-null value. Data cell type of this map must be "​Signed 32 Bit Integer"​ or an error will be reported. |+| Source ​ | [[Categorical Map Type]] ​ | Map containing the features to which distances will be calculated. A feature is represented by a non-null value. Data cell type of this map must be compatible with "​Signed 32 Bit Integer"​ or an error will be reported. ​ |
  
-===== Optionsl Inputs ===== +^ Name  ^ Type  ^ Description ​ ^ Default Value  
- +| Mask  | [[Categorical Map Type]] ​ | A map used to mask the distance calculation on its null cell areas. Data cell type of this map must be compatible with "​Signed 32 Bit Integer"​ or an error will be reported. ​ | None  
-^ Name                        ^ Type                                       ​^ Description ​                                                                                                                                                                    ​^ Default Value         ^                                                                                                                                                                                                                                                                  ​+| Cell type  | [[Cell Type Type]] ​ | Data cell type.  | Signed 32 Bit Integer ​ 
-| Mask                        | [[Categorical Map Type|Categorical Map ]] | A map used to mask the distance calculation on its null cell areas. Data cell type of this map must be compatible with "​Signed 32 Bit Integer"​ or an error will be reported. ​    ​| None                  +| Null Value  | [[Null Value Type]] ​ | Null value of the distance map.  Default((Based on the given Cell Type input))  ​
-| Cell type                   ​| [[Cell Type Type|Cell ​Type ]]             ​| Data cell type.                                                                                                                                                                  | Signed 32 Bit Integer |             +| Truncate Distance ​ | [[Boolean Value Type]] ​ | If true, distance values that exceed the greatest value of the output map will be truncated, instead of reporting an error. ​ | False  |
-| Null Value                  | [[Int Type|Int ]]                         ​| Null value of the distance map.                                                                                                                                                  -2147483648 ​          +
-| Truncate Distance ​          ​| [[Bool Type|Bool ]]                       ​| If true, distance values that exceed the greatest value of the output map will be truncated, instead of reporting an error. ​                                                     | False                 | +
-| Ignore Unreachable Sources ​ | [[Bool Type|Bool ]]                       | If true, feature cells completely surrounded by other feature cells are ignored. ​                                                                                                | True                  | +
-| Ignore Cross Inside Sources | [[Bool Type|Bool ]]                       | If true, feature cells surrounded by other feature cells on the horizontal and vertical axis will be ignored. To have an effect, "​Ignore Unreachable Sources"​ must also be true. | True                  ​|+
  
 ===== Output ===== ===== Output =====
  
-^ Name     ​^ Type              ^ Description ​                                                                                                     +^ Name  ^ Type  ^ Description ​ 
-| Distance | [[Map Type|Map ]] | The distance map. The distances are represented in meters. Map format has the same dimensions of the source map. |+| Distance ​ | [[Map Type]] ​ | The distance map. The distances are represented in meters. Map format has the same dimensions of the source map.  |
  
 ===== Group ===== ===== Group =====
Line 31: Line 27:
 ===== Notes ===== ===== Notes =====
  
-The calculated distance is the Euclidean distance and the unit used is the meter.+The calculated distance is the [[wp>​Euclidean_distance|Euclidean distance]] and the unit used is the meter.
  
 The mask does not interfere with distance calculations to cells located beyond null cells. The mask does not interfere with distance calculations to cells located beyond null cells.
 +
 +The resulting output map has one layer named "​layer_0"​. This is the default name for layers of a map when an explicit name is not specified.
  
 ===== Internal Name ===== ===== Internal Name =====
  
 CalcDistanceToFeatureMap CalcDistanceToFeatureMap
-