====== Calc Distance To Feature Map ====== 

===== Description =====

This functor calculates a map representing the frontage distance (in meters) between a cell and the closest cell representing a feature.

===== Inputs =====

^ Name  ^ Type  ^ Description  ^
| 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.  |

^ 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  |
| Cell type  | [[Cell Type Type]]  | Data cell type.  | Signed 32 Bit Integer  |
| Null Value  | [[Null Value Type]]  | Null value of the distance map.  | Default((Based on the given Cell Type input))  |
| 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  |

===== Output =====

^ Name  ^ Type  ^ Description  ^
| Distance  | [[Map Type]]  | The distance map. The distances are represented in meters. Map format has the same dimensions of the source map.  |

===== Group =====

[[Functor List#Map Algebra | Map Algebra]]

===== Notes =====

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 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 =====

CalcDistanceToFeatureMap