-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Run Time Parameters
Dakota Benjamin edited this page Dec 19, 2017
·
12 revisions
There are the following run time parameters that can be used to adjust the results. Note that these are for the `master` branch and may not be reflected in your build. Check `python run.py —help`.
usage: run.py [options] <project name>
OpenDroneMap
positional arguments:
<project name> Name of Project (i.e subdirectory of projects folder)
optional arguments:
-h, --help show this help message and exit
--images <path>, -i <path>
Path to input images
--project-path <path>
Path to the project folder
--resize-to <integer>
resizes images by the largest side for opensfm. Set to
-1 to disable. Default: 2048
--start-with <string>, -s <string>
Can be one of: resize | opensfm | slam | cmvs | pmvs |
odm_meshing | odm_25dmeshing | mvs_texturing |
odm_georeferencing | odm_dem | odm_orthophoto
--end-with <string>, -e <string>
Can be one of:resize | opensfm | slam | cmvs | pmvs |
odm_meshing | odm_25dmeshing | mvs_texturing |
odm_georeferencing | odm_dem | odm_orthophoto
--rerun <string>, -r <string>
Can be one of:resize | opensfm | slam | cmvs | pmvs |
odm_meshing | odm_25dmeshing | mvs_texturing |
odm_georeferencing | odm_dem | odm_orthophoto
--rerun-all force rerun of all tasks
--rerun-from <string>
Can be one of:resize | opensfm | slam | cmvs | pmvs |
odm_meshing | odm_25dmeshing | mvs_texturing |
odm_georeferencing | odm_dem | odm_orthophoto
--video <string> Path to the video file to process
--slam-config <string>
Path to config file for orb-slam
--force-focal <positive float>
Override the focal length information for the images
--force-ccd <positive float>
Override the ccd width information for the images
--min-num-features <integer>
Minimum number of features to extract per image. More
features leads to better results but slower execution.
Default: 4000
--matcher-neighbors <integer>
Number of nearest images to pre-match based on GPS
exif data. Set to 0 to skip pre-matching. Neighbors
works together with Distance parameter, set both to 0
to not use pre-matching. OpenSFM uses both parameters
at the same time, Bundler uses only one which has
value, prefering the Neighbors parameter. Default: 8
--matcher-distance <integer>
Distance threshold in meters to find pre-matching
images based on GPS exif data. Set both matcher-
neighbors and this to 0 to skip pre-matching. Default:
0
--use-fixed-camera-params
Turn off camera parameter optimization during bundler
--opensfm-processes <positive integer>
The maximum number of processes to use in dense
reconstruction. Default: 16
--use-hybrid-bundle-adjustment
Run local bundle adjustment for every image added to
the reconstruction and a global adjustment every 100
images. Speeds up reconstruction for very large
datasets.
--use-25dmesh Use a 2.5D mesh to compute the orthophoto. This option
tends to provide better results for planar surfaces.
Experimental.
--use-pmvs Use pmvs to compute point cloud alternatively
--cmvs-maxImages <integer>
The maximum number of images per cluster. Default: 500
--pmvs-level <positive integer>
The level in the image pyramid that is used for the
computation. see
http://www.di.ens.fr/pmvs/documentation.html for more
pmvs documentation. Default: 1
--pmvs-csize <positive integer>
Cell size controls the density of
reconstructionsDefault: 2
--pmvs-threshold <float: -1.0 <= x <= 1.0>
A patch reconstruction is accepted as a success and
kept if its associated photometric consistency measure
is above this threshold. Default: 0.7
--pmvs-wsize <positive integer>
pmvs samples wsize x wsize pixel colors from each
image to compute photometric consistency score. For
example, when wsize=7, 7x7=49 pixel colors are sampled
in each image. Increasing the value leads to more
stable reconstructions, but the program becomes
slower. Default: 7
--pmvs-min-images <positive integer>
Each 3D point must be visible in at least minImageNum
images for being reconstructed. 3 is suggested in
general. Default: 3
--pmvs-num-cores <positive integer>
The maximum number of cores to use in dense
reconstruction. Default: 16
--mesh-size <positive integer>
The maximum vertex count of the output mesh Default:
100000
--mesh-octree-depth <positive integer>
Oct-tree depth used in the mesh reconstruction,
increase to get more vertices, recommended values are
8-12. Default: 9
--mesh-samples <float >= 1.0>
Number of points per octree node, recommended and
default value: 1.0
--mesh-solver-divide <positive integer>
Oct-tree depth at which the Laplacian equation is
solved in the surface reconstruction step. Increasing
this value increases computation times slightly but
helps reduce memory usage. Default: 9
--mesh-remove-outliers <percent>
Percentage of outliers to remove from the point set.
Set to 0 to disable. Applies to 2.5D mesh only.
Default: 2
--mesh-wlop-iterations <positive integer>
Iterations of the Weighted Locally Optimal Projection
(WLOP) simplification algorithm. Higher values take
longer but produce a smoother mesh. Applies to 2.5D
mesh only. Default: 35
--texturing-data-term <string>
Data term: [area, gmi]. Default: gmi
--texturing-outlier-removal-type <string>
Type of photometric outlier removal method: [none,
gauss_damping, gauss_clamping]. Default:
gauss_clamping
--texturing-skip-visibility-test
Skip geometric visibility test. Default: False
--texturing-skip-global-seam-leveling
Skip global seam leveling. Useful for IR data.Default:
False
--texturing-skip-local-seam-leveling
Skip local seam blending. Default: False
--texturing-skip-hole-filling
Skip filling of holes in the mesh. Default: False
--texturing-keep-unseen-faces
Keep faces in the mesh that are not seen in any
camera. Default: False
--texturing-tone-mapping <string>
Turn on gamma tone mapping or none for no tone
mapping. Choices are 'gamma' or 'none'. Default: none
--gcp <path string> path to the file containing the ground control points
used for georeferencing. Default: None. The file needs
to be on the following line format: easting northing
height pixelrow pixelcol imagename
--use-exif Use this tag if you have a gcp_list.txt but want to
use the exif geotags instead
--dtm Use this tag to build a DTM (Digital Terrain Model,
ground only) using a progressive morphological filter.
Check the --dem* parameters for fine tuning.
--dsm Use this tag to build a DSM (Digital Surface Model,
ground + objects) using a progressive morphological
filter. Check the --dem* parameters for fine tuning.
--dem-gapfill-steps <positive integer>
Number of steps used to fill areas with gaps. Set to 0
to disable gap filling. Starting with a radius equal
to the output resolution, N different DEMs are
generated with progressively bigger radius using the
inverse distance weighted (IDW) algorithm and merged
together. Remaining gaps are then merged using nearest
neighbor interpolation. Default=4
--dem-resolution <float>
Length of raster cell edges in meters. Default: 0.1
--dem-maxangle <positive float>
Points that are more than maxangle degrees off-nadir
are discarded. Default: 20
--dem-maxsd <positive float>
Points that deviate more than maxsd standard
deviations from the local mean are discarded. Default:
2.5
--dem-initial-distance <positive float>
Used to classify ground vs non-ground points. Set this
value to account for Z noise in meters. If you have an
uncertainty of around 15 cm, set this value large
enough to not exclude these points. Too small of a
value will exclude valid ground points, while too
large of a value will misclassify non-ground points
for ground ones. Default: 0.15
--dem-approximate Use this tag use the approximate progressive
morphological filter, which computes DEMs faster but
is not as accurate.
--dem-decimation <positive integer>
Decimate the points before generating the DEM. 1 is no
decimation (full quality). 100 decimates ~99% of the
points. Useful for speeding up generation. Default=1
--dem-terrain-type <string>
One of: FlatNonForest, FlatForest, ComplexNonForest,
ComplexForest. Specifies the type of terrain. This
mainly helps reduce processing time. FlatNonForest:
Relatively flat region with little to no vegetation
FlatForest: Relatively flat region that is forested
ComplexNonForest: Varied terrain with little to no
vegetation ComplexForest: Varied terrain that is
forested Default=ComplexForest
--orthophoto-resolution <float > 0.0>
Orthophoto ground resolution in pixels/meterDefault:
20.0
--orthophoto-target-srs <EPSG:XXXX>
Target spatial reference for orthophoto creation. Not
implemented yet. Default: None
--orthophoto-no-tiled
Set this parameter if you want a stripped geoTIFF.
Default: False
--orthophoto-compression <string>
Set the compression to use. Note that this could break
gdal_translate if you don't know what you are doing.
Options: JPEG, LZW, PACKBITS, DEFLATE, LZMA, NONE.
Default: DEFLATE
--orthophoto-bigtiff {YES,NO,IF_NEEDED,IF_SAFER}
Control whether the created orthophoto is a BigTIFF or
classic TIFF. BigTIFF is a variant for files larger
than 4GiB of data. Options are YES, NO, IF_NEEDED,
IF_SAFER. See GDAL specs:
https://www.gdal.org/frmt_gtiff.html for more info.
Default: IF_SAFER
--build-overviews Build orthophoto overviews using gdaladdo.
--zip-results compress the results using gunzip
--verbose, -v Print additional messages to the console Default:
False
--time Generates a benchmark file with runtime info Default:
False
--version Displays version number and exits.
More documentation on cmvs and pmvs available here:
http://www.di.ens.fr/cmvs/documentation.html
http://www.di.ens.fr/pmvs/documentation.html