This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong. ====== Load Map ====== ===== Description ===== This functor loads a map from a file. The filename and its path must be specified. ===== Inputs ===== ^ Name ^ Type ^ Description ^ | Filename | [[Map Filename Type|Map Filename ]] | Name and path of input map file. File format is automatically selected based on the filename extension. If path is not specified, file location is the same of model script. | ===== Optional Inputs ===== ^ Name ^ Type ^ Description ^ Default Value ^ | Load As Sparse | [[Bool Type|Bool]] | 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 | | Define Null Value | [[Bool Type|Bool]] | This flag forces the cells with the same value of the "Null Value" parameter to be treated as a null cells. This is particularly useful for assigning a missing null value to a GeoTiff data. | False | | Null Value | [[Int Type|Int]] | Value used to represent null cell. The "Define Null Value" flag must be set in order to define a null value. This is particularly useful for assigning a missing null value to a GeoTiff data. | 0 | | Suffix Digits | [[Non Negative Int Type|Non Negative Int]] | Number of digits used to represent the image file name suffix. If the "step" input is unbound, this options is ignored. | 0 | | Step | [[Non Negative Int Type|Non Negative Int]] | 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]] | Workdir folder path. | None | ===== Output ===== ^ Name ^ Type ^ Description ^ | Map | [[Map Type|Map]] | The map loaded by this functor. | ===== Group ===== [[Functor List#Input/Output | Input/Output]] ===== Notes ===== See also [[Load Categorical Map]] for loading maps whose cells represent categories. For a list of file formats that Load Map can load, the supported [[wp>Map_projection|projections]] and [[wpDatum_(geodesy)|datums]], check the [[supported map formats]]. ===== Internal Name ===== LoadMap