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	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
Null Value	Null Value	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	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
Suffix Digits	Non Negative Int	Number of digits used to represent the image file name suffix.	0
Step	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	Workdir folder path.	None

Output

Name	Type	Description
Map	Map	The map loaded by this functor.

Group

Input/Output

Notes

See also Load Categorical Map for loading maps whose cells 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 Map can load, the supported projections and datums, check the supported map formats.

It is possible to load maps from Zip archives. See this useful tip to know how to do it.

Internal Name

LoadMap