Skip to content

Run Time Parameters

Dakota Benjamin edited this page Aug 9, 2016 · 12 revisions

There are the following run time parameters that can be used to adjust the results.

-h, --help            show this help message and exit
--project-path <string>
                      Path to the project to process
--resize-to <integer>
                      resizes images by the largest side
--start-with <string>, -s <string>
                      Can be one of: resize | opensfm | cmvs | pmvs | odm_meshing | odm_texturing | odm_georeferencing | odm_orthophoto
--end-with <string>, -e <string>
                      Can be one of:resize | opensfm | cmvs | pmvs | odm_meshing | odm_texturing | odm_georeferencing | odm_orthophoto
--rerun <string>, -r <string>
                      Can be one of:resize | opensfm | cmvs | pmvs | odm_meshing | odm_texturing | odm_georeferencing | odm_orthophoto
--rerun-all           force rerun of all tasks
--rerun-from <string>
                      Can be one of:resize | opensfm | cmvs | pmvs | odm_meshing | odm_texturing | odm_georeferencing | odm_orthophoto
--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-threshold <percent>
                      Ignore matched keypoints if the two images share less than <float> percent of keypoints.
                      Default: 2.0
--matcher-ratio <float>
                      Ratio of the distance to the next best matched
                      keypoint. Default: 0.6
--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 to 0 to skip pre-matching.
                      Default: 0
--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 reconstructions
                      Default: 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-minImageNum <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
--odm_meshing-maxVertexCount <positive integer>
                      The maximum vertex count of the output mesh
                      Default: 100000
--odm_meshing-octreeDepth <positive integer>
                      Oct-tree depth used in the mesh reconstruction, increase to get more vertices, recommended values are 8-12.
                      Default: 9
--odm_meshing-samplesPerNode <float >= 1.0>
                      Number of points per octree node, recommended value: 1.0
                      Default: 1.0
--odm_meshing-solverDivide <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
--odm_texturing-textureResolution <positive integer>
                      The resolution of the output textures. Must be greater than textureWithSize.
                      Default: 4096
--odm_texturing-textureWithSize <positive integer>
                      The resolution to rescale the images performing the texturing.
                      Default: 3600
--odm_georeferencing-gcpFile <path string>
                      path to the file containing the ground control points used for georeferencing. Default: gcp_list.txt. The file needs to be on the following line format:
                      easting northing height pixelrow pixelcol imagename
--odm_georeferencing-useGcp
                      Enabling GCPs from the file above. The GCP file is not used by default.
--odm_orthophoto-resolution <float > 0.0>
                      Orthophoto ground resolution in pixels/meter
                      Default: 20.0
--zip-results         compress the results using gunzip
--time                Generates a benchmark file with runtime info
                      Default: False

Use the parameters in the following way

./run.py --odm_meshing-maxVertexCount 110000 --odm_meshing-octreeDepth 11 …etc

More documentation on cmvs and pmvs available here:
http://www.di.ens.fr/cmvs/documentation.html
http://www.di.ens.fr/pmvs/documentation.html