Here's the updated documentation for Load Map with the missing ports added based on the Portuguese source:
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 | 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 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 |
| Storage Mode | Enum Type | Flag suggesting how the map should be loaded. It is possible that the value defined by this flag may be ignored and have no effect. This is an advanced port. | Default |
| 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 in the suffix that will be used to represent the step to which the file corresponds. If a greater number of digits is needed than this value, the step itself is used without modifications. If the number of digits is zero, no suffix is added to the file name. This is an advanced port. | 0 |
| First Window Coordinate X | Real Value Type | X coordinate of the upper-left corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping is applied to all layers of the map. | None |
| First Window Coordinate Y | Real Value Type | Y coordinate of the upper-left corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping is applied to all layers of the map. | None |
| Second Window Coordinate X | Real Value Type | X coordinate of the lower-right corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping is applied to all layers of the map. | None |
| Second Window Coordinate Y | Real Value Type | Y coordinate of the lower-right corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping is applied to all layers of the map. | None |
| 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. This port automatically associates with the innermost compatible container. This is an advanced port. | None |
| Workdir | Workdir Type | Workdir folder path. Can be a folder or Zip file. If not associated, the working directory is considered to be the location where the script is saved. This is an advanced port. | None |
Output
| Name | Type | Description |
|---|---|---|
| Map | Map Type | The map loaded by this functor, or if defined, only the window specified by the clipping window parameters. |
Group
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.
The clipping window parameters allow loading only a specific rectangular region of the map instead of the entire map. When all four window coordinate parameters are null (default), the entire map is loaded. To use the clipping window feature, all four coordinates (First Window Coordinate X, First Window Coordinate Y, Second Window Coordinate X, and Second Window Coordinate Y) must be defined together. If the clipping window parameters are provided, only the area corresponding to the clipping window is loaded.
If the value of “Step” is null, the file read will not have a suffix.
Internal Name
LoadMap