EXPORT_GEOPACKAGE

The EXPORT_GEOPACKAGE command exports all currently loaded raster, vector, and elevation data to a GeoPackage (*.gpkg) file. The following parameters are supported by the command.

  • FILENAME - full path to file to save the data to
  • EXPORT_LAYER - filename or description of layer(s) to export. By default all compatible and exportable layers are exported. You can include multiple EXPORT_LAYER parameters if you have multiple masks to search. Wildcards (* and ?) are supported. Hidden layers are not considered.
  • OVERWRITE_EXISTING – indicates whether or not to overwrite the output file, if it already exists. Default is NO
  • Vector Options
    • SHAPE_TYPE – allow one or more of AREAS, LINES, POINTS. Default is to export all compatible and exportable features.
    • VECTOR_TABLE – One to three names corresponding to SHAPE_TYPE entries. Default is to use the name of the shape type.
    • SPLIT_BY_LAYER – Create a separate table for each layer. Table name is layer name plus VECTOR_TABLE value, if necessary.
    • GEN_3D_FEATURES – Export 3D features
  • Raster Tile Options

    • TILE_TABLE – Table name for raster tiles. Defaults to “tile_data”

    • DESCRIPTION – Description for tiled data set.

    • MAX_ZOOM_LEVEL – Maximum zoom level. Valid range is 3 to 23. If not specified, GM will compute a zoom level based on the image data resolution.

    • NUM_ZOOM_LEVELS – Number of zoom levels to export

    • IMAGE_FORMAT – Valid values are PNG and JPG

    • QUALITY – Image quality. Valid range is 0 to 100. Only valid for IMAGE_FORMAT=JPG

    • TILE_SIZE – Size in pixels for each tile. Tiles will be square. Valid values are 256, 512, and 1024. Default is 256

    • WEB_SKIP_EMPTY_TILES – Skip tiles that have no data (default true)

    • WEB_SKIP_EXISTING_TILES – Skip tiles that already exist (resuming export)

  • See also Specify Bounds for Operation

    • 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 west-most longitude, southern-most latitude, eastern-most longitude, northern-most 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.
    • SNAP_BOUNDS_TO_MULTIPLE - specifies that the top-left corner of the bounding box for the operation should be snapped to a multiple of the given value. For example, using SNAP_BOUNDS_TO_MULTIPLE=1 will snap the top-left corner to the nearest whole number. The values will always go smaller for X/easting/longitude and larger to Y/northing/latitude so you always get at least what is requested.
    • SNAP_BOUNDS_TO_SPACING - specifies that the top-left corner of the bounding box for the operation should be snapped to a multiple of the resolution of the operation. For example, if you are exporting at 5 meter spacing, the top left corner will be snapped to the nearest multiple of 5. Use SNAP_BOUNDS_TO_SPACING=YES to enable or SNAP_BOUNDS_TO_SPACING=NO to disable. If not provided, the global setting for snapping exports to the nearest sample spacing boundary from the Advanced section of the General tab of the Configuration dialog will be used.
    • USE_EXACT_BOUNDS - specifies that the exact bounds that were defined in the command should be used. Generally, when the bounds specified in a command are not the same as the data bounds, the command uses the intersection between the two. When USE_EXACT_BOUNDS=YES is specified, the command will use the bounds as specified, instead of the intersection.

  • See also Cropping Operations to Polygons/Areas

    • POLYGON_CROP_FILE - specifies the full path and filename or loaded layer description of a vector file/loaded layer containing one or more polygon features 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_FILE_PROJ - specifies the projection to use for the POLYGON_CROP_FILE. Use if the file doesn't have an associated projection file. See special Projection Specification for instructions.
    • 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). If you want to crop to any area features that are selected with the Digitizer Tool in the user interface rather than a defined polygon, use POLYGON_CROP_NAME="SELECTED".
    • 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. This parameter also works with FEATHER_BLEND_EDGES. Use POLYGON_CROP_USE_EACH=YES with FEATHER_BLEND_POLY_FILE or FEATHER_BLEND_POLY to feather the edges of multiple polygons.
    • POLYGON_CROP_EXCLUDE - specifies that the crop areas are actually regions to exclude from the export rather than include. If you add POLYGON_CROP_EXCLUDE=YES to the command the results will contain everything outside the crop areas but within the full export bounds.
    • POLYGON_CROP_COMBINE_DUPS - specifies that if a POLYGON_CROP_FILE is specified that contains multiple polygons and POLYGON_CROP_USE_EACH is set, whether or not polygons with duplicate values for the attribute used for filenaming will be combined into a single export or split into separate exports. The default is POLYGON_CROP_COMBINE_DUPS=YES.
    • 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_GRID_ONLY - specifies that any crop polygon(s) are used only to determine which tile/grid cells will be exported. For each tile/grid cell that intersects a crop polygon, the full tile/grid cell will be exported. Use POLYGON_CROP_GRID_ONLY=YES to enable.
    • POLYGON_CROP_INT_DATA_BOUNDS - control how the bounding box for the export is determined if a crop polygon is specified. If this option is disabled, the export bounds will be the bounds of the crop area(s), even if they extend outside the data bounds, unless you explicitly specified a bounding box in the other parameters (i.e. LAYER_BOUNDS, GLOBAL_BOUNDS, etc.). If the option is enabled, the export bounds will be the intersection of the crop area bounds and the non-cropped bounding box (i.e. full data bounds or specified bounds in other parameter). This parameter is enabled by default, use POLYGON_CROP_INT_DATA_BOUNDS=NO to disable.
    • POLYGON_CROP_NAME_ATTR - used to control the filenames generated when cropping to multiple polygons using the POLYGON_CROP_USE_EACH parameter. See special Attribute Name parameter details. This value will be appended to any filename specified in the EXPORT FILENAME parameter. 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. See special Attribute Name parameter details.
    • POLYGON_CROP_FILENAME_SUFFIX - specifies the text to insert in the output filename just before the file extension when cropping to polygons. For example, if you add POLYGON_CROP_FILENAME_SUFFIX="_out", the original FILENAME was "my_file_.dem" and the value from the polygon was "A1", you would get an output filename of "my_file_A1_out.dem".
    • POLYGON_CROP_COMPARE_STR - specifies a compare string to use to filter out the areas in the polygon crop file. See the COMPARE_STR parameter for the EDIT_VECTOR script command for details.

  • See also Gridding/Tiling Operations into Smaller Chunks

    • 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 pixels tall, you would use GRID_TYPE_PIXEL_SIZE="800,600".
    • GRID_TYPE_PIXEL_SIZE_MAX - specifies that the export should be gridded into multiple tiles with each tile having the given maximum size in pixels/samples. This works by calculating the number of rows and columns needed to hold cells of the given pixel dimensions, then shrinking those pixel dimensions down so that the tiles exactly cover the exported bounds. 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 at most 800 pixels wide by 600 pixels tall, you would use GRID_TYPE_PIXEL_SIZE_MAX="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_OVERLAP_NUM_PIXELS - indicates whether or not the value specified in GRID_OVERLAP should be interpreted as a number of pixels instead of a percentage. Use GRID_OVERLAP_NUM_PIXELS=YES to specify that the value specified in the GRID_OVERLAP parameter should be interpreted as a number of pixels. Use GRID_OVERLAP_NUM_PIXELS=NO or omit this parameter to specify that the value is a percentage.
    • 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. The value will be appended to FILENAME specified in the EXPORT command. 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'). If the naming type is numeric you can also specify %left% or %right% as the starting value to use the left or right coordinate of the cell bounding box. For row naming you can use %top% or %bottom%.
      • 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.
    • Tiling to Polygons/Areas - If you would like to tile your export to a series of polygons/areas, use the POLYGON_CROP_FILE and POLYGON_CROP_USE_EACH parameters. Click the link for details.