====== Load Categorical Map ====== 

===== Description =====

This functor loads a map from a file whose cell identifiers represent categories. The file name and its path must be specified. If the map found at this path does not have category identifiers, this functor will automatically determine its category identifiers.

===== Inputs =====

^ Name ^ Type ^ Description ^
| Filename  | [[Map Filename Type]]  | Name of the file that contains the map to be loaded. Dinamica automatically determines the file format from a selected file extension.  |

===== Optional Inputs =====

^ Name  ^ Type  ^ Description  ^ Default Value  ^
| Null Value  | [[Null Value Type]]  | Additional value used to represent null cells. Cells with such value are also treated as null cells. This is particularly useful for assigning a null value to image files that do not have this definition.  | None  |
| Load As Sparse  | [[Boolean Value Type]]  | If true, the map is loaded as a sparse image. Sparse images have the advantage of storing only the cells containing non-null values, but they have worse access time.  | False  |
| Suffix Digits  | [[Non Negative Integer Value Type]]  | Number of digits used to represent the image file name suffix.  | 0  |
| Step  | [[Non Negative Integer Value Type]]  | Current step or model iteration. Files with the same name and numbered suffixes will be loaded sequentially according to the model step.  | None  |
| Workdir  | [[Workdir Type]]  | Workdir folder path.  | None  |

===== Outputs =====

^ Name  ^ Type  ^ Description  ^
| Map  | [[Categorical Map Type]]  | The map loaded by the functor.  |

===== Group =====

[[Functor List#Input/Output | Input/Output]]

===== Notes ===== 

See also [[Load Map]] for loading maps whose cells do not represent categories.

If the "Null Value" parameter is specified, any cell corresponding to the original null value of the map, if provided, is converted to the new null value. This ensures that values originally represented by null value still representing null values, even if the null value definition changes. Any non-null value corresponding to the newly defined null value is also promoted to new null value.

For a list of file formats that Load Categorical Map can load, the supported [[wp>Map_projection|projections]] and [[wp>Datum_(geodesy)|datums]], check the [[supported map formats#map_formats_supported_for_reading|supported map formats]].

It is possible to load maps from [[wp>zip_(file_format)|Zip]] archives. See [[useful_tips#loading_files_from_zip_files|this useful tip]] to know how to do it.

===== Internal Name ===== 

LoadCategoricalMap