SURE.exe
The SURE executable incorporates the entire software package. It enables you to process complete 2.5D and/or 3D pipelines with just one call, while still being highly configurable using the various CLI options.
Add executables to system PATH variable
During software installation, the SURE program folder can optionally be added to the system's path variable. By doing so you will be able to call all SURE executables, including SURE.exe, SURE-Node.exe, and the Modules executables, from every directory. This way you don't have to change directory to the SURE installation folder or specify the complete executables path.
Open GUI
Calling SURE --gui <path-to-project.spr-file> will open up the Graphical User Interface and load the specified project. Such a command would be incompatible with all the other flags, designed for Command Line use.
Help text
Calling SURE -h or SURE.exe --help will print a comprehensive list of the CLI options/parameters.
Pause a process
Pressing the "Pause" key on the keyboard will pause a currently running SURE process.
Resume an interrupted process
If a SURE process has been interrupted, e.g. through cancellation by user, it can be resumed by calling sure -p <path-to-project-directory>. For more details, see also Pause and Resume Processing.
CLI options and arguments
Option / CLI flag | Description |
|---|---|
Basic | |
-p, --project-directory <path> | Set project directory (default=.\SURE) |
-i, --images <path> | Set path to input images (required, optional for certain orientation formats with valid image paths) |
-o, --orientations <path> | Set path to input orientations (required) |
-l, --lidar-clouds <path> | Set path to input LiDAR clouds |
-L, --lidar-trajectories <path> | Set path to input LiDAR trajectories (required if --lidar-clouds and --mesh specified) |
-s, --scenario <scenario> (<fw-overlap> <sw-overlap>) | Set scenario (DEFAULT, AERIAL_OBLIQUE or AERIAL_NADIR with overlaps, e.g. AERIAL_NADIR 80 60) (default=DEFAULT) |
-c, --coordinate-system <path> | Set coordinate system from WKT file |
--tiling-scheme-origin <x> <y> | Set 2D origin of tiling scheme for the output products. (default=auto) |
-t, --tile-size <size in project units> | Set tile size (default=4000 GSDs for scenario AERIAL_OBLIQUE, =2000 GSDs otherwise) |
--gsd <gsd> | Set GSD (ground sampling distance), which is the cell size for raster products. Should be greater or equal than the automatic value, which depends on --quality. (default=auto) |
-z, --z-range <zmin> <zmax> | Set z range (default=auto) |
-A, --area-shapefile <path> | Set shapefile defining region of interest instead of automatic area shapefile |
-w, --waterbody-shapefile <path> | Set shapefile defining waterbodies |
-m, --mesh-formats <format> [<format> ...] | Set mesh formats (osgb, 3d_tiles, slpk, lod_dae, lod_obj, obj and/or dae) (default=osgb) |
-q, --quality <quality> | Set quality (ULTRA, HIGH, MEDIUM or LOW). Each reduction in quality level doubles the cell size of the raster products. Exception: scenario DEFAULT with quality HIGH. (default=HIGH for scenario DEFAULT, =ULTRA otherwise) |
-d, --distributed-processing | Activate distributed processing |
--gpu | Enable GPU (CUDA) processing if possible (default) |
--activate <license-key> | Activate a license |
--gui <project-file-path> | Open project with GUI (incompatible with all other options except --no-update) |
--support | Package metadata for support cases |
-v, --version | Print version and license details |
Input | |
-i, --images <path> | Set path to input images (optional for certain orientation formats with valid image paths) |
-o, --orientations <path> | Set path to input orientations (required) |
--matching-images <path> | Set path to separate input images for matching |
-l, --lidar-clouds <path> | Set path to input LiDAR clouds |
--no-lidar-clouds | Disable use of input LiDAR clouds |
-L, --lidar-trajectories <path> | Set path to input LiDAR trajectories (required if --lidar-clouds and --mesh specified) |
--no-lidar-trajectories | Disable use of input LiDAR trajectories |
Processing Steps | |
--dense-matching | Enable dense matching step (default) |
--no-dense-matching | Disable dense matching step |
--dsm | Enable DSM step (default for scenario AERIAL_NADIR) |
--no-dsm | Disable DSM step |
--true-ortho | Enable true ortho step (default for scenario AERIAL_NADIR) |
--no-true-ortho | Disable true ortho step |
--dsm-mesh | Enable DSM mesh step |
--no-dsm-mesh | Disable DSM mesh step |
--dsm-mesh-texturing | Enable DSM mesh texturing step |
--no-dsm-mesh-texturing | Disable DSM mesh texturing step |
--point-cloud | Enable point cloud step (default for scenarios AERIAL_OBLIQUE and DEFAULT) |
--no-point-cloud | Disable point cloud step |
--mesh | Enable mesh step (default for scenarios AERIAL_OBLIQUE and DEFAULT) |
--no-mesh | Disable mesh step |
--preparation-only | Only prepare project |
--preparation-only-with-images | Only prepare project and input images |
--analysis-only | Only analyze project |
Network Processing | |
-d, --distributed-processing | Enable distributed processing |
--no-distributed-processing | Disable distributed processing (default) |
--network-image-directory <path> | The network location (absolute path) where images will be prepared to. In case of cloud processing this can be a GDAL virtual file system path. (required if --distributed-processing) |
--network-optimized-image-preparation | Force preparation of all images as 8 bit MRFs with compression to optimize file transfer. (default for --distributed-processing) |
--no-network-optimized-image-preparation | Prepare images only if necessary and in original bit depth. (default for --no-distributed-processing) |
--subproject-size <tiles-per-dimension> | Set subproject size for distributed processing. Use default setting for best mesh/DSM mesh texturing performance. (default=auto) |
General Parameters | |
-p, --project-directory <path> | Set project directory (default=.\SURE) |
-s, --scenario <scenario> (<fw-overlap> <sw-overlap>) | Set scenario (DEFAULT, AERIAL_OBLIQUE or AERIAL_NADIR with overlaps, e.g. AERIAL_NADIR 80 60) (default=DEFAULT) |
-q, --quality <quality> | Set quality (ULTRA, HIGH, MEDIUM or LOW). Each reduction in quality level doubles the cell size of the raster products. Exception: scenario DEFAULT with quality HIGH. (default=HIGH for scenario DEFAULT, =ULTRA otherwise) |
-c, --coordinate-system <path> | Set coordinate system from WKT file |
--no-coordinate-system | Remove coordinate system |
-t, --tile-size <size> | Set tile size (default=4000 GSDs for scenario AERIAL_OBLIQUE, =2000 GSDs otherwise) |
--tiling-scheme-origin <x> <y> | Set 2D origin of tiling scheme for the output products. (default=auto) |
--tiling-scheme-origin-3d <x> <y> <z> | Set 3D origin of tiling scheme for the output products. (default=auto) |
--gsd <gsd> | Set GSD (ground sampling distance), which is the cell size for raster products. Should be greater or equal than the automatic value, which depends on --quality. (default=auto) |
-z, --z-range <zmin> <zmax> | Set z range (default=auto) |
-A, --area-shapefile <path> | Set shapefile defining region of interest instead of automatic area shapefile |
--no-area-shapefile | Remove shapefile defining region of interest |
--automatic-area-shapefile | Use automatically generated area shapefile (default) |
--no-automatic-area-shapefile | Do not use automatically generated area shapefile |
-w, --waterbody-shapefile <path> | Set shapefile defining waterbodies |
--waterbody-height-estimation | Enable height estimation for waterbody shapefiles (Beta) (required if waterbody shapefile is only 2D) |
--correction-shapefile <path> | Set shapefile defining corrections for 2.5D results |
--global-color-balancing | Enable global color balancing (default) |
--no-global-color-balancing | Disable global color balancing |
--area-based-image-selection | Enable image selection based on manual area shapefile. Requires defined --z-range or --terrain-height to have an effect (default). |
--no-area-based-image-selection | Disable image selection based on manual area shapefile. |
--terrain-height-for-image-selection <height> | Set manual terrain height for image selection, which is otherwise automatically extracted from the orientation file(s), if available. (default=auto) |
--no-terrain-height-for-image-selection | Ignore terrain height for image selection (manual and auto) |
--las | Set point cloud output format to .las |
--laz | Set point cloud output format to .laz (default) |
--allow-project-reset | Allow the reset of completed processing steps. This may be necessary to resume a project with modified project configuration. Changes to the parameters used in a particular processing step require the repetition of that step and all subsequent steps. |
--cpu | Only allow CPU processing. |
--gpu | Enable GPU (CUDA) processing if possible (default) |
--ignore-earth-curvature | Ignore earth curvature and refraction in Inpho .prj input orientations (required if these corrections are enabled in Inpho .prj orientation file). |
--stereo-models <path> | Set stereo models from connectivity matrix file. It is required to have ones (non-zero values) on the main diagonal for the positions corresponding to the images that have at least one stereo partner. |
--no-automatic-stereo-model-selection | Disable automatic stereo model selection |
2.5D Workflow | |
--output-8-bit-color-in-true-ortho-and-dsm | Output 8 bit per color channel in DSM and true ortho results (default) |
--output-16-bit-color-in-true-ortho-and-dsm | Output 16 bit per color channel in DSM and true ortho results (only for 16bit input images; incompatible with --network-optimized-image-preparation) |
--dsm-required-points-per-cell <minimum-number-of-points> | Set DSM required points per cell (default=auto) |
--dsm-depth-buffer <buffer-size> | Set DSM depth buffer size (default=auto) |
--dsm-binary-mask | Enable export of DSM binary mask image for non-interpolated pixels |
--dsm-point-color | Enable export of DSM with point colors |
--dsm-distance-map | Enable export of DSM distance map to next non-interpolated pixel |
--dsm-point-model-count | Enable export of DSM point (=measurement) stereo model count |
--additional-tfws | Enable export of additional .tfw files (default) |
--no-additional-tfws | Disable export of additional .tfw files |
--image-pyramids-in-tiffs | Enable export of image pyramids in .tif files (default) |
--no-image-pyramids-in-tiffs | Disable export of image pyramids in .tif files |
--true-ortho-enhance-texture | Enhance True Ortho texture |
--no-true-ortho-enhance-texture | Disable enhancement of True Ortho texture (default) |
--true-ortho-5-0 | Generate SURE 5.0 True Ortho version |
--no-true-ortho-5-0 | Generate default True Ortho version (default) |
Mesh Parameters | |
-m, --mesh-formats <format> [<format> ...] | Set mesh formats (osgb, 3d_tiles, slpk obj, local_obj) (default=osgb) |
--3d-tiles-over-impose-heights-on-target-ellipsoid | Over-impose heights on 3D Tiles target ellipsoid |
--no-3d-tiles-over-impose-heights-on-target-ellipsoid | Do not over-impose heights on target ellipsoid (default) |
--mesh-enhance-texture | Enhance mesh/DSM mesh texture (default) |
--no-mesh-enhance-texture | Disable enhancement of mesh/DSM mesh texture |
--mesh-force-export-single-file | Force exporting non-lod formats as single mesh file. This functionality should only be enabled for small meshes (e.g. up to 16000x16000 GSDs). These formats do not allow for a level of detail structure needed for performant rendering of large meshes. The memory usage of this functionality increases with the mesh size. If you would like to export large non-LOD meshes, please export them in a tiled fashion. |
--no-mesh-force-export-single-file | Do not force exporting non-lod formats as single mesh file (default) |
Other | |
--gui <project-file-path> | Open project with GUI (incompatible with all other options, except --no-update) |
--no-update | Avoid automatic update |
--activate <license-key> | Activate a license |
--activate-trial <license-key> | Activate a trial license |
-v, --version | Print version and license details |
-h, --help | Print this help |