Scripting Language Reference
Contents
General Overview
Global Mapper script files allow the user to create custom batch
processes that make use of the functionality built in to Global Mapper.
From a script, one can import data in any of the numerous formats supported by
the software, reproject that data if desired, and export it to a new file.
Global Mapper script files consist of a series of command lines. Each
command line begins with a command. A series of parameter/value pairs should
follow the command. These pairs should be written as parameter=value. No spaces
should exist before or after the equal sign. Individual parameter/value pairs
should be separated by spaces. If a pair requires spaces internal to the value,
quotes may be used around the entire value. For example, for a filename with
spaces, the pair could look like FILENAME="c:\\my documents\\test.tif".
Command lines typically consist of one line each. To extend a command to
another line, use the backslash character (\) at the end of the line. There are a few
exceptions to this, including the DEFINE_PROJ and
DEFINE_SHAPE commands and
the looping functionality provided by the DIR_LOOP_START
and DIR_LOOP_END commands.
Batch Mode Operation
You can run a Global Mapper script file automatically be passing it on the
command line to the Global Mapper .exe file. The script file will be run with no
user interface displayed and Global Mapper will immediately exit when the script
file completes processing. This allows you to easily run Global Mapper scripts
from another application or from a DOS batch file. Note that your script files
need to have an extension of .gms for this to work.
Comments
Any lines that begin with the forward slash character (/) are considered
comments and are ignored by the script processing engine. This means that you
can use C or C++ style comments like // or /* at the start of your line.
ADD_MEASURE_ATTRS
The ADD_MEASURE_ATTRS command allows you to add/update feature measure attributes
to all of the line and area features in a loaded vector layer.
The following parameters are supported by the command:
- FILENAME - filename of the layer to update.
If an empty value is passed in, all layers that were created by the script,
such as those from a GENERATE_CONTOURS command, will be updated. You can also
pass in the value 'USER CREATED FEATURES' when running a script in the context
of the main map view or loading a workspace to have the 'User Created Features' layer
updated.
COMBINE_LINES
The COMBINE_LINES command allows you to combine connected lines features based on
one or more attribute or label values. You can choose to combines in just a single
loaded layer or in all loaded vector laeyrs. The newly created lines will be placed
in a new layer and have the current projection. Any lines that are connected to
another line will be marked as deleted. You can also supply multiple COMPARE_STR
parameters to apply multiple criteria, all of which must be true, in order for the lines
to be considering for combining.
The following parameters are supported by the command:
- FILENAME - filename of the layer to assign types to.
If an empty value is passed in, all loaded vector layers will be updated. You can also
pass in the value 'USER CREATED FEATURES' when running a script in the context
of the main map view or loading a workspace to have the 'User Created Features' layer
updated.
- COMPARE_STR - specifies a comparison operation to
perform to see if a line feature is one that needs to be considered. The format is
attr_name=attr_value. For example if you have an attribute named CFCC and you want to
match when the value of that attribute starts with an 'A', you can use
COMPARE_STR="CFCC=A*" as your parameter. You can add multiple COMPARE_STR parameters
to a single command to combine multiple criteria for your search. If you would like
to compare against a feature label rather than an attribute, use <Feature Name>
for your attribute name. To compare against a feature type name rather than an
attribute, use <Feature Type> for your attribute name. To compare against the
feature description, use <Feature Desc> for your attribute name.
- CASE_SENSITIVE - specifies whether or not text
comparisons are case sensitive or not. Use CASE_SENSITIVE=YES to enable, by default
comparisons are not case sensitive.
- LAYER_DESC - specifies the name to assign to the
newly generated layer containing the connected line features. If no layer description is provided, the default
name of "Combined Lines" will be used.
- COMPATIBLE_ONLY - specifies whether or not any connecting
lines should be combined (the default) or just those which have compatible types and attributes. Use
COMPATIBLE_ONLY=YES to enable combining only compatible lines.
COMBINE_TERRAIN
The COMBINE_TERRAIN command generates a new terrain (gridded elevation) layer
by combining two loaded terrain layers through some operation, like addition,
subtraction (difference), average, min/max, etc. The new terrain layer can then
be operated on just like any other terrain layer.
The following parameters are used by the COMBINE_TERRAIN command:
- LAYER1_FILENAME - full path and filename of the
first loaded terrain layer to use. You can also pass in the full description of
the loaded layer to use in case you want to use a layer not loaded from a file.
- LAYER2_FILENAME - full path and filename of the
second loaded terrain layer to use. You can also pass in the full description of
the loaded layer to use in case you want to use a layer not loaded from a file.
- COMBINE_OP - defines the operation to perform
when combining the layers. The following operations are supported:
- ADD - adds the values from the first layer to the second
- SUBTRACT_SIGNED - subtracts the values of the second layer from
the first and saves the signed result.
- SUBTRACT_UNSIGNED - subtracts the values of the second layer from
the first and saves the magnitude of the result.
- AVERAGE - saves the average of the values from the first and second layers.
- MINIMUM - saves the smaller of the values from the first and second layers.
- MAXIMUM - saves the larger of the values from the first and second layers.
- MULTIPLY - multiplies the values from the first and second layers. If one or both of the
values is missing, the sample is marked as invalid.
- DIVIDE - divides the value from the first layer by the value in the second layer. If one or both of the
values is missing or if the second value is 0, the sample is marked as invalid.
- FILTER_KEEP_FIRST - saves the first layer value if the second layer value is valid.
- FILTER_KEEP_FIRST_IF_GT_SECOND - saves the first layer value if the second layer value
is valid and the first layer value is greater than the second layer value.
- FILTER_KEEP_FIRST_IF_LT_SECOND - saves the first layer value if the second layer value
is valid and the first layer value is less than the second layer value.
- FILTER_KEEP_FIRST_IF_SECOND_GT_VAL - saves the first layer value if the second layer value
is valid and the second layer value is greater than the value provided with the COMPARE_VAL parameter
- FILTER_KEEP_FIRST_IF_SECOND_LT_VAL - saves the first layer value if the second layer value
is valid and the second layer value is less than the value provided with the COMPARE_VAL parameter
- COMPARE_VAL - provides a numeric vlaue to compare against for
some of the combine operations above.
- LAYER_DESC - specifies the name to assign to the
newly generated terrain layer. If no layer description is provided, the default
name of "Combined Elevation Grid" will be used.
- ELEV_UNITS - specify elevation units to use in new terrain layer
- FEET - export in US feet
- DECIFEET - export in 10ths of US feet
- METERS - export in meters
- DECIMETERS - export in 10ths of meters
- CENTIMETERS - export in centimeters
- SPATIAL_RES - specifies spatial resolution. Defaults to the minimum
spatial resolution of the two layers if not specified. Should be formatted as
x_resolution,y_resolution. The units are the units of the current global
projection. For example, if UTM was the current global projection and you
wanted to export at 30 meter spacing, the parameter/value pair would look like
SPATIAL_RES=30.0,30.0.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- GLOBAL_BOUNDS - specifies the combine bounds in units of the current
global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the combine bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the combine bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the operation should use the bounds of
the loaded layer(s) with the given filename. For example, to export to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- FILL_GAPS - specifies that small gaps in between and within the
data sets being combined will be filled in by interpolating the surrounding
data to come up with an elevation for the point in question. This option is off
by default, specify FILL_GAPS=NO to turn off.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the operation should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be combined will be used
as the crop polygon (see POLYGON_CROP_USE_ALL or POLYGON_CROP_USE_EACH for exceptions).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the new terrain layer will be in (i.e. the current projection).
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_USE_EACH - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
generate a separate export for each polygons in that file rather than just the best-fit polygon.
See the POLYGON_CROP_BBOX_ONLY and POLYGON_CROP_NAME_ATTR options for naming and other
options when using this parameter. Use POLYGON_CROP_USE_EACH=YES to enable.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
- POLYGON_CROP_NAME_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use for
naming, or the special values <Area Display Label> or <Area Source Filename>.
If no value is provided, the exported files will be sequentially numbered.
- POLYGON_CROP_FOLDER_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use as a
folder name before the actual filename or the special values <Area Display Label>.
DEFINE_PROJ
The DEFINE_PROJ command allows a projection (including datum) to be
associated with a name. The projection name can then be used in later IMPORT,
IMPORT_ARCHIVE, IMPORT_ASCII, and LOAD_PROJECTION commands to specify a
projection as needed.
The DEFINE_PROJ command consists of a single command line followed by a
series of lines describing the projection in the format of an ESRI PRJ file. The
easiest way to determine the text for a projection is to setup a projection on
the Projection tab of the Tools->Configuration and then use the Save to
File button to create a new .prj file. Then just open the .prj file up in
Notepad and copy the contents to the lines following the DEFINE_PROJ command
line.
The DEFINE_PROJ command is terminated with a single line containing only the
text END_DEFINE_PROJ.
For a sample of the DEFINE_PROJ command in use, load some data and then save
a Global Mapper workspace file from the File->Save Workspace menu command.
Open the resulting .gmw file in an editor and you can see how the DEFINE_PROJ
command is used to define a view projection and the set it.
The following parameters are required by the DEFINE_PROJ command.
- PROJ_NAME - specifies the name to associate with the projection
DEFINE_SHAPE
The DEFINE_SHAPE command allows a multi-point shape (like a polygon) to be
associated with a name. The projection name can then be used in later commands
for things like cropping and feathering to polygonal boundaries.
The DEFINE_SHAPE command consists of a single command line followed by a
series of lines describing the series of XY coordinate pairs that define the
shape. Each line should have a single coordinate value with the X and Y coordinates
separated by a comma.
The DEFINE_SHAPE command is terminated with a single line containing only the
text END_DEFINE_SHAPE.
The following parameters are required by the DEFINE_SHAPE command.
- SHAPE_NAME - specifies the name to associate with the shape
Here is an example of a DEFINE_SHAPE command used to define a feather polygon
with a name of 'FEATHER_POLY'
DEFINE_SHAPE SHAPE_NAME="FEATHER_POLY"
377493.234,4323974.016
375343.359,4318676.109
381101.953,4314414.750
387014.109,4317178.875
386975.719,4322400.000
381869.766,4324588.266
377493.234,4323974.016
END_DEFINE_SHAPE
DEFINE_VAR
The DEFINE_VAR command allows you to define a variable and an associated value. You can then
use the defined variable name later wrapped in percent signs to have the defined value replaced
in the script. This is useful for things like defining a path or something at the top of a
script that you can easily change in just one place later.
The following parameters are required by the DEFINE_VAR command.
- NAME - specifies the variable name
- VALUE - specifies the variable value
Here is an example of a DEFINE_VAR command used to define a directory path for later use and then
its subsequent use:
DEFINE_VAR NAME="DATA_DIR" VALUE="c:\temp\export test"
IMPORT FILENAME="%DATA_DIR%\blue_springs.opt"
DIR_LOOP_END
The DIR_LOOP_END command ends a loop of commands over all of the folders within
a directory. See the DIR_LOOP_START command
for details.
DIR_LOOP_START
The DIR_LOOP_START command begins a loop of commands over all of the folders within
a directory (and optionally its subdirectories) that match one or more filename
masks. This is a powerful feature allowing you to do things like easily batch convert
a collection of files or perform any other supported operation over a collection of files.
You end a loop over the files in a folder using the DIR_LOOP_END command. Note that it
is also possible to nest loops.
For any commands found within a DIR_LOOP_START...DIR_LOOP end pair defining a loop, the
following special character sequences can be used anywhere (examples of what the values
will be based on a current filename of 'C:\data\my_file.dem' are listed):
- %DIR% - full path to current file (value is 'C:\data\')
- %FNAME_W_DIR% - full path and filename of current file (value is 'C:\data\my_file.dem')
- %FNAME% - filename of current file (value is 'my_file.dem')
- %FNAME_WO_EXT% - filename of current file without extension (value is 'my_file')
- %PARENT_DIR% - name of parent directory of file (value is 'data')
For a sample of the DIR_LOOP_START command in use, see the
example at the bottom of this reference.
The following parameters are used by the DIR_LOOP_START command.
- DIRECTORY - specifies the directory to search for files in. If
you leave this blank, the operation will be based in the current folder.
- FILENAME_MASKS - space-separated list of filename masks to import.
If no value is provided then all files will be used.
- RECURSE_DIR - specifies whether the loop operation will search
subdirectories of the specified directory as well as the current one. Use RECURSE_DIR=YES to
enable. The default value is to NOT search subdirectories.
EDIT_VECTOR
The EDIT_VECTOR command allows you to assign feature types (classifications), add/update
attributes and display labels, or delete features based on
one or more attribute or label values. You can choose to update area, line, and/
or point features with a single operation. You can also supply multiple COMPARE_STR
parameters to apply multiple criteria, all of which must be true, in order to
edit a feature.
The following parameters are supported by the command:
- FILENAME - filename of the layer to update.
If an empty value is passed in, all loaded vector layers will be updated. You can also
pass in the value 'USER CREATED FEATURES' when running a script in the context
of the main map view or loading a workspace to have the 'User Created Features' layer
updated.
- AREA_TYPE - specifies the name of the Global Mapper
area type to assign to matching area features.
- LINE_TYPE - specifies the name of the Global Mapper
line type to assign to matching line features.
- POINT_TYPE - specifies the name of the Global Mapper
point type to assign to matching point features.
- ATTR_VAL - specifies the attribute value to update
and what value to assign to it. The format is attr_name=attr_value. For example if you
want to set the value of an attribute named CFCC to A34, use ATTR_VAL="CFCC=A34". You
can add multiple ATTR_VAL parameters to a single command to provide multiple attribute/value
pairs (or labels) to add/update. If you would like to update the feature label rather than
an attribute, use <Feature Name> for your attribute name.
- COMPARE_STR - specifies a comparison operation to
perform to see if a feature is one that needs to be updated. The format is
attr_name=attr_value. For example if you have an attribute named CFCC and you want to
match when the value of that attribute starts with an 'A', you can use
COMPARE_STR="CFCC=A*" as your parameter. You can add multiple COMPARE_STR parameters
to a single command to combine multiple criteria for your search. If you would like
to compare against a feature label rather than an attribute, use <Feature Name>
for your attribute name. To compare against a feature type name rather than an
attribute, use <Feature Type> for your attribute name. To compare against the
feature description, use <Feature Desc> for your attribute name. To compare against
the 0-based index of a feature in a layer, use <Index in Layer> for your attribute name.
- ATTR_TO_DELETE - specifies the name of an attribute
to delete from matching features. You can include multiple instances of this
attribute to delete multiple values. To remove the feature label rather than an
attribute, use <Feature Name> for the attribute name.
- ATTR_TO_RENAME - specifies the name of an attribute
to rename from matching features and what to rename it to. You can include multiple instances of this
attribute to rename multiple attributes. For example, to rename the attribute, CTY to be COUNTY, add
the parameter ATTR_TO_RENAME="CTY=COUNTY" to your command.
- ATTR_TO_COPY - specifies the name of an attribute
to copy the value of an existing attribute or label to. You can include multiple instances of this
parameter to copy multiple attributes. For example, to create a new attribute named DISP_LABEL from the
feature label, use ATTR_TO_COPY="DISP_LABEL=<Feature Name>" or to create a new attribute named
DEPTH from the value of an attribute named Z, use ATTR_TO_COPY="DEPTH=Z".
- CASE_SENSITIVE - specifies whether or not text
comparisons are case sensitive or not. Use CASE_SENSITIVE=YES to enable, by default
comparisons are not case sensitive.
- DELETE_FEATURES - specifies whether or not to mark
all matching features as deleted. Use DELETE_FEATURES=YES to enable.
- DELETE_DUPLICATES - specifies whether or not to mark
matching features that are duplicates (i.e. same coordinates, label, attributes, type, and style) as deleted.
Use DELETE_DUPLICATES=YES to enable. Note that this only removes duplicate features that
are within the same layer. Duplicates in different layers will not be deleted.
- COORD_OFFSET - specifies the offset to
apply to any coordinates for the features that match the specified criteria. The offset should
be in the units of the layer the features are being matched from. The offset should be specified as a
comma-delimited list of the X and Y offsets, such as COORD_OFFSET="100000.0,200000.0".
- COORD_SCALE - specifies the scale
factors to apply to any coordinates for the features that match the specified criteria. Each coordinate will
be multiplied by these scale factor. The scale factors should be specified either as a single value (the
most common scenario) or as separate scale factors for the X and Y values, like COORD_SCALE=1.00005 for a
single value, or COORD_SCALE=1.0045,1.0052 for separate X and Y coordinate scales.
- ROTATE_ANGLE - specifies the angle in degrees by which to rotate matching
features by clockwise around some point. The ROTATE_ABOUT parameter specifies what point the feature coordinates
are rotated about.
- ROTATE_ABOUT - if a non-zero ROTATE_ANGLE value is specified, specifies the point
that the features should be rotated about, with the default being about the center of all matching features. The
following values are supported:
- COMBINED_CENTER - rotates about the combined center of all matching features. This is the default value.
- INDIVIDUAL_CENTER - rotates each feature about the center of the feature independently.
- Manually specified location - you can manually specify the X and Y coordinates to rotate about (in the projection
of the layer being rotated), like ROTATE_ABOUT="45000.0,1356000.0"
- CONNECT_ISLANDS - specifies that any matching area features with islands should have the
islands connected to the outer area boundary to form a single vertex list. This is useful if you need to export the
data for use in software that doesn't support area features with holes/islands in them. Use CONNECT_ISLANDS=YES to enable.
- SIMPLIFICATION - specifies a simplification threshold to use to
simplify/reduce the matching line features. This specifies how far off a straight line (in the
units of the current projection) that a point has to be before it is kept.
- CONVERT_AREAS_TO_LINES - specifies that any matching area features will have new line
features created from them. Use CONVERT_AREAS_TO_LINES=YES to enable this functionality.
- INSERT_VERTICES_AT_INTERSECTIONS - specifies that new vertices will be inserted at the
intersection of any matching line features. Use INSERT_VERTICES_AT_INTERSECTIONS=YES to enable this functionality.
- SPLIT_AT_INTERSECTIONS - specifies that any matching line features that share an interior
vertex will be split at that vertex into new lines. Use SPLIT_AT_INTERSECTIONS=YES to enable this functionality. Use this
in conjunction with the INSERT_VERTICES_AT_INTERSECTIONS option to insert vertices at intersections and then split the
lines there.
- UNIQUE_ID_BASE - specifies a number to start assigning unique IDs to features that match
the query. For example, using UNIQUE_ID_BASE=1 would assign ID attributes to each matching feature starting at 1 and
increasing sequentially (i.e. 1, 2, 3, etc.).
For an example of how to use the EDIT_VECTOR command, see the
sample at the bottom of this document.
EMBED_SCRIPT
The EMBED_SCRIPT command allows you to call another script from within a
script. This can be useful in many situations. For example, if you have a common
set of data files that you want to load for each script operation, you could
simply create a script that loaded those files, then embed that script within
your other scripts.
The following parameters are supported by the command:
- FILENAME - full path to script file to run
- SKIP_UNLOAD_ALL - specifies whether or not the first UNLOAD_ALL command
in the script file being run should be skipped. This is useful for embedding workspace files which typically
unload everything to start with. Use SKIP_UNLOAD_ALL=YES to skip the first UNLOAD_ALL command.
EXPORT_ELEVATION
The EXPORT_ELEVATION command exports all currently loaded elevation data to a
file. The following parameters are supported by the command.
- FILENAME - full path to file to save the data to
- TYPE - type of elevation file we're exporting to
- ARCASCIIGRID - export an Arc ASCII Grid format file.
- BIL - export to a BIL format file (simple binary format with header).
- BT - export to a BT (Binary Terrain) format grid file.
- DTED - export to DTED format grid files.
- DXF_3DFACE - export a DXF 3D face format file.
- DXF_MESH - export a 3D DXF mesh format file.
- DXF_POINT - export a 3D DXF point format file.
- ERDAS - export to an Erdas Imagine IMG format file.
- FBX - export to Open Flight FBX format file.
- FLOATGRID - export a Float/Grid format file.
- GEOSOFT_GRID - export to a Geosoft grid format file.
- GEOTIFF - export to a GeoTIFF format file.
- GLOBAL_MAPPER_GRID - export to a Global Mapper Grid format file.
- GRAVSOFT_GRID - export to a Gravsoft Grid format file.
- HF2 - export to a HF2/HFZ format file.
- IDRISI_RASTER - export to an Idrisi elevation format file.
- LEVELLER_HF - export to a Leveller heightfield file.
- LIDAR_LAS - export to a Lidar LAS file.
- MAPMAKERTERRAIN - export to a MapMaker Terrain format file.
- ROCKWORKS_GRID - export to a RockWorks Grid format file.
- STL - export to a STL format file
- SURFERGRID - export to a Surfer Grid format file. The FORMAT parameter
specifies whether it is an ASCII or binary format Surfer Grid file.
- TERRAGEN - export to a Terragen terrain file.
- USGS_DEM - export to a native format USGS DEM file.
- VRML - export to a VRML file.
- VULCAN_3D - export to a Vulcan3D triangulation file.
- XYZ_GRID - export to a XYZ Grid file.
- ELEV_UNITS - specify elevation units to use in export
- FEET - export in US feet
- DECIFEET - export in 10ths of US feet
- METERS - export in meters
- DECIMETERS - export in 10ths of meters
- CENTIMETERS - export in centimeters
- SPATIAL_RES - specifies spatial resolution. Defaults to the minimum
spatial resolution of all loaded data if not specified. Should be formatted as
x_resolution,y_resolution. The units are the units of the current global
projection. For example, if UTM was the current global projection and you
wanted to export at 30 meter spacing, the parameter/value pair would look like
SPATIAL_RES=30.0,30.0.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- FORCE_SQUARE_PIXELS - if this value is set to YES, the spatial
resolution of the resultant elevation file will be set so that the x and y
pixel size are the same, with the minimum default size being used for both.
- GLOBAL_BOUNDS - specifies the export bounds in units of the current
global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the export bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the export bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the export should use the bounds of
the loaded layer(s) with the given filename. For example, to export to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- FORMAT (SURFERGRID only) - determines if Surfer Grid export
format is ASCII, BINARY_V6, or BINARY_V7. The default is ASCII if no format is
specified.
- GEN_WORLD_FILE (GEOTIFF only) - specifies that a TIFF world
file (TFW) should be generated in addition to the TIFF file. Use
GEN_WORLD_FILE=YES to turn on.
- GEN_TAB_FILE (GEOTIFF only) - specifies that a MapInfo TAB
file should be generated in addition to the GeoTIFF file. Use GEN_TAB_FILE=YES
to turn on.
- GRID_TYPE_CELL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in the export
projection. The value should be specified as cell width,cell
height. For example, if you are exporting in a metric projection and want
to tile the export into cells that are 10,000 meters wide by 5,000 meters
tall, you would use GRID_TYPE_CELL_SIZE="10000.0,5000.0".
- GRID_TYPE_PIXEL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in pixels/samples.
The value should be specified as cell pixel width,cell pixel
height. For example, if you want to tile the export into cells that are
800 pixels wide by 600 meters tall, you would use
GRID_TYPE_PIXEL_SIZE="800,600".
- GRID_TYPE_ROWS_COLS - specifies that the export should be gridded
into multiple tiles with a given number of rows and columns of tiles. The
value should be specified as number of rows,number of columns.
For example, if you want to tile the export into a grid of 8 rows each 4 tiles
across, you would use GRID_TYPE_ROWS_COLS="8,4".
- GRID_OVERLAP - specifies how much to overlap tiles when gridding an
export into multiple tiles. This is a percentage value from 0 to 100 and only
applies when on of the GRID_TYPE_* parameters is used. For example, to make
your grid tiles overlap by 5% of the grid tile size, use GRID_OVERLAP="5.0".
The default value is 0.0, meaning that the tiles do not overlap.
- GRID_KEEP_CELL_SIZE - specifies that the size of
the grid cells should be maintained over sample spacing. This means that if you
specify a grid of 4 rows and 5 columns, each grid cell will be exactly 25% of the
total export height and 20% of the total export width. The sample spacing may be
slightly smaller than what is specified in order to achieve this. By default,
the sample spacing is exactly maintained and each grid cell may be slightly
larger than specified to maintain an integer number of exported cells. Use
GRID_KEEP_CELL_SIZE=YES to enable.
- GRID_NAMING - specifies how to name tiles when gridding an
export into multiple tiles. The value should be SEQUENTIAL for sequential numeric naming
starting at 1, SEPARATE for separate prefix appending by row and column, or
SEPARATE_COLS_FIRST for separate prefix appending by columns and rows. For the
SEPARATE options, use the GRID_NAMING_COLS and GRID_NAMING_ROWS parameters to specify
the details of how to name the rows and columns. If no GRID_NAMING parameter is supplied,
the last selected grid naming options selected in the user interface will be used.
- GRID_NAMING_COLS - specifies how to name the column
portion of grid cell names when using the GRID_NAMING=SEPARATE or
GRID_NAMING=SEPARATE_COLS_FIRST parameter. The value of
this field is a comma-delimited list with the following field values:
- Naming type. Can have the following values:
- NUM - name using numbers in ascending order
- NUM_REVERSE - name using numbers in descending order
- ALPHA - name using letters in ascending order
- ALPHA_REVERSE - name using letters in descending order
- Starting value for numbering or lettering (i.e. '1', or 'A').
- Prefix string to use before the numeric or alphabetic value.
- Step value for numeric naming (default is '1')
You can leave values blank if they don't apply or you want to use the default. As an
example, to do numeric naming starting at the number 100, increasing by 10 each time
with a prefix of DEM, you would use GRID_NAMING_COLS="NUM,100,DEM,10".
- GRID_NAMING_ROWS - specifies how to name the row
portion of grid cell names when using the GRID_NAMING=SEPARATE parameter. See the
documentation for the GRID_NAMING_COLS parameter above for details on the format.
- GRID_NAMING_PREPEND_ZEROES - specifies whether or not
to prepend zeroes to the start of grid column/row names. Use GRID_NAMING_PREPEND_ZEROES=NO to
disable the prepending of zeroes.
- GRID_NAMING_SEPARATOR - specifies the separator string to use
between pieces of a grid name. The default is an underscore.
- GRID_CREATE_FOLDERS - specifies that a separate folder should
be generated for each row (or column if GRID_NAMING=SEPARATE_COLS_FIRST is specified) of the export
rather than placing every output file in the same folder.
- QUAD_NAME (USGS_DEM only) - specifies the quad name to place
in the header of the USGS DEM file.
- FILL_GAPS - specifies that small gaps in between and within the
data sets being exported will be filled in by interpolating the surrounding
data to come up with an elevation for the point in question. This option is on
by default, specify FILL_GAPS=NO to turn off.
- VERT_EXAG (VRML only) - specifies the vertical exaggeration
to use when creating the VRML file. Larger values result in a rougher terrain
being generated while smaller values result in a smoother terrain. A value of 1.0 results
in no vertical exaggeration at all (i.e. a nearly true to life representation). If you don't specify
a value the currently selected vertical exaggeration value on the Vertical Options tab of the
Configuation dialog will be used.
- COORD_DELIM (XYZ_GRID only) - specifies the delimeter
between coordinates
- COMMA - coordinates are separated by commas
- FIXED_WIDTH - coordinates are stored in fixed width columns
- SEMICOLON - coordinates are separated by semicolons
- SPACE - coordinates are separated by space characters
- TAB - coordinates are separated by tab characters
- BYTES_PER_SAMPLE (BIL, ERDAS, and GEOTIFF
only) - specifies how many bytes to use per elevation sample in the BIL, IMG,
or vertical GeoTIFF file. Valid values are 2 bytes (16-bits) and 4 bytes
(32-bits). If this value isn't specified, 2 bytes are used.
- USE_BIG_ENDIAN (BIL only) - specifies that elevation values
written to BIL files should use big endian (Motorola byte order) rather than
the default little endian (Intel byte order).
- USE_ESRI_HDR (BIL only) - specifies that the ESRI .hdr format
should be used for the export. Use USE_ESRI_HDR=YES to enable.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the export should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be exported will be used
as the crop polygon (see POLYGON_CROP_USE_ALL for exception).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the export is being done in.
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the export will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_USE_EACH - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
generate a separate export for each polygons in that file rather than just the best-fit polygon.
See the POLYGON_CROP_BBOX_ONLY and POLYGON_CROP_NAME_ATTR options for naming and other
options when using this parameter. Use POLYGON_CROP_USE_EACH=YES to enable.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
- POLYGON_CROP_NAME_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use for
naming, or the special values <Area Display Label> or <Area Source Filename>.
If no value is provided, the exported files will be sequentially numbered.
- POLYGON_CROP_FOLDER_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use as a
folder name before the actual filename or the special values <Area Display Label>.
- ALLOW_LOSSY (GLOBAL_MAPPER_GRID only) - specifies whether or
not a slight loss in precision is allowable in order to achieve better
compression ratios. The default is YES, so turn only use lossless compression
you need to specify a value of ALLOW_LOSSY=NO.
- EXPORT_COLORS (XYZ_GRID only) - specifies that RGB color
values should be exported for each coordinate that is saved.
- OVERWRITE_EXISTING - specifies that existing files should be
overwritten. The default is OVERWRITE_EXISTING=YES, so use
OVERWRITE_EXISTING=NO to skip exporting files that already exist.
- ADD_OVERVIEW_LAYERS (ERDAS only) -
specifies that overview (pyramid) layers should be generated for the export. Use
ADD_OVERVIEW_LAYERS=YES to enable.
- BLOCK_SIZE (ERDAS only) -
specifies the block size to use for the export. The default is BLOCK_SIZE=64.
- COMPRESS_OUTPUT (ERDAS only) -
specifies whether or not the exported file should be compress. The default is
COMPRESS_OUTPUT=YES.
- TILE_SIZE (GEOTIFF only) - specifies that the GeoTIFF
file should be exported with a tiled organization and use the specified tile size. This tile
size should be between 8 and 2048. Typical values are 64, 128, and 256.
- DISABLE_BIGTIFF (GEOTIFF only) - use to disable
the automatic creation of BigTIFF-format files for very large exports. Use DISABLE_BIGTIFF=YES
to disable the automatic BigTIFF support.
- EXPORT_SLOPE (FLOAT_GRID only) - use to specify that
slope values should be exported rather than elevation values. Use EXPORT_SLOPE=YES to enable.
- EXPORT_SLOPE_DIR (FLOAT_GRID only) - use to specify that
slope direction values should be exported rather than elevation values.
Use EXPORT_SLOPE_DIR=YES to enable.
- EXPORT_SLOPE_PERCENT (FLOAT_GRID only) - use to specify that
slope values should be exported as percent slope rather than degrees. Use EXPORT_SLOPE_PERCENT=YES to enable
and also make sure to add EXPORT_SLOPE=YES to the command line.
- DTED_LEVEL (DTED only) - specifies which DTED level to export
to. The values must be between 0 and 5 (with 0, 1, and 2) being the only levels supported by most applications.
- SPLIT_INTO_FOLDERS (DTED only) - write each column out to separate folders by
longitude. Use SPLIT_INTO_FOLDERS=YES to enable this behavior.
- COMPRESSION (GeoTIFF only)- specifies the type of compression to
use for the generated TIFF file. If you do not provide a compression value then no compression will be used.
- NONE - Do not compress the output.
- LZW - Use LZW (lossless) compression on the output.
- DEFLATE - Use Deflate/ZIP (lossless) compression on the output.
EXPORT_METADATA
The EXPORT_METADATA command exports the metadata for a specified load layer.
The following parameters are supported by the command.
- FILENAME - full path of file (must already be loaded) that you want
to save the metadata for.
- METADATA_FILENAME - full path of new text file to create on disk
containing the metadata for the specified layer.
EXPORT_PACKAGE
The EXPORT_PACKAGE command exports all currently loaded raster, vector, and
elevation data to a Global Mapper Package (GMP) file. The following parameters are
supported by the command.
- FILENAME - full path to file to save the data to
- SIMPLIFICATION - specifies the simplification threshold to use when
exporting the vector features. This specifies how far off a straight line (in the
units of the current projection) that a point has to be before it is kept.
Generally you should not specify a simplification value as the default just exports
all vertices as they are. This is an option for advanced users only.
- SINGLE_PRECISION - specifies that vector coordinates
should be written out as 4-byte single precision floating point numbers rather than the
default 8-byte double precision floating point numbers. Use SINGLE_PRECISION=YES to
enable single precision export, which will result in smaller files.
- DISCARD_ATTRIBUTES - specifies that the list of attribute-value
pairs for each vector feature should not be written out. Use DISCARD_ATTRIBUTES=YES to
enable this behavior.
- VECTOR_ONLY - specifies that only vector layers should be
exported to the package file. Use VECTOR_ONLY=YES to enable.
- KEEP_ALL_STYLES - specifies that the full style of each feature
should be written to the package file, even if it uses the current default for the type. Use
KEEP_ALL_STYLES=YES to enable this. This is useful if you want features to look exactly the
same on all systems and not be affected by changes to the default styling for types.
- KEEP_NATIVE_PROJECTION - specifies that each layer should
be exported in the native projection of the layer rather than reprojected to the current
projection. Use KEEP_NATIVE_PROJECTION=YES to enable this behavior.
- COMBINE_VECTOR_LAYERS - specifies that all vector data
should be combined into a single layer within the package file. Use COMBINE_VECTOR_LAYERS=YES
to enable this behavior.
- GLOBAL_BOUNDS - specifies the export bounds in units of the current
global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the export bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the export bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the export should use the bounds of
the loaded layer(s) with the given filename. For example, to export to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- GRID_TYPE_CELL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in the export
projection. The value should be specified as cell width,cell
height. For example, if you are exporting in a metric projection and want
to tile the export into cells that are 10,000 meters wide by 5,000 meters
tall, you would use GRID_TYPE_CELL_SIZE="10000.0,5000.0".
- GRID_TYPE_ROWS_COLS - specifies that the export should be gridded
into multiple tiles with a given number of rows and columns of tiles. The
value should be specified as number of rows,number of columns.
For example, if you want to tile the export into a grid of 8 rows each 4 tiles
across, you would use GRID_TYPE_ROWS_COLS="8,4".
- GRID_OVERLAP - specifies how much to overlap tiles when gridding an
export into multiple tiles. This is a percentage value from 0 to 100 and only
applies when on of the GRID_TYPE_* parameters is used. For example, to make
your grid tiles overlap by 5% of the grid tile size, use GRID_OVERLAP="5.0".
The default value is 0.0, meaning that the tiles do not overlap.
- GRID_KEEP_CELL_SIZE - specifies that the size of
the grid cells should be maintained over sample spacing. This means that if you
specify a grid of 4 rows and 5 columns, each grid cell will be exactly 25% of the
total export height and 20% of the total export width. The sample spacing may be
slightly smaller than what is specified in order to achieve this. By default,
the sample spacing is exactly maintained and each grid cell may be slightly
larger than specified to maintain an integer number of exported cells. Use
GRID_KEEP_CELL_SIZE=YES to enable.
- GRID_NAMING - specifies how to name tiles when gridding an
export into multiple tiles. The value should be SEQUENTIAL for sequential numeric naming
starting at 1, SEPARATE for separate prefix appending by row and column, or
SEPARATE_COLS_FIRST for separate prefix appending by columns and rows. For the
SEPARATE options, use the GRID_NAMING_COLS and GRID_NAMING_ROWS parameters to specify
the details of how to name the rows and columns. If no GRID_NAMING parameter is supplied,
the last selected grid naming options selected in the user interface will be used.
- GRID_NAMING_COLS - specifies how to name the column
portion of grid cell names when using the GRID_NAMING=SEPARATE or
GRID_NAMING=SEPARATE_COLS_FIRST parameter. The value of
this field is a comma-delimited list with the following field values:
- Naming type. Can have the following values:
- NUM - name using numbers in ascending order
- NUM_REVERSE - name using numbers in descending order
- ALPHA - name using letters in ascending order
- ALPHA_REVERSE - name using letters in descending order
- Starting value for numbering or lettering (i.e. '1', or 'A').
- Prefix string to use before the numeric or alphabetic value.
- Step value for numeric naming (default is '1')
You can leave values blank if they don't apply or you want to use the default. As an
example, to do numeric naming starting at the number 100, increasing by 10 each time
with a prefix of DEM, you would use GRID_NAMING_COLS="NUM,100,DEM,10".
- GRID_NAMING_ROWS - specifies how to name the row
portion of grid cell names when using the GRID_NAMING=SEPARATE parameter. See the
documentation for the GRID_NAMING_COLS parameter above for details on the format.
- GRID_NAMING_PREPEND_ZEROES - specifies whether or not
to prepend zeroes to the start of grid column/row names. Use GRID_NAMING_PREPEND_ZEROES=NO to
disable the prepending of zeroes.
- GRID_NAMING_SEPARATOR - specifies the separator string to use
between pieces of a grid name. The default is an underscore.
- GRID_CREATE_FOLDERS - specifies that a separate folder should
be generated for each row (or column if GRID_NAMING=SEPARATE_COLS_FIRST is specified) of the export
rather than placing every output file in the same folder.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the export should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be exported will be used
as the crop polygon (see POLYGON_CROP_USE_ALL or POLYGON_CROP_USE_EACH for exceptions).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the export is being done in.
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the export will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_USE_EACH - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
generate a separate export for each polygons in that file rather than just the best-fit polygon.
See the POLYGON_CROP_BBOX_ONLY and POLYGON_CROP_NAME_ATTR options for naming and other
options when using this parameter. Use POLYGON_CROP_USE_EACH=YES to enable.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
- POLYGON_CROP_NAME_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use for
naming, or the special values <Area Display Label> or <Area Source Filename>.
If no value is provided, the exported files will be sequentially numbered.
- POLYGON_CROP_FOLDER_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use as a
folder name before the actual filename or the special values <Area Display Label>.
- OVERWRITE_EXISTING - specifies that existing files should be
overwritten. The default is OVERWRITE_EXISTING=YES, so use
OVERWRITE_EXISTING=NO to skip exporting files that already exist.
EXPORT_PDF
The EXPORT_PDF command exports all currently loaded data to a PDF file. The following parameters are
supported by the command.
- FILENAME - full path to file to save the data to
- DPI - specifies the DPI that the file is generated at.
- PDF_PAGE_SIZE - specifies the name of the paper size to use.
This should match one of the entries on the PDF export dialog, like landscape, portrait, A0, etc.
- PDF_PAGE_ORIENTATION - specifies the page orientation to use for
the generated PDF file. The following values are supported:
- AUTO - Automatically determine whether to use portrait or landscape mode based on export bounds aspect ratio.
- PORTRAIT
- LANDSCAPE
- PDF_MARGINS - specifies the margins to use in inches. The value should be a comma-delimited
list of numbers for the left, top, right, and bottom margins. For example, PDF_MARGINS="0.5,1.0,0.5,1.25" would result in a
0.5 inch margin for the left and right, 1.0 inch for the top, and 1.25 inches for the bottom.
- PDF_HEADER - specifies the header to use
- PDF_FOOTER - specifies the footer to use
- PDF_COMBINE_RASTERS - specifies whether multiple raster layers should be combined into a
single layer or kept separate. Use PDF_COMBINE_RASTERS=YES to combine them or PDF_COMBINE_RASTER_LAYERS=NO to keep separate.
- PDF_FILL_PAGE - specifies whether the PDF export should fill the page or be cropped to the
exact bounds specified. Use PDF_FILL_PAGE=YES to enable or PDF_FILL_PAGE=NO to disable.
- PDF_FONT_SCALE - specifies the scale factor to apply to text. For example use
PDF_FONT_SCALE=2.0 to double the size of text.
- PDF_SYMBOL_SCALE - specifies the scale factor to apply to point symbols and icons. For example use
PDF_SYMBOL_SCALE=2.0 to double the size of symbols.
- VECTOR_ONLY - specifies that only vector layers should be
exported to the PDF file. Use VECTOR_ONLY=YES to enable.
- SAVE_SCALE_AND_LEGEND - specifies that the distance scale and
elevation legend, if applicable and enabled for display on the Configuration
dialog, should be exported to the generated PDF file. Specify
SAVE_SCALE_AND_LEGEND=YES and SAVE_SCALE_AND_LEGEND=NO to disable this option. If it's not specified the
current view settings will be used.
- GLOBAL_BOUNDS - specifies the export bounds in units of the current
global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the export bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the export bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the export should use the bounds of
the loaded layer(s) with the given filename. For example, to export to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- GRID_TYPE_CELL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in the export
projection. The value should be specified as cell width,cell
height. For example, if you are exporting in a metric projection and want
to tile the export into cells that are 10,000 meters wide by 5,000 meters
tall, you would use GRID_TYPE_CELL_SIZE="10000.0,5000.0".
- GRID_TYPE_ROWS_COLS - specifies that the export should be gridded
into multiple tiles with a given number of rows and columns of tiles. The
value should be specified as number of rows,number of columns.
For example, if you want to tile the export into a grid of 8 rows each 4 tiles
across, you would use GRID_TYPE_ROWS_COLS="8,4".
- GRID_OVERLAP - specifies how much to overlap tiles when gridding an
export into multiple tiles. This is a percentage value from 0 to 100 and only
applies when on of the GRID_TYPE_* parameters is used. For example, to make
your grid tiles overlap by 5% of the grid tile size, use GRID_OVERLAP="5.0".
The default value is 0.0, meaning that the tiles do not overlap.
- GRID_KEEP_CELL_SIZE - specifies that the size of
the grid cells should be maintained over sample spacing. This means that if you
specify a grid of 4 rows and 5 columns, each grid cell will be exactly 25% of the
total export height and 20% of the total export width. The sample spacing may be
slightly smaller than what is specified in order to achieve this. By default,
the sample spacing is exactly maintained and each grid cell may be slightly
larger than specified to maintain an integer number of exported cells. Use
GRID_KEEP_CELL_SIZE=YES to enable.
- GRID_NAMING - specifies how to name tiles when gridding an
export into multiple tiles. The value should be SEQUENTIAL for sequential numeric naming
starting at 1, SEPARATE for separate prefix appending by row and column, or
SEPARATE_COLS_FIRST for separate prefix appending by columns and rows. For the
SEPARATE options, use the GRID_NAMING_COLS and GRID_NAMING_ROWS parameters to specify
the details of how to name the rows and columns. If no GRID_NAMING parameter is supplied,
the last selected grid naming options selected in the user interface will be used.
- GRID_NAMING_COLS - specifies how to name the column
portion of grid cell names when using the GRID_NAMING=SEPARATE or
GRID_NAMING=SEPARATE_COLS_FIRST parameter. The value of
this field is a comma-delimited list with the following field values:
- Naming type. Can have the following values:
- NUM - name using numbers in ascending order
- NUM_REVERSE - name using numbers in descending order
- ALPHA - name using letters in ascending order
- ALPHA_REVERSE - name using letters in descending order
- Starting value for numbering or lettering (i.e. '1', or 'A').
- Prefix string to use before the numeric or alphabetic value.
- Step value for numeric naming (default is '1')
You can leave values blank if they don't apply or you want to use the default. As an
example, to do numeric naming starting at the number 100, increasing by 10 each time
with a prefix of DEM, you would use GRID_NAMING_COLS="NUM,100,DEM,10".
- GRID_NAMING_ROWS - specifies how to name the row
portion of grid cell names when using the GRID_NAMING=SEPARATE parameter. See the
documentation for the GRID_NAMING_COLS parameter above for details on the format.
- GRID_NAMING_PREPEND_ZEROES - specifies whether or not
to prepend zeroes to the start of grid column/row names. Use GRID_NAMING_PREPEND_ZEROES=NO to
disable the prepending of zeroes.
- GRID_NAMING_SEPARATOR - specifies the separator string to use
between pieces of a grid name. The default is an underscore.
- GRID_CREATE_FOLDERS - specifies that a separate folder should
be generated for each row (or column if GRID_NAMING=SEPARATE_COLS_FIRST is specified) of the export
rather than placing every output file in the same folder.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the export should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be exported will be used
as the crop polygon (see POLYGON_CROP_USE_ALL or POLYGON_CROP_USE_EACH for exceptions).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the export is being done in.
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the export will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_USE_EACH - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
generate a separate export for each polygons in that file rather than just the best-fit polygon.
See the POLYGON_CROP_BBOX_ONLY and POLYGON_CROP_NAME_ATTR options for naming and other
options when using this parameter. Use POLYGON_CROP_USE_EACH=YES to enable.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
- POLYGON_CROP_NAME_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use for
naming, or the special values <Area Display Label> or <Area Source Filename>.
If no value is provided, the exported files will be sequentially numbered.
- POLYGON_CROP_FOLDER_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use as a
folder name before the actual filename or the special values <Area Display Label>.
- OVERWRITE_EXISTING - specifies that existing files should be
overwritten. The default is OVERWRITE_EXISTING=YES, so use
OVERWRITE_EXISTING=NO to skip exporting files that already exist.
EXPORT_RASTER
The EXPORT_RASTER command exports all currently loaded raster, vector, and
elevation data to a file. The following parameters are supported by the command.
- FILENAME - full path to file to save the data to
- TYPE - type of raster file we're exporting to
- BIL - export to a band interleave (BIL) format file.
- BIP - export to a band interleaved pixel (BIP) format file.
- BMP - export to a Windows bitmap (BMP) format file.
- BSQ - export to a band sequential (BSQ) format file.
- ECW - export to an ECW format file.
- ERDAS - export to an Erdas Imagine IMG format file.
- GEOTIFF - export to a GeoTIFF format file.
- IDRISI_RASTER - export to an Idrisi raster format file.
- JPEG - export to a JPG format file.
- JPEG2000 - export to a JPEG2000 format file.
- KML - export to a raster KML/KMZ format file for display in Google Earth.
- PNG - export to a PNG format file.
- SPATIAL_RES - specifies spatial resolution. Defaults to the minimum
spatial resolution of all loaded data if not specified. Should be formatted as
x_resolution,y_resolution. The units are the units of the current global
projection. For example, if UTM was the current global projection and you
wanted to export at 30 meter spacing, the parameter/value pair would look like
SPATIAL_RES=30.0,30.0.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- PIXEL_SIZE - specifies the desired size in pixels
of your export. Use this instead of SPATIAL_RES if you know exactly how many pixels
in size your export should be. The format is PIXEL_SIZE="widthxheight".
For example, to make your export have dimensions of 1024 pixels wide by 768 pixels
tall, use PIXEL_SIZE="1024x768".
- FORCE_SQUARE_PIXELS - if this value is set to YES, the spatial
resolution of the resultant raster file will be set so that the x and y pixel
size are the same, with the minimum default size being used for both.
- GLOBAL_BOUNDS - specifies the export bounds in units of the current
global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the export bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the export bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the export should use the bounds of
the loaded layer(s) with the given filename. For example, to export to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- GEN_WORLD_FILE - specifies that a world file should be generated in
addition to the image file. Use GEN_WORLD_FILE=YES to turn on.
- GEN_TAB_FILE (GEOTIFF and PNGonly) - specifies that a
MapInfo TAB file should be generated in addition to the image file. Use
GEN_TAB_FILE=YES to turn on.
- GEN_PRJ_FILE - specifies that a projection (PRJ) file should be
generated in addition to the data file. Use GEN_PRJ_FILE=YES to turn on.
- PALETTE - specifies the palette/image type to use. If not specified, a 24-bit
RGB image will be generated.
- KEEP_SOURCE
- The exported file will use the some color configuration (if possible)
as the file being exported. Note that this option is only available if you have only a
single layer loaded for export.
- OPTIMIZED (BMP, ERDAS, GEOTIFF, and PNG only) - The
palette generated will be an optimal mix of up to 256 colors that will
closely represent the full blend of colors in the source images. This option
will generate the best results, but can more than double the export time
required if any high color images are present in the export set.
- HALFTONE (BMP, ERDAS, GEOTIFF, and PNG only) - use a
256-color halftone palette spread over the color spectrum
- DOQ_DRG (BMP, ERDAS, GEOTIFF, and PNG only) - use a
256-color palette optimized for combined grayscale DOQs and USGS DRGs
- DRG (BMP, ERDAS, GEOTIFF, and PNG only) - use a
256-color palette optimized for the colors found in USGS DRGs
- GRAYSCALE - use a 256-color grayscale palette
- BW (BMP, GEOTIFF only) - creates a black and white, 1-bit per pixel
image
- BLACKISMIN (GEOTIFF only) - creates an 8-bit per pixel grayscale
image with no color map stored in the image. Black will be stored as zero
with varying shades of gray up to white with a value of 255.
- WHITEISMIN (GEOTIFF only) - creates an 8-bit per pixel grayscale
image with no color map stored in the image. White will be stored as zero
with varying shades of gray up to black with a value of 255.
- JPG (GEOTIFF only) - creates a 24-bit RGB JPG-in-TIFF image. Note
that while this creates a highly compressed GeoTIFF file, many software
packages do not recognize JPG-in-TIFF format files.
- MULTIBAND (BIL, BIP. BSQ, GEOTIFF, and JPEG2000 only) -
creates a multi-band image file with any
number of bands of data. This is useful for multi-spectral imagery. Either 8- or
16-bits per band will be used depending on what is available in the input data.
Use the NUM_BANDS parameter to specify how many bands to use. You can override
the default band setting using the BAND_EXPORT_SETUP parameter (described below).
- Custom palette filename - you can also pass in the full path to a .pal file
containing a custom palette to use for the export.
- NUM_BANDS - specifies how many bands of data to
export for a PALETTE=MULTIBAND export. If you don't specify a value for this the band
count will be the maximum available for any of the loaded layers.
- BAND_BIT_DEPTH - specifies how many bits to use for each band of data
for a PALETTE=MULTIBAND export. If you don't specify a value for this the highest bit depth of
any of the input data layers will be used. The valid values are BAND_BIT_DEPTH=8, BAND_BIT_DEPTH=16,
or BAND_BIT_DEPTH=32.
- BAND_EXPORT_SETUP - allows you to override the default
band assignment for a MULTIBAND export. Use the following format to specify what band
from what layer to use for a given export band: <output_band>?<input_band>?<layer_filename> .
So for example to assign the 4th (infrared) band in an export from the 1st (red) band
in a previously loaded file name C:\data\input_file.tif, use the following parameter:
BAND_EXPORT_SETUP="4?1?c:\data\input_file.tif". Note that you would include a separate
BAND_EXPORT_SETUP parameter for each output band that you want to setup. If you leave
off the filename then you all loaded data will be considered as input, with just the
input-to-output band assignment being updated.
- GRID_TYPE_CELL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in the export
projection. The value should be specified as cell width,cell
height. For example, if you are exporting in a metric projection and want
to tile the export into cells that are 10,000 meters wide by 5,000 meters
tall, you would use GRID_TYPE_CELL_SIZE="10000.0,5000.0".
- GRID_TYPE_PIXEL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in pixels/samples.
The value should be specified as cell pixel width,cell pixel
height. For example, if you want to tile the export into cells that are
800 pixels wide by 600 meters tall, you would use
GRID_TYPE_PIXEL_SIZE="800,600".
- GRID_TYPE_ROWS_COLS - specifies that the export should be gridded
into multiple tiles with a given number of rows and columns of tiles. The
value should be specified as number of rows,number of columns.
For example, if you want to tile the export into a grid of 8 rows each 4 tiles
across, you would use GRID_TYPE_ROWS_COLS="8,4".
- GRID_OVERLAP - specifies how much to overlap tiles when gridding an
export into multiple tiles. This is a percentage value from 0 to 100 and only
applies when on of the GRID_TYPE_* parameters is used. For example, to make
your grid tiles overlap by 5% of the grid tile size, use GRID_OVERLAP="5.0".
The default value is 0.0, meaning that the tiles do not overlap.
- GRID_KEEP_CELL_SIZE - specifies that the size of
the grid cells should be maintained over sample spacing. This means that if you
specify a grid of 4 rows and 5 columns, each grid cell will be exactly 25% of the
total export height and 20% of the total export width. The sample spacing may be
slightly smaller than what is specified in order to achieve this. By default,
the sample spacing is exactly maintained and each grid cell may be slightly
larger than specified to maintain an integer number of exported cells. Use
GRID_KEEP_CELL_SIZE=YES to enable.
- GRID_NAMING - specifies how to name tiles when gridding an
export into multiple tiles. The value should be SEQUENTIAL for sequential numeric naming
starting at 1, SEPARATE for separate prefix appending by row and column, or
SEPARATE_COLS_FIRST for separate prefix appending by columns and rows. For the
SEPARATE options, use the GRID_NAMING_COLS and GRID_NAMING_ROWS parameters to specify
the details of how to name the rows and columns. If no GRID_NAMING parameter is supplied,
the last selected grid naming options selected in the user interface will be used.
- GRID_NAMING_COLS - specifies how to name the column
portion of grid cell names when using the GRID_NAMING=SEPARATE or
GRID_NAMING=SEPARATE_COLS_FIRST parameter. The value of
this field is a comma-delimited list with the following field values:
- Naming type. Can have the following values:
- NUM - name using numbers in ascending order
- NUM_REVERSE - name using numbers in descending order
- ALPHA - name using letters in ascending order
- ALPHA_REVERSE - name using letters in descending order
- Starting value for numbering or lettering (i.e. '1', or 'A').
- Prefix string to use before the numeric or alphabetic value.
- Step value for numeric naming (default is '1')
You can leave values blank if they don't apply or you want to use the default. As an
example, to do numeric naming starting at the number 100, increasing by 10 each time
with a prefix of DEM, you would use GRID_NAMING_COLS="NUM,100,DEM,10".
- GRID_NAMING_ROWS - specifies how to name the row
portion of grid cell names when using the GRID_NAMING=SEPARATE parameter. See the
documentation for the GRID_NAMING_COLS parameter above for details on the format.
- GRID_NAMING_PREPEND_ZEROES - specifies whether or not
to prepend zeroes to the start of grid column/row names. Use GRID_NAMING_PREPEND_ZEROES=NO to
disable the prepending of zeroes.
- GRID_NAMING_SEPARATOR - specifies the separator string to use
between pieces of a grid name. The default is an underscore.
- GRID_CREATE_FOLDERS - specifies that a separate folder should
be generated for each row (or column if GRID_NAMING=SEPARATE_COLS_FIRST is specified) of the export
rather than placing every output file in the same folder.
- QUALITY (JPEG or GEOTIFF only) - specifies the quality setting to use
when generating the image. Valid values range from 1 to 100, with 1 generating
the lowest quality image and 100 generating the highest quality image. If no
QUALITY setting is present, a default value of 75 is used which generates a
very high quality image that is still highly compressed. Note that if a different quality value
has been selected on the GeoTIFF export dialog in the user interface the last used value
there will be the default.
- TARGET_COMPRESSION (ECW and JPEG2000 only) - specifies the target
compression ratio to use when creating the ECW image. The default value is 10
which strikes a good balance between image quality and compression. The higher
the value, the smaller the resulting image will be at the expense of image
quality.
- INC_VECTOR_DATA - specifies whether or not loaded vector data
should be rendered and exported to the generated image. Use a value of YES to
indicate that vector data should be used. Any other value will result in
vector data NOT being saved to the file.
- FILL_GAPS - specifies that small gaps in between and within the
data sets being exported will be filled in by interpolating the surrounding
data to come up with a color for the point in question. This option is off by
default, specify FILL_GAPS=YES to turn it on.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the export should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be exported will be used
as the crop polygon (see POLYGON_CROP_USE_ALL or POLYGON_CROP_USE_EACH for exceptions).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the export is being done in.
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the export will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_USE_EACH - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
generate a separate export for each polygons in that file rather than just the best-fit polygon.
See the POLYGON_CROP_BBOX_ONLY and POLYGON_CROP_NAME_ATTR options for naming and other
options when using this parameter. Use POLYGON_CROP_USE_EACH=YES to enable.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
- POLYGON_CROP_NAME_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use for
naming, or the special values <Area Display Label> or <Area Source Filename>.
If no value is provided, the exported files will be sequentially numbered.
- POLYGON_CROP_FOLDER_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use as a
folder name before the actual filename or the special values <Area Display Label>.
- ONLY_GENERATE_METADATA (GEOTIFF, JPEG, and PNG
only) - specifies that only metadata files like world files, TAB files, and
PRJ files should be created for this file. This is useful for things like
generating world and TAB files from GeoTIFF files without doing a whole new
export. Just make the output filename the same as the loaded file to create
the metadata for.
- COMPRESSION (GeoTIFF only)- specifies the type of compression to
use for the generated TIFF file. If you do not provide a compression value the default compression
for each type will be used. The following values are supported:
- NONE - Do not compress the output.
- LZW - Use LZW (lossless) compression on the output.
- JPEG - Use JPEG-in-TIFF (lossy) compression. Only works for 24-bit RGB output. Use QUALITY parameter to set quality setting.
- PACKBITS - Use Packbits (lossless) compression. Only works for 8-bit palette-based output.
- DEFLATE - Use Deflate/ZIP (lossless) compression on the output.
- USE_LZW (GEOTIFF only) [DEPRECATED - use COMPRESSION instead]- specifies that LZW compression
should be used for this RGB or palette-based GeoTIFF file. LZW compression
typically results in much smaller files than the default compression, but
there may be some software packages that do not yet support LZW-encoded
GeoTIFF files. Specify USE_LZW=YES to enable LZW compression.
- TILE_SIZE (GEOTIFF only) - specifies that the GeoTIFF
file should be exported with a tiled organization and use the specified tile size. This tile
size should be between 8 and 2048. Typical values are 64, 128, and 256.
- SAVE_SCALE_AND_LEGEND - specifies that the distance scale and
elevation legend, if applicable and enabled for display on the Configuration
dialog, should be exported to the generated raster file. Specify
SAVE_SCALE_AND_LEGEND=YES to enable this option.
- BG_TRANSPARENT (ECW, GEOTIFF, JPEG2000 and PNG only) - specifies
that any areas of no data/background should be marked as transparent. Use BG_TRANSPARENT=YES to enable.
- OVERWRITE_EXISTING - specifies that existing files should be
overwritten. The default is OVERWRITE_EXISTING=YES, so use
OVERWRITE_EXISTING=NO to skip exporting files that already exist.
- EXPORT_SCALE - specifies the scale to do the export at. You must also
specify a DPI value in order to use the EXPORT_SCALE parameter. For example to export at 1:50,000 scale,
use EXPORT_SCALE=50000.
- DPI (GEOTIFF and JPG only or with EXPORT_SCALE parameter) -
specifies the DPI (dots per inch) value to save in the generated file(s). For example, use
DPI=300 to specify that the DPI for this file is 300. By default no DPI value will
be written out.
- KML_MIN_LOD_PIXELS (KML only) -
specifies how large layer has to be in pixels before it will show up in Google Earth.
- KML_MAX_LOD_PIXELS (KML only) -
specifies how large layer has to be in pixels before it will stop showing up in Google Earth.
The default value of -1 which means that a layer will never go away once it is displayed.
- KML_FADE_EXTENT_MIN (KML only) -
specifies at what number of pixels in size that the image will start fading out. This value
should be between KML_MIN_LOD_PIXELS and KML_MAX_LOD_PIXELS. The fade will be such that
the image is 100% opaque at KML_FADE_EXTENT_MIN and completely transparent at KML_MIN_LOD_PIXELS.
- KML_FADE_EXTENT_MAX (KML only) -
specifies at what number of pixels in size that the image will start fading out. This value
should be between KML_MIN_LOD_PIXELS and KML_MAX_LOD_PIXELS. The fade will be such that
the image is 100% opaque at KML_FADE_EXTENT_MAX and completely transparent at KML_MAX_LOD_PIXELS.
- KML_RASTER_FORMAT (KML only) -
specified which raster image format to use when creating tiles for KML/KMZ files. The
valid options are JPG, PNG, and TIFF. For example, add KML_RASTER_FORMAT=JPG to use
JPG format files.
- KML_SUPER_OVERLAY (KML only) -
specifies that the data should be automatically gridded into "super overlays" to
allow displaying large quantities of data in Google Earth. Use KML_SUPER_OVERLAY=YES
to enable this behavior.
- KML_TILE_SIZE (KML only) -
if data is being automatically gridded into "super overlays", this specifies the size of
tiles to use for gridding. The default tile size is 1024. To change this for example to
512x512, use KML_TILE_SIZE=512.
- KML_ZOOM_SCALE_FACTOR (KML only) -
if data is being automatically gridded into "super overlays", this specifies the multiplier
to use when creating zoomed out pyramid layers. The default value of 2 makes each
successive zoom level 1/2 the resolution of the previous one until everything fits
in a single tile. To change this to making each layer 1/3rd the resolution of the
previous one, use KML_ZOOM_SCALE_FACTOR=3.
- ADD_OVERVIEW_LAYERS (ERDAS only) -
specifies that overview (pyramid) layers should be generated for the export. Use
ADD_OVERVIEW_LAYERS=YES to enable.
- BLOCK_SIZE (ERDAS only) -
specifies the block size to use for the export. The default is BLOCK_SIZE=64.
- COMPRESS_OUTPUT (ERDAS only) -
specifies whether or not the exported file should be compress. The default is
COMPRESS_OUTPUT=YES.
- DISABLE_BIGTIFF (GEOTIFF only) - use to disable
the automatic creation of BigTIFF-format files for very large exports. Use DISABLE_BIGTIFF=YES
to disable the automatic BigTIFF support.
- DPI - specifies the DPI (dots per inch) value to store in the generated file. For
example, use DPI=300 to embed a DPI value of 300 in the generated file.
EXPORT_VECTOR
The EXPORT_VECTOR command exports all currently loaded vector data to a file.
The following parameters are supported by the command.
- FILENAME - full path to file to save the data to
- TYPE - type of vector file we're exporting to
- ARC_UNGENERATE - export line and area features to an Arc Ungenerate
format file.
- ARC_UNGENERATE_POINTS - export point features to an Arc Ungenerate
format file.
- CDF - export to a Geographix CDF format file.
- CSV - export point features to a CSV format file.
- DELORME_DRAWING - export features to a DeLorme drawing text file
- DELORME_TRACK - export line features to a DeLorme track text file
- DELORME_WAYPOINT - export point features to a DeLorme waypoint text file
- DGN - export to a DGN v8 file.
- DLGO - export to a native format USGS DLG-O file.
- DWG - export to an AutoCAD DWG format file.
- DXF - export to an AutoCAD DXF format file.
- GARMIN_TRK - exports lines to a Garmin TRK (PCX5) format file.
- GARMIN_WPT - exports names points to a Garmin WPT (PCX5) format file.
- GPX - exports line and point features to a GPX (GPS eXchange Format)
file.
- INROADS - exports to the InRoads ASCII format.
- KML - export to a KML or KMZ format file.
- LANDMARK_GRAPHICS - export to a Landmark Graphics format file.
- LIDAR_LAS - export to a Lidar LAS file.
- LOWRANCE_USR - export to a Lowrance USR format file.
- MAPGEN - export to a MapGen format file.
- MAPINFO - export to a MapInfo MIF/MID or TAB/MAP format file.
- MATLAB - export to a MatLab format file.
- MOSS - export line and area features to a MOSS format file.
- NIMA_ASC - export to a NIMA ASC format file.
- PLATTE_RIVER - export to a Platte River ASCII Digitizer format file.
- POLISH_MP - export to a Polish MP format file.
- SEGP1 - export to a SEGP1 format file.
- SHAPEFILE - export to an ESRI Shapefile format file.
- SIMPLE_ASCII - export to a simple ASCII text file.
- SURFER_BLN - export to a Surfer BLN format file.
- SVG - export to a Scalable Vector Graphic (SVG) format file.
- TSUNAMI_OVR - export to a Tsunami OVR format file.
- WASP_MAP - export to a WAsP .map format file (line features only).
- ZMAP_XYSEGID - export to a ZMap+ XYSegId format file (area and line features only).
- GLOBAL_BOUNDS - specifies the export bounds in units of the current
global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the export bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the export bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the export should use the bounds of
the loaded layer(s) with the given filename. For example, to export to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- QUAD_NAME (DLGO only) - specifies the quadrangle name to
store in the header of the DLG-O file. If not quadrangle name is specified,
Global Mapper will attempt to automatically determine one based on the loaded
data.
- EXPORT_DWG_LABELS (DWG only) - specifies that object labels
will be exported as attributes in the DWG file. Typically you want to set this
to YES, unless you are working with a software package that cannot handle DWG
files with attributes. Leaving out this parameter or setting it to anything
but YES will cause feature labels to be discarded on export.
- EXPORT_DXF_LABELS (DXF only) - specifies that object labels
will be exported as attributes in the DXF file. Typically you want to set this
to YES, unless you are working with a software package that cannot handle DXF
files with attributes. Leaving out this parameter or setting it to anything
but YES will cause feature labels to be discarded on export.
- DWG_TEXT_SIZE (DWG only) - specifies the multiplier value
to apply to text sizes when exporting DWG file. Use this to control how large text is in the
exported file.
- DXF_TEXT_SIZE (DXF only) - specifies the multiplier value
to apply to text sizes when exporting DXF file. Use this to control how large text is in the
exported file.
- SHAPE_TYPE (SHAPEFILE only) - specifies the vector object
type (area, line, or point) to export to the shapefile. The following values
are valid:
- AREAS - export area features to the Shapefile
- LINES - export line features to the Shapefile
- POINTS - export point features to the Shapefile
- GEN_PRJ_FILE - specifies that a projection (PRJ) file should be
generated in addition to the output file. Set this to YES to cause the
projection file to be generated. Leaving out this parameter or setting it to
anything but YES will cause no PRJ file to be generated.
- GRID_TYPE_CELL_SIZE - specifies that the export should be gridded
into multiple tiles with each tile having the given size in the export
projection. The value should be specified as cell width,cell
height. For example, if you are exporting in a metric projection and want
to tile the export into cells that are 10,000 meters wide by 5,000 meters
tall, you would use GRID_TYPE_CELL_SIZE="10000.0,5000.0".
- GRID_TYPE_ROWS_COLS - specifies that the export should be gridded
into multiple tiles with a given number of rows and columns of tiles. The
value should be specified as number of rows,number of columns.
For example, if you want to tile the export into a grid of 8 rows each 4 tiles
across, you would use GRID_TYPE_ROWS_COLS="8,4".
- GRID_OVERLAP - specifies how much to overlap tiles when gridding an
export into multiple tiles. This is a percentage value from 0 to 100 and only
applies when on of the GRID_TYPE_* parameters is used. For example, to make
your grid tiles overlap by 5% of the grid tile size, use GRID_OVERLAP="5.0".
The default value is 0.0, meaning that the tiles do not overlap.
- GRID_NAMING - specifies how to name tiles when gridding an
export into multiple tiles. The value should be SEQUENTIAL for sequential numeric naming
starting at 1, SEPARATE for separate prefix appending by row and column, or
SEPARATE_COLS_FIRST for separate prefix appending by columns and rows. For the
SEPARATE options, use the GRID_NAMING_COLS and GRID_NAMING_ROWS parameters to specify
the details of how to name the rows and columns. If no GRID_NAMING parameter is supplied,
the last selected grid naming options selected in the user interface will be used.
- GRID_NAMING_COLS - specifies how to name the column
portion of grid cell names when using the GRID_NAMING=SEPARATE or
GRID_NAMING=SEPARATE_COLS_FIRST parameter. The value of
this field is a comma-delimited list with the following field values:
- Naming type. Can have the following values:
- NUM - name using numbers in ascending order
- NUM_REVERSE - name using numbers in descending order
- ALPHA - name using letters in ascending order
- ALPHA_REVERSE - name using letters in descending order
- Starting value for numbering or lettering (i.e. '1', or 'A').
- Prefix string to use before the numeric or alphabetic value.
- Step value for numeric naming (default is '1')
You can leave values blank if they don't apply or you want to use the default. As an
example, to do numeric naming starting at the number 100, increasing by 10 each time
with a prefix of DEM, you would use GRID_NAMING_COLS="NUM,100,DEM,10".
- GRID_NAMING_ROWS - specifies how to name the row
portion of grid cell names when using the GRID_NAMING=SEPARATE parameter. See the
documentation for the GRID_NAMING_COLS parameter above for details on the format.
- GRID_NAMING_PREPEND_ZEROES - specifies whether or not
to prepend zeroes to the start of grid column/row names. Use GRID_NAMING_PREPEND_ZEROES=NO to
disable the prepending of zeroes.
- GRID_NAMING_SEPARATOR - specifies the separator string to use
between pieces of a grid name. The default is an underscore.
- GRID_CREATE_FOLDERS - specifies that a separate folder should
be generated for each row (or column if GRID_NAMING=SEPARATE_COLS_FIRST is specified) of the export
rather than placing every output file in the same folder.
- GEN_3D_FEATURES (DGN and SHAPEFILE only) - specifies that 3D line
and point objects should be created in the exported file. Set this to YES to cause
the the 3D features to be generated. Leaving out this parameter
or setting it to anything but YES results in the normal 2D objects. The
elevation stored for each vertex/point will be the first of the following that
is available:
- The elevation associated with the vertex/point in question.
- The elevation associated with the entire area/line/point being exported. For
example, the elevation of a contour line or spot elevation.
- The first elevation obtained by searching the loaded elevation layers at
the position of the vertex/point.
A value of 0.0 will be used if no elevation could be obtained via any of the prior methods.
- COORD_DELIM (SIMPLE_ASCII only) - specifies the delimeter
between coordinates in coordinate lines
- COMMA - coordinates are separated by commas
- SEMICOLON - coordinates are separated by semicolons
- SPACE - coordinates are separated by space characters
- TAB - coordinates are separated by tab characters
- FEATURE_SEP (SIMPLE_ASCII only) - specifies whether or not
to separate vector features with a blank line
- NONE - do not separate vector features
- BLANK_LINE - separate vector features with a blank line
- Any other text. Use the escape sequence \n to specify that you want to insert a
line break. For example, to separate features with a blank line, then a line with
the text "NEW FEATURE", then another blank line, use
FEATURE_SEP="\nNEW FEATURE\n".
- EXPORT_ELEV (SIMPLE_ASCII, CSV, and DXF only) - specifies whether or not a
elevation value should be generated for each vertex. A value of
EXPORT_ELEV=YES will cause elevations to be generated. If the option is not
specified, elevation values will be generated.
- EXPORT_ATTRS (DGN and SIMPLE_ASCII only) - specifies whether or not
feature attributes should be written to the text file just before the
coordinates. Use EXPORT_ATTRS=YES to enable export of the feature attributes.
If the option is not specified, attributes will be exported. If you don't want to
export style attribute with the feature, use EXPORT_ATTRS=NO_STYLE to get just
the associated attributes and name of the feature in the attribute list.
- COORD_OFFSET (SIMPLE_ASCII only) - specifies the offset to
apply to any coordinates written to the file. This offset will be added to
each coordinate written to the file. The offset should be specified as a
comma-delimited list of the X, Y, and Z offsets, such as
COORD_OFFSET=100000.0,200000.0,0.0
- COORD_SCALE (SIMPLE_ASCII only) - specifies the scale
factors to apply to any coordinates written to the file. Each coordinate will
be multiplied by these scale factor before being written to the file. The
scale factors should be specified as a comma-delimited list of the X, Y, and Z
scale factors, such as COORD_SCALE=0.1,0.1,1.0
- CDF_MAJOR_CODE (CDF only) - specifies the default major
attribute code to use for features when exporting to a CDF format file
(default is 32).
- CDF_MINOR_CODE (CDF only) - specifies the default minor
attribute code to use for features when exporting to a CDF format file
(default is 45).
- CDF_USE_DEFAULT_CODE (CDF only) - specifies that the default
attribute code pair should be used for all features written to the CDF file
and not just those for which no attribute code pair could be automatically
determined based on the feature classification.
- INC_ELEV_ATTR (MAPINFO only) - specifies whether or not
the elevation of a feature should be added as an attribute to the
MapInfo files exported. Use INC_ELEV_ATTR=YES to enable or
INC_ELEV_ATTR=NO to disable. This is enabled by default.
- INC_LAYER_ATTR (SHAPEFILE, MAPINFO, or KML only) - specifies whether or not
the layer (description) of a feature should be added as an attribute to the
DBF files exported with the Shapefile or for KML files whether or not displays labels
should be exported for line and area features. Use INC_LAYER_ATTR=YES to enable or
INC_LAYER_ATTR=NO to disable. This is enabled by default for Shapefile and MapInfo exports and
disabled by KML.
- INC_MAP_NAME_ATTR (SHAPEFILE only) - specifies whether or not
the name of the map file that a feature came from should be added as an attribute to the
DBF files exported with the Shapefile. Use INC_MAP_NAME_ATTR=YES to enable.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the export should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be exported will be used
as the crop polygon (see POLYGON_CROP_USE_ALL and POLYGON_CROP_USE_EACH for exceptions).
Note that line and area features will only be cropped to
the bounds of the specified polygon. Point features from some formats will
actually be cropped to the specified polygon boundary.
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the export is being done in.
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the export will
be cropped to all polygons in that file rather than just the best-fit polygon.
- MAP_NAME (POLISH_MP only) - specifies the map name for the
MP file.
- POLYGON_CROP_USE_EACH - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
generate a separate export for each polygons in that file rather than just the best-fit polygon.
See the POLYGON_CROP_BBOX_ONLY and POLYGON_CROP_NAME_ATTR options for naming and other
options when using this parameter. Use POLYGON_CROP_USE_EACH=YES to enable.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
- POLYGON_CROP_NAME_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use for
naming, or the special values <Area Display Label> or <Area Source Filename>.
If no value is provided, the exported files will be sequentially numbered.
- POLYGON_CROP_FOLDER_ATTR - used to control the filenames
generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter.
This should be the actual name of the attribute from the polygon features to use as a
folder name before the actual filename or the special values <Area Display Label>.
- TEMPLATE_FILENAME (POLISH_MP only) - specifies the full path
and filename for another MP file to use for the settings for the new MP file
being exported.
- MP_EXPORT_TEMPLATE_FILES (POLISH_MP only) - if a
TEMPLATE_FILENAME value is provided, this controls whether or not the [FILES]
section(s) from the template file will be copied to the new file.
- MP_COPY_ENTIRE_TEMPLATE (POLISH_MP only) -
specifies that the entire contents of a specified template file should be copied to
the new file rather than just the header portion of the template file.
- MP_IMAGE_ID (POLISH_MP only) - specifies the image ID value
that should be stored in the resultant .mp file. If you don't specify this
value or you specify a value of 0 a new value that has not been used before
will automatically be generated.
- DGN_UNIT_RESOLUTION (DGN only) - specifies
the unit resolution to use in an exported DGN file. The default is 10000.0.
- DGN_GLOBAL_ORIGIN_LL (DGN only) - specifies
whether the global origin of the exported DGN file should be set to the lower left
of the design plane rather than at the center of the design plane. Use
DGN_GLOBAL_ORIGIN_LL=YES to move the global origin to the lower left.
- DGN_REPLACE_DARK_COLORS (DGN only) - specifies
whether the color of dark lines should automatically be replaced with white
on export to make them more visible on a dark background. Use DGN_REPLACE_DARK_COLORS=YES
to enable this option.
- OVERWRITE_EXISTING - specifies that existing files should be
overwritten. The default is OVERWRITE_EXISTING=YES, so use
OVERWRITE_EXISTING=NO to skip exporting files that already exist.
- SPLIT_BY_LAYER (SHAPEFILE only) - specifies that
the export should generate a separate Shapefile for each layer/type in the input data
- SPLIT_BY_ATTR - specifies that the export should generate a
separate file for each set of attributes values in the input data. Use the FILENAME_ATTR and/or FILENAME_ATTR_LIST
and FILENAME_INCLUDE_ATTR_NAME parameters to control which attributes are compared to and in what order
and how the filename is generated from those attributes and their values.
Use SPLIT_BY_ATTR=YES to split your export so that all features with the same values for each
of the specified attributes is in the same file.
- FILENAME_ATTR_LIST - contains a comma-delimited list of
attributes to use when naming files exported when using the SPLIT_BY_ATTR=YES parameter. If
you would like to filter the results to only where an attribute has a specified value, do that
with an equal sign, like FILENAME_ATTR_LIST="<Feature Name>=My Label,ATTR_1=My Attr Val".
You can also use != rather than = to match on any feature with an attribute value not equal to
the specified value. If you need to match on a value that may contain a comma, use FILENAME_ATTR
instead.
- FILENAME_ATTR - contains a single attribute to use when naming files
exported when using the SPLIT_BY_ATTR=YES parameter. If you would like to filter the results to only
where an attribute has a specified value, do that with an equal sign, like FILENAME_ATTR="<Feature Name>=My Label".
You can also use != rather than = to match on any feature with an attribute value not equal to
the specified value.
- FILENAME_INCLUDE_ATTR_NAME - specifies that the attribute name
specified in the FILENAME_ATTR_LIST parameter should be included as part of the filename when
using SPLIT_BY_ATTR=YES to split your export into a separate file for each set of attributes.
- KML_AREA_DISPLAY_ABOVE_TERRAIN (KML only) - specifies
that area features with associated elevation value should be displayed at height above
the terrain surface in Google Earth. Use KML_AREA_DISPLAY_ABOVE_TERRAIN=YES to enable.
- KML_AREA_ELEVS_RELATIVE (KML only) - specifies
that the elevation values associated with 3D area features are relative to the terrain surface
rather than relative to sea level. Use KML_AREA_ELEVS_RELATIVE=YES to enable.
- KML_AREA_EXTRUDE (KML only) - specifies
that 3D area features displayed in Google Earth should be extruded from the surface to create
volumetric objects like buildings. Use KML_AREA_EXTRUDE=YES to enable.
- KML_AREA_FAKE_HEIGHTS (KML only) - specifies that
fake elevation values should be assigned to area features exported to ensure that the
draw order remains correct in Google Earth. This may be necessary to keep overlapping area
features drawing correctly. Use KML_AREA_FAKE_HEIGHTS=YES to enable.
- KML_AREA_TRANSLUCENCY (KML only) - specifies how
see-through filled area features will be in the generated KML file. The values should range
from 1 to 100 and represent a opacity percentage, with 100 being completely opaque and 1
being almost completely transparent. The default value is KML_AREA_TRANSLUCENCY=75.
- KML_FOLDER_ATTR (KML only) - specifies
the name of a feature attribute to use for the folder name in the generated KML file. By default,
the export will check for a KML_FOLDER attribute with the name of a folder to use.
- KML_HTML_DESC_TEXT (KML only) - specifies
a HTML text string describing what to use for the description for each feature exported to
a KML file. To add a quote mark inside your description text, use two single quotes ('') rather than a
double quote ("), as the latter would terminate the parameter value.
- KML_LINE_DISPLAY_ABOVE_TERRAIN (KML only) - specifies
that LINE features with associated elevation value should be displayed at height above
the terrain surface in Google Earth. Use KML_LINE_DISPLAY_ABOVE_TERRAIN=YES to enable.
- KML_LINE_ELEVS_RELATIVE (KML only) - specifies
that the elevation values associated with 3D line features are relative to the terrain surface
rather than relative to sea level. Use KML_LINE_ELEVS_RELATIVE=YES to enable.
- KML_POINT_DISPLAY_ABOVE_TERRAIN (KML only) - specifies
that point features with associated elevation value should be displayed at height above
the terrain surface in Google Earth. Use KML_POINT_DISPLAY_ABOVE_TERRAIN=YES to enable.
- KML_POINT_ELEVS_RELATIVE (KML only) - specifies
that the elevation values associated with 3D Point features are relative to the terrain surface
rather than relative to sea level. Use KML_POINT_ELEVS_RELATIVE=YES to enable.
- KML_POINT_EXTRUDE (KML only) - specifies
that 3D point features displayed in Google Earth should be extruded from the surface by drawing
a thin line from the surface to the point. Use KML_POINT_EXTRUDE=YES to enable.
- GEN_MULTI_PATCH (SHAPEFILE only) - specifies that area
features exported to a Shapefile should be stored as multi-patch features rather than areas.
Use GEN_MULTI_PATCH=YES to enable.
- ADD_LAT_LON (CSV only) - specifies that lat/lon columns
should be added to a CSV export. Use ADD_LAT_LON=YES to enable.
- EXPORT_HEADER (CSV only) - specifies whether or not the
header line for CSV files should be written. Enabled by default, use EXPORT_HEADER=NO to disable.
- VERSION (LOWRANCE_USR only) - specifies which version of
USR file to create. Must be 3 or 4. By default VERSION=3 is used.
FORCE_EXIT
The FORCE_EXIT command immediately shuts down Global Mapper without going through the normal shut-down
process. This is useful if you are running a Global Mapper script via a CreateProcess call and the Global Mapper
process is not returning when the script completes, or if you need a particular return code provided. The following
parameters are supported by this command:
- RETURN_CODE - specifies the numeric return code to use. If not provided 0 is
returned if the script did not encounter any errors or 1 if there were errors encountered.
GENERATE_CONTOURS
The GENERATE_CONTOURS command allows for the generation of contour lines
(isolines of equal elevation) from any or all currently loaded elevation data.
The following parameters are supported by the command.
- ELEV_UNITS - specify elevation units to use in export
- FEET - export in US feet
- METERS - export in meters
- INTERVAL - specifies the contour interval to use. This must be a
whole number greater than 0. The units are specified with the ELEV_UNITS
parameter described above. If you wanted to generate a contour file with an
interval of 20 feet, you would use INTERVAL=20 ELEV_UNITS=FEET in the
parameter list. If no interval is provided, a default one is guessed based on
the elevation range of the loaded elevation data.
- MIN_ELEV - minimum elevation to consider for contours. Must be specified
in conjunction with MAX_ELEV in order to restrict the range of contour generation to anything other than
the full range of loaded elevation values.
- MAX_ELEV - maximum elevation to consider for contours. Must be specified
in conjunction with MIN_ELEV in order to restrict the range of contour generation to anything other than
the full range of loaded elevation values.
- SPATIAL_RES - specifies spacing of grid points used to determine
contour position. A smaller grid spacing results in higher fidelity, but
larger, contours. Typically you'll want to use the default value which is the
minimum spatial resolution of all loaded data. Should be formatted as
x_resolution,y_resolution. The units are the units of the current global
projection. For example, if UTM was the current global projection and you
wanted to use a grid with a 30 meter spacing, the parameter/value pair would
look like SPATIAL_RES=30.0,30.0.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- GLOBAL_BOUNDS - specifies the contour bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the contour bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the contour bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the contour generation should use the
bounds of the loaded layer(s) with the given filename. For example, to
generate contours to the bounds of the file "c:\test.tif", you would use
LAYER_BOUNDS="c:\test.tif". Keep in mind that the file must be currently
loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- SIMPLIFICATION - specifies the simplification threshold to use when
generating the contours. This specifies how far off a straight line (in the
units of the current projection) that a point has to be before it is kept.
Generally you should not specify a simplification value as the default value
of one tenth of the sample spacing works quite well. This is an option for advanced
users only.
- GEN_HEIGHT_AREAS - generate area features colored based on the
current elevation shader in addition to generating contour lines. Use a value
of YES to enable the generate of the height areas.
- GEN_SPOT_ELEVATIONS - generate spot elevations at min/max
elevations. Use a value of YES to enable the generate of min/max spot
elevation points.
- SINGLE_LEVEL_ONLY - specifies that the INTERVAL value is actually a
value indicating the only height that a contour should be generated at. Use a
value of YES to turn this functionality on.
- FILL_GAPS - specifies that small gaps in between and within the
data sets being used to generate the contours will be filled in by
interpolating the surrounding data to come up with an elevation for the point
in question. This option is on by default, specify FILL_GAPS=NO to turn off.
- LAYER_DESC - specifies the name to assign to this layer. If no
layer description is provided, the default name of "GENERATED CONTOURS" will
be used.
- INC_UNIT_SUFFIX - specifies whether or not a unit suffix (either
"m" or "ft") should be appended to the numeric label of generated features. By
default this is enabled, so specify INC_UNIT_SUFFIX=NO to turn unit suffixes
off. This is useful if the data the contours are being generated over doesn't
actually represent elevation.
- SMOOTH_CONTOURS - specifies whether or not generated contour line
and area features should have smoothing applied to improve appearance. This
option is enabled by dfault. Use SMOOTH_CONTOURS=NO to disable smoothing.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the operation should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be combined will be used
as the crop polygon (see POLYGON_CROP_USE_ALL or POLYGON_CROP_USE_EACH for exceptions).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the new terrain layer will be in (i.e. the current projection).
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
GENERATE_ELEV_GRID
The GENERATE_ELEV_GRID command allows for the generation of a gridded elevation layer
using loaded 3D vector data. The following parameters are supported by the command as well
as the display option paramters supported by the IMPORT command.
- ELEV_UNITS - specify elevation units to use for new grid
- FEET - US feet
- DECIFEET - 10ths of US feet
- METERS - meters
- DECIMETERS - 10ths of meters
- CENTIMETERS - centimeters
- SPATIAL_RES - specifies spacing of grid points to use
in generated grid. A smaller grid spacing results in higher fidelity, but
larger, elevation grids. Should be formatted as x_resolution,y_resolution.
The units are the units of the current global projection. For example, if
UTM was the current global projection and you wanted to use a grid with a 30
meter spacing, the parameter/value pair would look like SPATIAL_RES=30.0,30.0.
If you do not provide a SPATIAL_RES value, a good default for the input data will
be chosen, so in most cases it is best just to leave this off.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- GLOBAL_BOUNDS - specifies the grid bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the grid bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the grid bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the grid generation should use the
bounds of the loaded layer(s) with the given filename. For example, to
generate contours to the bounds of the file "c:\test.tif", you would use
LAYER_BOUNDS="c:\test.tif". Keep in mind that the file must be currently
loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- LAYER_DESC - specifies the name to assign to this layer. If no
layer description is provided, a default name will be assigned.
- NO_DATA_DIST_MULT - specifies how far from an actual data point a
grid cell has to be before it is treated as a no data value. This number is
given as a multiple of the diagonal size of a single grid cell as nominally
determined by the gridding algorithm or specified with the SPATIAL_RES parameter.
A value of 0 (the default) means that all points should be considered as valid.
- GRID_FILL_TO_BOUNDS - specifies that the grid values should
be filled out to the entire bounds of the gridded data rather than just to the convex
hull of the data being gridded. Use GRID_FILL_TO_BOUNDS=YES to enable this.
- GRID_FLATTEN_AREAS - specifies that area features with
elevation values should be flattened to the elevation of the area features.
Use GRID_FLATTEN_AREAS=NO to disable this.
- GRID_HEIGHTS_RELATIVE - specifies that the elevation
values for the input vector features should be treated as relative to any loaded
terrain data rather than as absolute elevation values. This useful for things like trees
or buildings where you have a height above the ground rather than an absolute height.
Use GRID_HEIGHTS_RELATIVE=YES to enable this.
- GRID_SAVE_TIN - specifies that the triangulated
irregular network (TIN) for the grid operation should be saved as a new separate
vector layer consisting of triangular 3D area features. Use GRID_SAVE_TIN=YES to
enable this.
- GRID_USE_CONSTRAINTS - specifies that 3D line and area
features should be treated as constraints (breaklines) during the gridding process.
Use GRID_USE_CONSTRAINTS to enable this.
- GRID_IGNORE_ZERO - specifies that features with an
elevation of 0.0 will not be used during the gridding process.
GENERATE_EQUAL_VAL_AREAS
The GENERATE_EQUAL_VAL_AREAS command allows for the generation of areas for regions of the same
(or similar) color or elevation values fro a loaded raster or elevation layer.
- FILENAME - specifies the filename of the already loaded
layer from which to generate the equal-value areas.
- LAYER_DESC - specifies the description to use for the layer
- ATTR_NAME - specifies the name to use for the attribute
holding the color or elevation that a particular area represents. If you leave this
attribute off then no value attribute will be saved with each area.
- AREA_TYPE - specifies the name of the area type to
assign to the area features. See the Area Styles tab of the Configuration dialog for
a list of available type names.
- COLOR_DIST - specifies how far from an exact match each
color channel of a color value must be to be considered the same. By default a value of
0 is used which means exact matches only. If you want to break the entire color range into
say 4 ranges for each color channel, use something like COLOR_DIST=32 as that would allow
colors up to 32 away from each color channel value to match to a color.
- ELEV_DIST - specifies how far from an exact match (in meters) each
value must be to be considered the same. By default a value of 0 is used which means exact matches
only. If you want to say split into area groups 10 meters in size, use ELEV_DIST=5. This would give
you areas with values between -5 and 5 meters, 5 and 15 meters, etc.
- FORCE_RGB - specifies that the attribute value for a color-based area will
always be the full RGB color and not a palette index/name if available. Use FORCE_RGB=YES to enable.
- GLOBAL_BOUNDS - specifies the bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the area generation should use the
bounds of the loaded layer(s) with the given filename. For example, to
generate contours to the bounds of the file "c:\test.tif", you would use
LAYER_BOUNDS="c:\test.tif". Keep in mind that the file must be currently
loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
SAMPLE:
This sample will generate equal-elevation areas of size 20 meters (10 meters on either side) from the specified
DEM layer and store the elevation values in an attribute named ELEV for each area feature.
GENERATE_EQUAL_VAL_AREAS FILENAME="C:\temp\export test\blue_springs_4_quads.dem" ELEV_DIST=10.0 ATTR_NAME="ELEV"
GENERATE_LAYER_BOUNDS
The GENERATE_LAYER_BOUNDS command create a new layer with a single bounding box area created
from the bounding box of each loaded layer.
- LAYER_DESC - specifies the description to use the for created layer
GENERATE_PATH_PROFILE
The GENERATE_PATH_PROFILE command allows for the saving of a 3D path profile
to an ASCII XYZ file. This command uses loaded elevation data to generate a list
of the 3D coordinates between two given points in the given elevation units. The
following parameters are supported by the command.
- FILENAME - full path to XYZ ASCII file to save the data to
- ELEV_UNITS - specify elevation units to use in export
- FEET - export in US feet
- METERS - export in meters
- POINT_COUNT - specifies the number of points to generate in the
path. This must be at least two. For example, to create 1000 points, use
POINT_COUNT=1000. You can use the POINT_SPACING parameter rather than this to
specify how far apart sample points should be.
- POINT_SPACING - specifies the point spacing in meters to use
between sample points along the path. For example, to create points spaced 10
meters apart, use POINT_SPACING=10.0.
- START_POS - specifies the start position for the path profile. The
coordinates must be given in the current global coordinate system. For
example, if UTM if the current projection, you might specify and
easting/northing as follows: START_POS=480000,4310000.
- END_POS - specifies the end position for the path profile. The
coordinates must be given in the current global coordinate system. For
example, if UTM if the current projection, you might specify and
easting/northing as follows: START_POS=480000,4310000.
- ADD_LAND_USE_CODES - specifies whether to query loaded LULC data
sets for the land use code at each point and to include that land use code
after the elevation. Use ADD_LAND_USE_CODES=YES to turn on adding land use
codes for each point.
- APPEND_TO_FILE - specifies that the elevations between the start
and end locations should be appended to the file specified if it already
exists rather than a new file being created
- SAVE_DIST_Z_FILE - specifies that the output file should contain
distance and elevation values rather than XYZ coordinate values. Use
SAVE_DIST_Z_FILE=YES to enable this option.
GLOBAL_MAPPER_SCRIPT
The GLOBAL_MAPPER_SCRIPT must be the first command in the file. The only
parameter supported is the VERSION parameter. Typically, the entire command line
will look like:
GLOBAL_MAPPER_SCRIPT VERSION=1.00
You can use the following parameters with this command:
- VERSION - specifies the version of the scripting language used.
This parameter is required. You should always use VERSION=1.00.
- ENABLE_PROGRESS - specifies whether or not any progress dialogs
should be displayed while this script is processing. This is enabled by
default. Use ENABLE_PROGRESS=NO to disable the display of any progress dialogs
during the processing of this script.
- REQUIRE_WORKSPACE - name of workspace file that is required to be
loaded for this script to run. If a name is provided for this parameter and
that workspace is not currently loaded into Global Mapper, the script will
immediately abort. This can be used if you have different scripts that you
only want to use if other workspaces are active and want to prevent
accidentally selecting the wrong script.
GENERATE_REPORT
The GENERATE_REPORT command allows you to generate a CSV text report file on the data in one or more
loaded layers broken down by a particular attribute value, feature name, or type, or
just a single line report about all features. The report will include the count of area, line, and
point features matching the specified criteria as well as the total combined length of the line
features and combined covered area of the area features.
The following parameters are supported by the command:
- OUTPUT_FILENAME - specifies the name of the text .csv
file to write the report results to.
- FILENAME - filename of the layer to generate the report for.
If an empty value is passed in, all layers that were created by the script,
such as those from a GENERATE_CONTOURS command, will be used to generate the report. You can also
pass in the value 'USER CREATED FEATURES' when running a script in the context
of the main map view or loading a workspace to have the 'User Created Features' layer
be used. If no FILENAME parameter is provided, the report will cover all available
vector layers.
- REPORT_ATTR - specifies what to use to divide up the
report into categories. This can be an attribute name, or if you would like
to compare against a feature label rather than an attribute, use <Feature Name>.
To compare against a feature type name rather than an
attribute, use <Feature Type> for your attribute name. To compare against the
feature description, use <Feature Desc> for your attribute name. If no
REPORT_ATTR parameter is provided or the value is empty, only a single line concerning
all matching features will be generated in the report.
- COMPARE_STR - specifies a comparison operation to
perform to see if a feature is one that needs to be included in the report. The format is
attr_name=attr_value. For example if you have an attribute named CFCC and you want to
match when the value of that attribute starts with an 'A', you can use
COMPARE_STR="CFCC=A*" as your parameter. You can add multiple COMPARE_STR parameters
to a single command to combine multiple criteria for your search. If you would like
to compare against a feature label rather than an attribute, use <Feature Name>
for your attribute name. To compare against a feature type name rather than an
attribute, use <Feature Type> for your attribute name. To compare against the
feature description, use <Feature Desc> for your attribute name.
- CASE_SENSITIVE - specifies whether or not text
comparisons are case sensitive or not. Use CASE_SENSITIVE=YES to enable, by default
comparisons are not case sensitive.
GENERATE_WATERSHED
The GENERATE_WATERSHED command allows for the generation of a watershed, including
stream flow and optionally watershed areas for each stream segment.
The following parameters are supported by the command.
- STREAM_THRESHOLD - specifies the number of cells that have to
drain to a particular location before that location is considered to be part of the stream
network.
- MAX_DEPTH - specifies the maximum depression depth (in meters) that will
be filled prior to calculating the watershed. This is needed to prepare a terrain surface for flow analysis
so that a continuous flow can be found. Note that while using a large MAX_DEPTH value may generate better
results, it could also cause the process to take a lot longer.
- GEN_AREAS - generate watershed area features for each found
stream segment outlining the area that drains into that stream. Enabled by default,
use GEN_AREAS=NO to disable.
- SMOOTH_STREAMS - specifies whether or not generated streams
should have smoothing applied to improve appearance. This option is enabled by default.
Use SMOOTH_STREAMS=NO to disable smoothing.
- SPATIAL_RES - specifies spacing of grid points used to calculate
the watershed. A smaller grid spacing results in higher fidelity, but the calculation process
will take longer. Typically you'll want to use the default value which is the
minimum spatial resolution of all loaded data. Should be formatted as
x_resolution,y_resolution. The units are the units of the current global
projection. For example, if UTM was the current global projection and you
wanted to use a grid with a 30 meter spacing, the parameter/value pair would
look like SPATIAL_RES=30.0,30.0.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- GLOBAL_BOUNDS - specifies the contour bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the contour bounds in units of the
current global projection. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of minimum x,
minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the contour bounds in latitude/longitude
degrees. There should be 4 values in a comma-delimited list following the
parameter name. The values should be in order of westmost longitude,
southernmost latitude, easternmost longitude, northernmost latitude.
- LAYER_BOUNDS - specifies that the contour generation should use the
bounds of the loaded layer(s) with the given filename. For example, to
generate contours to the bounds of the file "c:\test.tif", you would use
LAYER_BOUNDS="c:\test.tif". Keep in mind that the file must be currently
loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- FILL_GAPS - specifies that small gaps in between and within the
data sets being used to generate the watershed will be filled in by
interpolating the surrounding data to come up with an elevation for the point
in question. This option is on by default, specify FILL_GAPS=NO to turn off.
- LAYER_DESC - specifies the name to assign to this layer. If no
layer description is provided, the default name of "GENERATED WATERSHED" will
be used.
- POLYGON_CROP_FILE - specifies the full path and filename of a
vector file containing a polygon feature to which the operation should be
cropped. If multiple polygons are found in the specified file the polygon
which has the largest intersection with the data to be combined will be used
as the crop polygon (see POLYGON_CROP_USE_ALL or POLYGON_CROP_USE_EACH for exceptions).
- POLYGON_CROP_NAME - specifies the name of a polygon shape
previously defined using the DEFINE_SHAPE command to which
the export should be cropped. The coordinates in the shape need to have been provided
in whatever projection the new terrain layer will be in (i.e. the current projection).
- POLYGON_CROP_USE_ALL - specifies that if
a POLYGON_CROP_FILE is specified that contains multiple polygons, the operation will
be cropped to all polygons in that file rather than just the best-fit polygon.
- POLYGON_CROP_BBOX_ONLY - specifies that if
the POLYGON_CROP_USE_EACH parameter is specified that each export should just be cropped
to the bounding box of each polygon rather than the actual boundary of the polygon.
Use POLYGON_CROP_BBOX_ONLY=YES to enable only cropping to the bounding box.
IMPORT
The IMPORT command imports a data file for later use. The following
parameters are supported by the command.
- FILENAME - full path to file to load the data from.
This can also be the URL (http: or ftp:) for a file on a web site that you want Global Mapper to
download and load.
- TYPE - type of data file we're loading
- AUTO - automatically determine the type (default).
- ACE - Altimetry Corrected Elevation (ACE) format file.
- ARCASCIIGRID - Arc ASCII Grid format file.
- ARCBINARYGRID - Arc Binary Grid format file.
- AVC - Arc Vector Coverage format file.
- BIL - BIL format file.
- BSB - BSB format file (usually has .KAP extension).
- BT - a BT (Binary Terrain) format grid file.
- CANADA3D - Canada 3D format file.
- COMPEGPS - a CompeGPS RTE, TRK, or WPT file.
- CTM_DEM - a CTM DEM format file.
- DBF - DBase file with point features.
- DHM25 - a Swiss DHM terrain format file.
- DLGO - USGS DLG-O
- DGN - MicroStation DGN files earlier than v8.
- DIVAGIS_GRID - a DIVA GIS grid format file.
- DMDF - a Digital Map Data Format (DMDF) format file.
- DOQQ - USGS DOQ in JPEG format.
- DTED - Digital Terrain Elevation Data (DTED) format.
- DXF - DXF format.
- ECW - ER Mapper Compressed Wavelet (ECW) format file.
- EMF - a Windows Enhanced Metafile (EMF) format file.
- ENVI DEM - ENVI DEM format file.
- ERDAS - Erdas Imagine format file.
- ERDAS_GIS - Erdas GIS format file.
- ERM_GRID - ERM grid format file.
- ESRI_PGEO - ESRI personal geodatabase format file.
- ETOPO2 - ETOPO2 format file.
- FAST_L7A - a Landsat FAST L7A format file.
- FILE_GDB - an ESRI File Geodatabase
- FLOATGRID - FLOAT/GRID format file.
- GEOSOFT_GRID - a Geosoft Binary Grid format file.
- GEOTIFF - GeoTIFF format file.
- GIF - a GIF format file with associated world file.
- GLOBAL_MAPPER_CATALOG - a Global Mapper Map Catalog file.
- GLOBAL_MAPPER_GRID - a Global Mapper Grid format file.
- GML - a GML format file.
- GNIS - Geographics Names Information Service (GNIS) file
- GPS_TRACKMAKER - a GPS TrackMaker format file.
- GXF - Geosoft Grid ASCII (GXF) file
- GPX - GPS eXchange Format file
- HDF - an HDF format raster or grid file, like ASTER DEM or ASTER VNIR
imagery.
- HELAVA_DEM - a Helava DEM file
- HYPACK_MATRIX - a Hypack Matrix format file.
- IBCAO - Arctic bathymetry in NetCDF format.
- IDRISI_RASTER - Idrisi raster/elevation format file.
- INTERGRAPH_COT - Intergraph COT format file.
- JDEM - a Japanese DEM .mem file.
- JPEG - a JPEG file with an associated world file.
- JPEG2000 - a JPEG 2000 file
- KML - a KML/KMZ file.
- LIDAR_LAS - a LAS file with LIDAR data.
- LOWRANCE_USR - a Lowrance USR format file.
- LULC - USGS Land Use and Land Cover vector data file.
- MAPINFO - a MapInfo MIF/MID of TAB/MAP vector data collection.
- MAPMAKERTERRAIN - a MapMaker terrain file
- MARPLOT_MIE - a MarPlot MIE format file.
- MAPTECH - a MapTech BSB, Topo, or Aerial format file.
- MICRODEM_DEM - a MicroDEM-created DEM file
- MICROPATH_DEM - a Micropath DEM file
- MRSID - a LizardTech MrSID image file.
- NetCDF - a NetCDF format file.
- NIMA_GNS - a NIMA GNS format file.
- NITF - NITF format imagery
- NOS_GEO - a NOS/GEO format chart file.
- NTF_GRID - a NTF grid format file.
- OPTIMI_GRID - an Optimi terrain or clutter grid format file.
- OZI - an OziExplorer format waypoint (WPT) or track (PLT) file.
- PCX - a PC Paintbrush PCX format file.
- PCX5 - a Garmin PCX5 format waypoint (WPT) or track (TRK) file.
- ROCKWORKS_GRID - a RockWorks Grid format file.
- RPF - Raster Product Format database, like CADRG.
- RPF_FRAME - single frame from a Raster Product Format database, like
CADRG.
- S57 - a S-57 chart file
- SDTS - a SDTS transfer
- SEGP1 - a SEGP1 seismic shotpoint file.
- SHAPEFILE - an ESRI Shapefile.
- SURFERGRID - a Surfer grid format file.
- SWEDISHDEMGRID - a Swedish DEM grid format file.
- TERRASCAN - a TerraScan LIDAR format file.
- TIGER_LINE - a Tiger/Line format file.
- USGS_DEM - a native format USGS DEM file.
- VPF - a Vector Product Format file such as VMAP or DNC data
- VULCAN_3D - a Vulcan3D triangulation file
- ZMAP_PLUS - a Geographix Zmap Plus+ format file.
- PROMPT_IF_TYPE_UNKNOWN - set to NO if you don't want the user
to be prompted to select a file type if the type cannot automatically be determined (useful when looping).
- HIDDEN - set to YES to cause this overlay to be hidden from view
after it is loaded. The default is to show the overlay.
- SAMPLING_METHOD (elevation and raster only) - specifies the sampling
method to use when resampling this layer. The following values are supported:
- NEAREST_NEIGHBOR - use the nearest neighbor sampling method
- BILINEAR - use bilinear interpolation
- BICUBIC - use bicubic interpolation
- BOX_3X3 - use a 3x3 box average
- BOX_4X4 - use a 4x4 box average
- BOX_5X5 - use a 5x5 box average
- BOX_7X7 - use a 7x7 box average
- BOX_9X9 - use a 9x9 box average
- MAX_3X3 - (terrain layers only) use maximum value found in 3x3 box
- MAX_4X4 - (terrain layers only) use maximum value found in 4x4 box
- MAX_5X5 - (terrain layers only) use maximum value found in 5x5 box
- MAX_7X7 - (terrain layers only) use maximum value found in 7x7 box
- MAX_9X9 - (terrain layers only) use maximum value found in 9x9 box
- ANTI_ALIAS [DEPRECATED - use SAMPLING_METHOD instead] (elevation and raster only) - specifies whether to
remove jagged edges by making a subtle transition between pixels. Turning off
this option helps maintain the hard edges of the pixels as they are
rasterized. Use ANTI_ALIAS=YES to turn on. Anything else turns it off.
- CONTRAST_MODE (raster only) - specifies the type of contrast
adjustment to apply to the data.
- NONE - no contrast adjustment applied (this is the default)
- PERCENTAGE - apply a percentage contrast adjustment. The
CONTRAST_STRETCH_SIZE parameter can be used to override the number of
standard deviations from the mean to stretch to.
- MIN_MAX - apply a min/max contrast stretch, stretching the available
range of values in each color band to the full range of 0-255. For imagery
which contains both black and white, this will have no affect.
- CONTRAST_SHARED (raster only) - specified whether or not
the contrast adjustment for this layer will share the adjustment with other contrast-adjusted
layers in order to ensure a consistent modification across layers. Use CONTRAST_SHARED=YES
to enable contrast sharing.
- CONTRAST_STRETCH_SIZE (raster only) - specifies the number of
standard deviations from the mean to use in a PERCENTAGE contrast adjustment.
The default is 2.0.
- AUTO_CONTRAST (raster only) - DEPRECATED, use CONTRAST_MODE
instead - specifies whether to automatically calculate and apply a 2
standard deviation contrast adjustment to the image. Use AUTO_CONTRAST=YES to
turn on. Anything else turns it off.
- CLIP_COLLAR (raster only) - specifies whether to clip the collar
off of the image. The following values are supported for cropping:
- NONE - no collar cropping is performed.
- AUTO - automatically remove a USGS DRG-style collar or a 3.75 DOQQ
collar
- LAT_LON - crop the collar to a a specified set of bounds specified in
arc degrees in the native datum of the layer. The bounds should be specified
using the CLIP_COLLAR_BOUNDS parameter.
- NATIVE - crop the collar to a specified set of bounds specified in the
native projection system and datum of the layer. The bounds should be
specified using the CLIP_COLLAR_BOUNDS parameter.
- PIXELS - crop a given number of pixels off of each side of the layer.
The number of pixels to remove from each side should be specified using the
CLIP_COLLAR_BOUNDS parameter.
- SNAP_DEGREES - crop the collar by snapping each edge to a specified degree boundary specified in
arc degrees in the native datum of the layer. The bounds should be specified
using the CLIP_COLLAR_BOUNDS parameter. For example to crop the west and east edges to a half
degree boundary and the north and south edges to a one degree boundary, use the following:
CLIP_COLLAR_BOUNDS=0.5,0.25,0.5,0.25.
- POLY - crop to a polygon provided with the CLIP_COLLAR_POLY parameter.
- CLIP_COLLAR_BOUNDS (raster only) - specifies the bounds of the
collar to be clipped off when the CLIP_COLLAR parameter is enabled. The
coordinates should be specified in arc degrees, native layer coordinates, or
pixel counts as a comma-delimited list going west,south,east,north. For
example, CLIP_COLLAR_BOUNDS=34.25,-109.0,34.375,-108.875.
- CLIP_COLLAR_POLY (raster only) - specifies the name of the
previously defined shape (with the DEFINE_SHAPE command) to
crop the layer to when the CLIP_COLLAR=POLY parameter is used. The
coordinates in the shape must have been defined in the native projection system of the layer
being loaded.
- ZOOM_DISPLAY - specifies when the map should be displayed
and when it should be hidden based on the display zoom scale. This command will be formatted
as a name from the list, below followed by 2 numeric paramters. For example, use
ZOOM_DISPLAY="SCALE,25000,0" to have a map display only when zoomed in below 1:25000 scale.
- ALWAYS - always display the map. The numeric parameters are ignored.
- PERCENT - display the map when the map bounding box is a certain percentage of
the screen size. For example, use ZOOM_DISPLAY="PERCENT,10,0" to display the map when
its bounding box is at least 10% of the screen size.
- SCALE - display the map when the current display is at or below a certain scale.
For example, use ZOOM_DISPLAY="SCALE,25000,0" to display the map when the current
draw scale is at or below 1:25000.
- SCALE_RANGE - display the map when the current display is below a range of scale
value. For example, use ZOOM_DISPLAY="SCALE_RANGE,25000,100000" to display the map when
the current draw scale is between 1:25000 and 1:100000.
- COLOR_INTENSITY (elevation and raster only) - specifies the color
intensity to use when adjusting the brightness of pixels in the overlay. Valid
values range from 0 to 20, with 0 being completely black, 10 being no
alteration, and 20 being completely white. For example, to make an image
slightly darker, you could use COLOR_INTENSITY=7. (NOTE: This parameter has been
deprecated in favor of the COLOR_INTENSITY_FULL parameter).
- COLOR_INTENSITY_FULL (elevation and raster only) -
specifies the color intensity to use when adjusting the brightness of pixels in
the overlay. Valid values range from 0 to 512, with 0 being completely white, 256
being no alteration, and 512 being completely black. For example, to make an image
slightly darker, you could use COLOR_INTENSITY=300. (NOTE: This parameter replaces
the COLOR_INTENSITY parameter).
- TEXTURE_MAP (raster only) - specifies that this image should be
draped over any elevation data loaded before it. Use TEXTURE_MAP=YES to turn
on. Anything else turns it off.
- TRANSPARENT_COLOR (elevation and raster only) - specifies the color
to make transparent when rendering this overlay. The color should be specified
as RGB(<red>,<green>,<blue>). For example, to make white the
transparent color, use TRANSPARENT_COLOR=RGB(255,255,255). If you do not wish
any color to be transparent, do not use this parameter. Optionally, if the
image that you are making transparent uses a palette for the colors, you can
specify a palette index in the following format: INDEX(<0-based palette
index>). For example, to make the second color in the palette transparent,
use TRANSPARENT_COLOR=INDEX(1).
- TRANSPARENT_COLOR_DIST - for layers that have specified a color
to make transparent, this parameter allows you to specify how far a color in the layer has to be
from the specified TRANSPARENT_COLOR value to be treated as transparent as well. The default value
of 0 means that the colors have to exactly match for the pixel to be treated as transparent. Larger
values (up to 256) allow larger distances between the layer color and the transparent color. This
is useful for lossy formats, like JPEG.
- COLOR_GRADE (raster only) -
specifies the color grading values to use for this layer (as configured on the Color Grade
options dialog tab). This should be a comma-delimited list with the saturation value (from 0-1)
first, then the input and output range for the red, green, and blue color channels, as follows:
COLOR_GRADE=saturation,red_in_start,red_in_end,red_out_start,red_out_end,...,blue_out_end
- PROJ_NAME - specifies the name of the projection to use for this
file (this will override any projection information stored in the file). This
name must have been defined with a prior DEFINE_PROJ command.
- PROJ_FILENAME - specifies the name of the projection (.prj) file to
use for this file (this will override any projection information stored in the
file).
- PROJ_EPSG_CODE - specifies the numeric EPSG projection
code that defines the projection for this file (this will override any projection
information stored in the file). For example, use PROJ_EPSG_CODE=26715 to define a UTM
zone 15 projection with NAD27 as the datum and meters as the units.
- PROMPT_IF_PROJ_UNKNOWN - set to NO if you don't want the user
to be prompted to select a projection if the projection of the file cannot be automatically
determined.
- ELEV_UNITS - specify elevation units to use for
this file if it contains gridded elevation data and also for vector feature elevations that
don't have a unit embedded in the elevation value. Valid values are as follows:
- FEET - export in US feet
- DECIFEET - export in 10ths of US feet
- METERS - export in meters
- DECIMETERS - export in 10ths of meters
- CENTIMETERS - export in centimeters
- ELEV_OFFSET (elevation only) - specifies the offset in meters to
apply to each elevation value in the layer. This allows you to vertically
shift a layer to match other layers.
- ELEV_POWER (elevation only) - specifies the power value to apply to
each elevation value in the layer. For example a value of 2.0 would square each elevation value before
applying a scale and adding the offset. Default to 1.0 (no power).
- ELEV_SCALE (elevation only) - specifies the scale value to apply to
each elevation value in the layer. This allows you to vertically scale a layer
to match other layers. Default to 1.0 (no scaling).
- MIN_ELEV (elevation only) - specifies the minimum elevation
(meters) to treat as valid when rendering this layer. Any elevations below
this value will be treated as invalid and not be drawn or exported.
- MAX_ELEV (elevation only) - specifies the maximum elevation
(meters) to treat as valid when rendering this layer. Any elevations above
this value will be treated as invalid and not be drawn or exported.
- CLAMP_ELEVS (elevation only) - if a MIN_ELEV and/or MAX_ELEV value
is specified, setting this to YES will make any valid elevation values outside
of the specified range be clamped to the new range value rather than treated
as invalid.
- VOID_ELEV (elevation only) - specifies the elevation (meters) to
replace any void areas in the layer with. If not specified, the void areas
will be transparent.
- SHADER_NAME (elevation only) - this sets the name of the shader to
use when rendering the gridded elevation data for this layer. Use this to
override use of the shared default shader just for this layer. This must be
one of the names displayed in the shader drop down in Global Mapper, such as
"Atlas Shader" or "Global Shader" or the name of a custom shader.
- TRANSLUCENCY (elevation and raster only) - specifies the level of
translucency (i.e. how "see-through" the layer is). Value values range from 0
to 512, with 0 meaning the layer is completely transparent (i.e. invisible)
and 512 meaning the layer is completely opaque (this is the default).
- IGNORE_ALPHA (raster only) - specifies that an embedded
alpha channel in an image should be ignored. This is useful for images that have incorrect
alpha channels. Use IGNORE_ALPHA=YES to enable.
- BLEND_MODE (elevation and raster only)- specify blend mode to use
for combining this overlay and any previously loaded overlays
- NO_BLEND - no blending is done, this is the default
- MULTIPLE
- SCREEN
- OVERLAY
- HARD_LIGHT
- COLOR_BURN
- COLOR_DODGE
- DARKEN
- LIGHTEN
- DIFFERENCE
- EXCLUSION
- APPLY_COLOR
- APPLY_COLOR_REVERSE
- KEEP_RED
- KEEP_GREEN
- KEEP_BLUE
- SPOT_NATURAL_COLOR_SPOT_TO_NATURAL
- PSEUDO_NATURAL_COLOR_CIR_TO_NATURAL
- COLOR_TO_GRAYSCALE
- FEATHER_BLEND_EDGES (raster only) - specifies that the layer should
be feature-blended around one or more ledges. This is a numeric bitfield
value. Add the following values to enable blending on that edge:
- 1 - blend top edge
- 2 - blend bottom edge
- 4 - blend left edge
- 8 - blend right edge
For example, to blend all edges, use
FEATHER_BLEND_EDGES=15. The FEATHER_BLEND_SIZE parameter is used to specify
how many pixels to blend on each blended edge.
- FEATHER_BLEND_SIZE (raster only) - specifies the size in pixels to
use for a blend boundary.
- FEATHER_BLEND_POLY_FILE (raster only) - specifies that
the polygon boundary to feather blend this layer against should come from the specified
file.
- BAND_SETUP (raster only) - specifies what bands of data from the
raster file being loaded should be used to populate the red, green, and blue
color channels when displaying the image. This is useful for multi-spectral
imagery which may have more than 3 color bands. The default band setup will be
to use the first three bands as follows: BAND_SETUP="0,1,2". Note that not all
raster formats support specifying a non-default band setup.
- LABEL_FIELD - specifies the name of the attribute field to use as
the label attribute for the features in the file. By default the attribute-based labeling will only
be applied to those features that don't already have a label, but if the LABEL_FIELD_FORCE_OVERWRITE attribute
is set to YES then all features will have their labels replaced. If you want to build the label from multiple
attributes, separate them with '>+<' in the file, like 'RD_PREFIX>+<RD_NAME>+<RD_SUFFIX'.
- LABEL_FIELD_FORCE_OVERWRITE - specifies that the LABEL_FIELD attribute value
should be applied to all feature labels, not just those that don't already have labels. Use
LABEL_FIELD_FORCE_OVERWRITE=YES to enable.
- LABEL_PREFIX - specifies the prefix to prepend to attribute-based labels
- LABEL_SUFFIX - specifies the suffix to append to attribute-based labels
- ELEV_FIELD - specifies the name of the attribute field to use as
the elevation value for the features in the file.
- AREA_TYPE - specifies the name of the Global Mapper type to use for
area features imported from the file.
- LINE_TYPE - specifies the name of the Global Mapper type to use for
line features imported from the file.
- POINT_TYPE - specifies the name of the Global Mapper type to use
for point features imported from the file.
- LAYER_DESC - specifies a description to use for the layer when
displaying it in the Overlay Control Center. This overrides the default
description based on the filename or other information within the file.
- GCP - specifies a single ground control point for use in rectifying
a file. The GCP record consists of 5 comma-delimited fields, the control point
name, the pixel X and Y coordinates, and the corresponding ground X and Y
coordinates. A separate GCP parameter and value should be used for each
control point used in the rectification. As an alternative, the GCP_FILENAME
parameter (see below) can be used instead.
- GCP_FILENAME - specifies the name of a control point file used to
rectify the file being imported.
- GCP_PROJ_NAME - specifies the name of the projection that the
ground control points are provided in. This name must have been defined with a
prior DEFINE_PROJ command. Use this if you want to specify control
points in a projection other than what you want to define as the native
projection for the file. Note that you must also explicitly specify the name
projection of the file using either the PROJ_NAME,
PROJ_EPSG_CODE or
PROJ_FILENAME parameters.
- GCP_PROJ_FILENAME - specifies the name of the projection (.prj)
file that contains the projection definition for the projection that the
ground control points are provided in. Use this if you want to specify control
points in a projection other than what you want to define as the native
projection for the file. Note that you must also explicitly specify the name
projection of the file using either the PROJ_NAME,
PROJ_EPSG_CODE or
PROJ_FILENAME parameters.
- GCP_PROJ_EPSG_CODE - specifies the EPSG code
of the projection that the ground control points are provided in. Use this if you
want to specify control points in a projection other than what you want to define
as the native projection for the file. Note that you must also explicitly specify
the name projection of the file using either the PROJ_NAME,
PROJ_EPSG_CODE or
PROJ_FILENAME parameters.
- RECTIFY - specifies the rectification method to use for rectifying
this file. Valid value are LINEAR, HELMERT, AFFINE, POLYNOMIAL, and TRIANGULATION. If
you do not specify a rectification type but do provide at least two ground
control points, best rectification method will automatically be chosen based
on the number of control points specified.
- ALLOW_SELECTION - set to NO to disable selection of
features from this layer using either the Feature Info or Digitizer Tools.
IMPORT_ARCHIVE
The IMPORT_ARCHIVE command imports a data file from a .tar.gz archive for
later use. The only time you should ever need to use the IMPORT_ARCHIVE command
is when you only want to load some of the data inside a .tar.gz archive. For the
typical case of just loading everything in an archive, use the IMPORT command
with AUTO as the value for the TYPE parameter. The following parameters are
supported by the command.
- ARCHIVE_FILENAME - full path to the archive file to load the data
from
- FILENAME - filename to load from the archive
- NOTE: All other parameters that are supported by the IMPORT command
are also supported by this command.
IMPORT_ASCII
The IMPORT_ASCII command imports data from a generic ASCII text file for
later use. The following parameters are supported by the command.
- FILENAME - full path to file to load the data from
- TYPE - type of import that we're doing
- POINT_ONLY - all lines with coordinate data will result in a new point
object begin created
- POINT_AND_LINE - both point and line features will be created from
coordinate data in the file. Line features will be created when coordinate
data lines are back to back in the file. All individual coordinate lines
will result in a point object being created
- ELEVATION - all lines in the file with 3 coordinate values (x,y, and
elevation) will be used to create an elevation grid. The data will be
triangulated and gridded automatically, resulting in a fully usable
elevation grid that can be exported to any of the supported elevation data
formats.
- COORD_DELIM - specifies the delimeter between coordinates in
coordinate lines
- AUTO - automatically detect the delimeter type (default)
- WHITESPACE - coordinates are separated with one or more space and/or tab
characters
- COMMA - coordinates are separated by commas
- SEMICOLON - coordinates are separated by semicolons
- TAB - coordinates are separated by tabs
- COORD_ORDER specifies the order of the coordinates in coordinate
lines
- X_FIRST - x coordinates (i.e. easting or longitude) come first, followed
by y coordinates (i.e. northing or latitude) (default)
- Y_FIRST - y coordinates (i.e. northing or latitude) come first, followed
by x coordinates (i.e. easting or longitude)
- COORD_PREFIX - if present, this line is used to specify what
special character sequence coordinate lines start with. For example, if the
coordinate lines in the file started with the character sequence "XY,", you
should use COORD_PREF="XY,". By default no coordinate prefix is assumed.
- INC_COORD_LINE_ATTRS - set the value of this parameter to YES
if you wish to use any leftover text at the end of coordinate lines as
attributes for the feature the coordinates are in. This could be useful if
elevation data is present at the end of the lines. By default, the value of
this attribute is NO.
- INC_ELEV_COORDS - this parameter controls whether or not
the value right after the 2nd coordinate column (if there is one) will be treated as an
elevation value. Use INC_ELEV_COORDS=YES or INC_ELEV_COORDS=NO to enable (the default)
or disable this behavior.
- COL_HEADERS - controls whether or not the first line of the file
should be used as column headers for coordinate line attributes later in the
file. Setting this to yes is useful for things like CSV files with column
headers in the first row, otherwise set it to NO (the default).
- PROJ_NAME - specifies the name of the projection to use for this
file (this will override any projection information stored in the file). This
name must have been defined with a prior DEFINE_PROJ command.
- PROJ_FILENAME - specifies the name of the projection (.prj) file to
use for this file (this will override any projection information stored in the
file).
- PROJ_EPSG_CODE - specifies the numeric EPSG projection
code that defines the projection for this file (this will override any projection
information stored in the file). For example, use PROJ_EPSG_CODE=26715 to define a UTM
zone 15 projection with NAD27 as the datum and meters as the units.
- PROMPT_IF_PROJ_UNKNOWN - set to NO if you don't want the user
to be prompted to select a projection if the projection of the file cannot be automatically
determined.
- ELEV_UNITS - specify elevation units to use for this file if it
contains gridded elevation data
- FEET - export in US feet
- DECIFEET - export in 10ths of US feet
- METERS - export in meters
- DECIMETERS - export in 10ths of meters
- CENTIMETERS - export in centimeters
- SKIP_COLUMNS - specifies the number of columns (fields) to skip at the start
of a coordinate line before trying to read the coordinates. For example, if
the X and Y coordinates of a line were in the 3rd and 4th columns of the
coordinate line, you'd use a value of SKIP_COLUMNS=2. The default value is 0,
meaning that coordinates must be in the first two columns.
- SKIP_ROWS - specifies the number of rows to skip at the start
of a file before trying to read any data. For example, if your file has a fixed header
of 20 lines, you would use SKIP_ROWS=20 to skip those header rows.
- BREAK_COL_IDX - specifies the 1-based index of the column
to break features at if the value in that column changes.
- COORD_OFFSET - specifies the offset to apply to any coordinates
read in from the file. This offset will be added to each coordinate read in
from the file. The offset should be specified as a comma-delimited list of the
X, Y, and Z offsets, such as COORD_OFFSET=100000.0,200000.0,0.0
- COORD_SCALE - specifies the scale factor to apply to any
coordinates read in from the file. Each coordinate will be multiplied by these
scale factor after being read in from the file. The scale factors should be
specified as a comma-delimited list of the X, Y, and Z scale factors, such as
COORD_SCALE=0.1,0.1,1.0
- NO_DATA_DIST_MULT - specifies how far from an actual data point a
grid cell has to be before it is treated as a no data value. This number is
given as a multiple of the diagonal size of a single grid cell as nominally
determined by the gridding algorithm or specified with the SPATIAL_RES parameter.
A value of 0 means that all points should be considered as valid.
- SPATIAL_RES - specifies spatial resolution to use
when generating an elevation grid from the data. Defaults to a good value for
maintaining the full spatial resolution of the provided point data if not specified.
Should be formatted as x_resolution,y_resolution. The units are the units of the
projection specified for the file. For example, if UTM with meter units was the file
projection and you wanted to export at 30 meter spacing, the parameter/value pair
would look like SPATIAL_RES=30.0,30.0.
- SPATIAL_RES_METERS - specifies spatial resolution to use in meters. The
value in meters will automatically be converted to the curent view/export projection units. For example,
to do an export at 2.0 meter spacing (or as close as you can get to that in the current units), use
SPATIAL_RES_METERS=2.0, or to do an export at 1.0 meters in X by 1.5 meters in Y, use
SPATIAL_RES_METERS="1.0,1.5".
- LABEL_FIELD - specifies the name of the attribute field to use as
the label attribute for the features in the file.
- AREA_TYPE - specifies the name of the Global Mapper type to use for
area features imported from the file.
- LINE_TYPE - specifies the name of the Global Mapper type to use for
line features imported from the file.
- POINT_TYPE - specifies the name of the Global Mapper type to use
for point features imported from the file.
- HIDDEN - set to YES to cause this overlay to be hidden from view
after it is loaded. The default is to show the overlay.
SAMPLE:
IMPORT_ASCII FILENAME="C:\data\ASCII Files\usvi_landmark.asc" TYPE=POINT_AND_LINE COORD_DELIM=AUTO COORD_ORDER=X_FIRST COORD_PREFIX="XY,"INC_COORD_LINE_ATTRS=NO
IMPORT_DIR_TREE
The IMPORT_DIR_TREE command imports all of the data files in a given
directory tree that match a list of filename masks. The following parameters are
supported by the command. In addition, all of the option parameters for
the IMPORT command are also supported for this command.
- DIRECTORY - full path to root of directory tree to import files
from.
- FILENAME_MASKS - space-separated list of filename masks to import.
If no value is provided then all files which are of recognized types will be
imported.
SAMPLE:
IMPORT_DIR_TREE DIRECTORY="C:\TEMP\EXPORT TEST" FILENAME_MASKS="*.OPT *.GMP"
IMPORT_TERRASERVER
The IMPORT_TERRASERVER command imports a chunk of TerraServer data, such as
satellite imagery or topographic maps. The following parameters are supported by
the command:
- THEME_NAME - name of the TerraServer theme to import, such as DOQ
or DRG
- LAT_LON_BOUNDS - specifies the bounds to import in
latitude/longitude degrees. There should be 4 values in a comma-delimited list
following the parameter name. The values should be in order of westmost
longitude, southernmost latitude, easternmost longitude, northernmost
latitude.
- LAYER_BOUNDS - specifies that the import should use the bounds of
the loaded layer(s) with the given filename. For example, to import to the
bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif".
Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation
should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand
the bounding rectangle by should be specified in the current global projection. For
example, if you have a UTM/meters projection active and want to expand the bounds
retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and
50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You
can also specify a single value to apply to all 4 sides, or supply 4 separate values
in the order left,top,right,bottom.
- ANTI_ALIAS - specifies whether to remove jagged edges by making a
subtle transition between pixels. Turning off this option helps maintain the
hard edges of the pixels as they are rasterized. Use ANTI_ALIAS=YES to turn
on. Anything else turns it off.
- CONTRAST_MODE (raster only) - specifies the type of contrast
adjustment to apply to the data.
- NONE - no contrast adjustment applied (this is the default)
- PERCENTAGE - apply a percentage contrast adjustment. The
CONTRAST_STRETCH_SIZE parameter can be used to override the number of
standard deviations from the mean to stretch to.
- MIN_MAX - apply a min/max contrast stretch, stretching the available
range of values in each color band to the full range of 0-255. For imagery
which contains both black and white, this will have no affect.
- CONTRAST_SHARED (raster only) - specified whether or not
the contrast adjustment for this layer will share the adjustment with other contrast-adjusted
layers in order to ensure a consistent modification across layers. Use CONTRAST_SHARED=YES
to enable contrast sharing.
- CONTRAST_STRETCH_SIZE (raster only) - specifies the number of
standard deviations from the mean to use in a PERCENTAGE contrast adjustment.
The default is 2.0.
- AUTO_CONTRAST (raster only) - DEPRECATED, use CONTRAST_MODE
instead - specifies whether to automatically calculate and apply a 2
standard deviation contrast adjustment to the image. Use AUTO_CONTRAST=YES to
turn on. Anything else turns it off.
- COLOR_INTENSITY (elevation and raster only) - specifies the color
intensity to use when adjusting the brightness of pixels in the overlay. Valid
values range from 0 to 20, with 0 being completely black, 10 being no
alteration, and 20 being completely white. For example, to make an image
slightly darker, you could use COLOR_INTENSITY=7. (NOTE: This parameter has been
deprecated in favor of the COLOR_INTENSITY_FULL parameter).
- COLOR_INTENSITY_FULL (elevation and raster only) -
specifies the color intensity to use when adjusting the brightness of pixels in
the overlay. Valid values range from 0 to 512, with 0 being completely white, 256
being no alteration, and 512 being completely black. For example, to make an image
slightly darker, you could use COLOR_INTENSITY=300. (NOTE: This parameter replaces
the COLOR_INTENSITY parameter).
- TEXTURE_MAP - specifies that this image should be draped over any
elevation data loaded before it. Use TEXTURE_MAP=YES to turn on. Anything else
turns it off.
- TRANSPARENT_COLOR - specifies the color to make transparent when
rendering this overlay. The color should be specified as
RGB(<red>,<green>,<blue>). For example, to make white the
transparent color, use TRANSPARENT_COLOR=RGB(255,255,255). If you do not wish
any color to be transparent, do not use this parameter.
- TRANSLUCENCY - specifies the level of translucency (i.e. how
"see-through" the layer is). Value values range from 0 to 512, with 0 meaning
the layer is completely transparent (i.e. invisible) and 512 meaning the layer
is completely opaque (this is the default).
- BLEND_MODE - specifies the blend mode to use for combining this
overlay and any previously loaded overlays
- NO_BLEND - no blending is done, this is the default
- MULTIPLE
- SCREEN
- OVERLAY
- HARD_LIGHT
- COLOR_BURN
- COLOR_DODGE
- DARKEN
- LIGHTEN
- DIFFERENCE
- EXCLUSION
- APPLY_COLOR
- APPLY_COLOR_REVERSE
- KEEP_RED
- KEEP_GREEN
- KEEP_BLUE
LOAD_PROJECTION
The LOAD_PROJECTION command imports a projection from a PRJ file and makes it
the current global projection. This projection will be used for all exports
after this command until another LOAD_PROJECTION command is encountered to
change the global projection. The following parameters are supported by the
command:
- FILENAME - full path to PRJ file to load the projection from
- PROJ_NAME - specifies the name of the projection to use. This name
must have been defined with a prior DEFINE_PROJ command.
- PROJ_EPSG_CODE - specifies the numeric EPSG projection
code that defines the projection. For example, use PROJ_EPSG_CODE=26715 to define a UTM
zone 15 projection with NAD27 as the datum and meters as the units.
LOAD_STYLE_FILE
The LOAD_STYLE_FILE command load a Global Mapper Style (.gm_style) file containing style
definitions for a list of types. You can optionally choose to have any types specified in
the style file that aren't present in the running instance of Global Mapper to be added,
providing a script way to add new custom types. The following parameters are supported by the
command:
- FILENAME - full path to style (.gm_style) file to load
- ADD_UNKNOWN_TYPES - specifies that any types found in the
style file that aren't present will be added as custom types. Use ADD_UNKNOWN_TYPES=NO to
disable adding missing types, or ADD_UNKNOWN_TYPES=YES to enable it (this is the default).
LOAD_TYPE_FILTER
The LOAD_TYPE_FILTER command load a type filter from a Global Mapper Filter (GMF) file. You can
create new GMF files from the type filter dialogs accessible from the Vector Display tab of
the Configuration dialog. The following parameters are supported by the
command:
- FILENAME - full path to GMF file to load
- FILTER_TYPE - specifies the type of features the filter file is for. The
supported values area FILTER_TYPE=AREA, FILTER_TYPE=LINE, or FILTER_TYPE=POINT.
PLAY_SOUND
The PLAY_SOUND command plays either the information sound for the system or a
specified sound file. This can be useful if you want audible confirmation when
a script completes. The following parameters are supported by the command.
- FILENAME - full path to sound file (like .wav) to play. If not specified the information beep will play.
RESTORE_LAST_SAVED_VIEW
The RESTORE_LAST_SAVED_VIEW command restores the last view saved with the
SAVE_CURRENT_VIEW command (or the last view saved with the View->Save Current
View menu command in the Global Mapper user interface). This command does not
take any parameters.
RUN_COMMAND
The RUN_COMMAND command allows you to execute any program on Windows with a set of parameters.
The following parameters are supported by the command.
- COMMAND_LINE - full command line to run. If you need to use quotation marks
in your command line, instead use apostrophes (i.e. ' rather than ") and they will be converted to quotes
prior to running the command.
- WAIT_FOR_COMPLETE - specifies whether or not the script should wait for
your command line run to complete prior to continuing. The default is to wait for the command to complete
(i.e. WAIT_FOR_COMPLETE=YES). If you just want the command line to run and then immediately let the script
continue processing, use WAIT_FOR_COMPLETE=NO.
Here is a sample that runs another instance of Global Mapper and loads a file:
RUN_COMMAND COMMAND_LINE="'c:\program files (x86)\GlobalMapper12\global_mapper12.exe' 'c:\temp\export test\blue_springs.opt'" WAIT_FOR_COMPLETE=NO
SAVE_CURRENT_VIEW
The SAVE_CURRENT_VIEW command saves the current view window for later
restoration using the RESTORE_LAST_SAVED_VIEW command. This command does not
take any parameters.
SAVE_PROJECTION
The SAVE_PROJECTION command saves the current global projection to a PRJ
file. The following parameters are supported by the command.
- FILENAME - full path to PRJ file to save the projection to
SET_BG_COLOR
The SET_BG_COLOR command sets the color to use for any background pixels when
rendering layers. The following parameters are supported by the command.
- COLOR - specifies the background color to use. The color should be
specified as RGB(<red>,<green>,<blue>). For example, to make
white the background color, use COLOR=RGB(255,255,255).
SET_LOG_FILE
The SET_LOG_FILE command sets the name of the file to log status, warning,
and error messages to. If the log file specified already exists, the messages
will be appended to the end of it. The following parameters are supported by the
command.
- FILENAME - full path to log file to write messages to
SET_VERT_DISP_OPTS
The SET_VERT_DISP_OPTS command allows you to modify the options used when
rendering elevation layers, such as the shader to use, if any, as well as the
lighting and water setup. The following parameters are supported by this
command:
- ENABLE_HILL_SHADING - this setting controls whether or not hill
shading (i.e. lighting, shadowing) will be done. Use YES to enable hill
shading, and NO to disable hill shading.
- SHADER_NAME - this sets the name of the shader to use when
rendering elevation data. This must be one of the names displayed in the
shader drop down in Global Mapper, such as "Atlas Shader" or "Global Shader"
or the name of a custom shader.
- AMBIENT_LIGHT_LEVEL - this sets the ambient lighting level. The
valid range of values is [0.0, 1.0], with smaller numbers meaning completely
black (i.e. no light) and 1.0 being full lighting.
- VERT_EXAG - this sets the vertical exaggeration to use when
rendering elevation overlays. This effects the hill shading. The valid range
of values is (0.0, 100.0].
- LIGHT_ALTITUDE - this sets the altitude angle of the light source
that creates shadows on elevation data. The valid range of values is [0.0,
90.0], with 0.0 meaning a light source at the horizon and 90.0 meaning a light
source directly overhead.
- LIGHT_AZIMUTH - this sets the direction angle of the light source
that creates shadows on elevation data. The valid range of values is [0.0,
360.0), with 0.0 meaning a light source from the top of the screen (i.e.
north), 90.0 meaning from the right (i.e. east), etc.
- SHADE_DARKNESS - this sets the minimum black level that a
shadow can create. The valid range of values is [0,255], with 0 allowing complete blackness from
a shadow, and 255 allowing no shadow at all.
- SHADE_HIGHLIGHT - this sets the level of white highlight applied
to terrain areas directly facing the sun/light angle. The valid range of values is [0,255], with 0
applying no highlight and 255 making the direct areas always brightened completely to white.
- ENABLE_WATER - this setting controls whether or not water will be
displayed on top of elevation values at or below the currently configured
water level. Use YES to enable water display, and NO to disable water display.
- WATER_COLOR - this setting controls the color that water drawn on
top of elevation data is rendered in. The format of this value is
RGB(<red>,<green>,<blue>). For example, to use a water color
of blue, use WATER_COLOR=RGB(0,0,255).
- WATER_LEVEL - this setting specifies the height (in meters) below
which water should be displayed if enabled.
- WATER_ALPHA - this setting controls how "see through" the water is
when displayed. The valid range of values is [0,255], with 0 meaning the water
is completely "see through", i.e. invisible, and 255 meaning that the water
color is completely opaque such that you can't see any of the shaded relief
below it.
SHOW_3D_VIEW
The SHOW_3D_VIEW command displays the 3D view window with the loaded data.
The following parameters are supported by the command:
- MAXIMIZE - specifies whether or not the 3D view window should be
maximized or not. Use MAXIMIZE=YES to force the window to be maximized when
displayed.
UNLOAD_ALL
The UNLOAD_ALL command unloads all currently loaded data. This command takes
no parameters.
The following parameters are supported by the command:
- VECTOR_ONLY - specifies that only layers containing vector data
shall be unloaded. All raster and gridded elevation layers will remain loaded.
Use VECTOR_ONLY=YES to enable unloading just the vector layers.
UNLOAD_LAYER
The UNLOAD_LAYER command allows you to unload all previous loaded layers with
a given filename. This is useful if you don't want to unload all previously
loaded layers just to get rid of a few of them.
The following parameters are supported by the command:
- FILENAME - filename of the layer to unload. If an empty value is
passed in, all layers that were created by the script, such as those from a
GENERATE_CONTOURS command, will be unloaded. You can also pass in the value
'USER CREATED FEATURES' when running a script in the context of the main map
view or loading a workspace to have the 'User Created Features' layer
unloaded. You can also pass in the full description of
the loaded layer to use in case you want to unload a layer not loaded from a file.
Crop, Merge, and Reproject 4 USGS DRGs into new
GeoTIFF and JPEG files
GLOBAL_MAPPER_SCRIPT VERSION=1.00
UNLOAD_ALL
// Import the four 24K DRGs that we want to merge. We use the CLIP_COLLAR option
// to indicate that we want the collar to be automatically removed from the
// DRGs when they are imported.
IMPORT FILENAME="C:\DATA\DRG\KANSAS CITY\O39094B2.TIF" \
TYPE=AUTO ANTI_ALIAS=NO AUTO_CONTRAST=NO CLIP_COLLAR=AUTO TEXTURE_MAP=NO
IMPORT FILENAME="C:\DATA\DRG\KANSAS CITY\O39094A1.TIF" \
TYPE=AUTO ANTI_ALIAS=NO AUTO_CONTRAST=NO CLIP_COLLAR=AUTO TEXTURE_MAP=NO
IMPORT FILENAME="C:\DATA\DRG\KANSAS CITY\O39094A2.TIF" \
TYPE=AUTO ANTI_ALIAS=NO AUTO_CONTRAST=NO CLIP_COLLAR=AUTO TEXTURE_MAP=NO
IMPORT FILENAME="C:\DATA\DRG\KANSAS CITY\O39094B1.TIF" \
TYPE=AUTO ANTI_ALIAS=NO AUTO_CONTRAST=NO CLIP_COLLAR=AUTO TEXTURE_MAP=NO
// Load a projection file to set the global projection to geographic (lat/lon)
// arc degrees with a datum of NAD83.
LOAD_PROJECTION FILENAME="C:\DATA\PRJ Files\geo_degrees_nad83.prj"
// Use the EXPORT_RASTER command to generate a new 8-bit per pixel GeoTIFF file
EXPORT_RASTER FILENAME="C:\DATA\EXPORTED DATA\merged_drg_8bpp.tif" \
TYPE=GEOTIFF PALETTE=OPTIMIZED
// Now, use the EXPORT_RASTER command to generate a grayscale GeoTIFF file. Lets
// also create a world file for this one
EXPORT_RASTER FILENAME="C:\DATA\EXPORTED DATA\merged_drg_gray.tif" \
TYPE=GEOTIFF PALETTE=GRAYSCALE GEN_WORLD_FILE=YES
// Create a JPEG file using the EXPORT_RASTER command. Also create a world file
// and a projection file to make it easier to load in other places.
EXPORT_RASTER FILENAME="C:\DATA\EXPORTED DATA\merged_drg.jpg" \
TYPE=JPEG GEN_WORLD_FILE=YES GEN_PRJ_FILE=YES
Generate Contours from all USGS DEMs in a Folder and Export them to DXF and Shape files
GLOBAL_MAPPER_SCRIPT VERSION=1.00
UNLOAD_ALL
// Loop over all DEM files in a folder and convert them
DIR_LOOP_START DIRECTORY="C:\DATA\SDTS_DEM\24K\" FILENAME_MASKS="*.DEM.STDS.TAR.GZ" RECURSE_DIR=NO
// Import an archived SDTS DEM file. Global Mapper will automatically
// determine that this is an archived SDTS DEM file and load it
// correctly.
IMPORT FILENAME="%FNAME_W_DIR%" ANTI_ALIAS=YES
// Generate 50 ft contours from the loaded DEM data.
GENERATE_CONTOURS INTERVAL=50 ELEV_UNITS=FEET
// Export the contours to a new DXF file. The created file will have
// 3D polyline features for the contours.
EXPORT_VECTOR FILENAME="%DIR%%FNAME_WO_EXT%_CONTOURS.DXF" TYPE=DXF GEN_PRJ_FILE=YES
// Export the contours to a 3D shape file.
EXPORT_VECTOR FILENAME="%DIR%%FNAME_WO_EXT%_CONTOURS.SHP" TYPE=SHAPEFILE \
SHAPE_TYPE=LINES GEN_3D_LINES=YES GEN_PRJ_FILE=YES
// Unload the loaded data
UNLOAD_ALL
// End the loop
DIR_LOOP_END
Edit Vector Features Based on an Attribute and Display Label
GLOBAL_MAPPER_SCRIPT VERSION=1.00
// Import the file to modify
IMPORT FILENAME="C:\Temp\export test\tiger_wyandotte_sample.gmp"
// Assign the type "railroad" to all features with a CFCC attribute with a value of A41
// and a display label with '74' in it somewhere.
EDIT_VECTOR LINE_TYPE="RAILROAD" COMPARE_STR="CFCC=A41" COMPARE_STR="<Feature Name>=*74*"
// Assign the name "Burlington Northern Railroad" to all features with a CFCC attribute with a value of A41
EDIT_VECTOR ATTR_VAL="<Feature Name>=Burlington Northern Railroad" COMPARE_STR="CFCC=A41"