Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
load_map [2011/07/31 20:17] hermann [Optional Inputs] |
load_map [2013/07/10 16:14] admin [Optional Inputs] |
||
---|---|---|---|
Line 7: | Line 7: | ||
===== Inputs ===== | ===== Inputs ===== | ||
- | ^ Name ^ Type ^ Description ^ | + | ^ 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. | | + | | 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 ===== | ===== Optional Inputs ===== | ||
- | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ 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 | | + | | Null Value | [[Null Value Type|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 | |
- | | 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 | | + | | 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 | |
- | | 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 | | + | | 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 | |
- | | 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 | | | Workdir | [[Workdir Type|Workdir]] | Workdir folder path. | None | | ||
- | |||
===== Output ===== | ===== Output ===== | ||
- | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
- | | Map | [[Map Type|Map ]] | The map loaded by this functor. | | + | | Map | [[Map Type|Map]] | The map loaded by this functor. | |
===== Group ===== | ===== Group ===== | ||
Line 31: | Line 28: | ||
===== Notes ===== | ===== Notes ===== | ||
- | Readable formats: ers ([[ermapper_format|ERMapper raster]]) tiff/tif (GeoTiff) and asc (ArcView ASCII). | + | See also [[Load Categorical Map]] for loading maps whose cells represent categories. |
- | + | ||
- | Coordinate systems supported for translation in ERMapper format: Geodetic (WGS 84, SAD69, NAD27, Corrego Alegre) and UTM (WGS84, SAD 69, NAD27, Corrego Alegre). | + | |
- | + | ||
- | When a coordinate system is not supported, LOCAL projection and datum WGS84 are assumed. For ArcView ASCII, LOCAL projection and datum WGS84 are always assumed. | + | |
- | + | ||
- | All Geotiff coordinate systems are supported if translation is not needed. | + | |
- | + | ||
- | When GeoTiff cell dimension is not found, a 100 meter resolution is assumed. (FIXME ERMapper?) | + | |
- | + | ||
- | It is only possible to load maps represented by 8, 16 or 32 bits per cell. Other cell types are not supported. | + | |
+ | For a list of file formats that Load 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]]. | ||
===== Internal Name ===== | ===== Internal Name ===== | ||
LoadMap | LoadMap | ||
+ |