diff --git a/source/arguments.rst b/source/arguments.rst index 005a7609c..bf0bceb15 100644 --- a/source/arguments.rst +++ b/source/arguments.rst @@ -12,7 +12,8 @@ Arguments:: Path to the project folder --resize-to resizes images by the largest side for opensfm. Set to - -1 to disable. Default: 2048 + -1 to disable. + Default: 2048 --end-with , -e Can be one of:dataset | split | merge | opensfm | mve | odm_filterpoints | odm_meshing | mvs_texturing | @@ -26,9 +27,6 @@ Arguments:: Can be one of:dataset | split | merge | opensfm | mve | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto - --video Path to the video file to process - --slam-config - Path to config file for orb-slam --proj Projection used to transform the model into geographic coordinates @@ -42,33 +40,40 @@ Arguments:: 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 + value, prefering the Neighbors parameter. + Default: 8 --matcher-distance 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 + neighbors and this to 0 to skip pre-matching. + Default: 0 --use-fixed-camera-params Turn off camera parameter optimization during bundler + Off by default unless --camera parameter used --max-concurrency The maximum number of processes to use in various processes. Peak memory requirement is ~1GB per thread - and 2 megapixel image resolution. Default: 4 + and 2 megapixel image resolution. + Default: number of cores --depthmap-resolution Controls the density of the point cloud by setting the resolution of the depthmap images. Higher values take - longer to compute but produce denser point clouds. + longer to compute and more memory but produce denser + point clouds. Default: 640 --opensfm-depthmap-min-consistent-views Minimum number of views that should reconstruct a point for it to be valid. Use lower values if your images have less overlap. Lower values result in - denser point clouds but with more noise. Default: 3 + denser point clouds but with more noise. Only applies + if using OpenSfM for dense matching. + Default: 3 --opensfm-depthmap-method Raw depthmap computation algorithm. PATCH_MATCH and PATCH_MATCH_SAMPLE are faster, but might miss some valid points. BRUTE_FORCE takes longer but produces - denser reconstructions. Default: PATCH_MATCH + denser reconstructions. + Default: PATCH_MATCH --opensfm-depthmap-min-patch-sd When using PATCH_MATCH or PATCH_MATCH_SAMPLE, controls the standard deviation threshold to include patches. @@ -83,7 +88,8 @@ Arguments:: Discard points that have less than a certain confidence threshold. This only affects dense reconstructions performed with MVE. Higher values - discard more points. Default: 0.6 + discard more points. + Default: 0.6 --use-3dmesh Use a full 3D mesh to compute the orthophoto instead of a 2.5D mesh. This option is a bit faster and provides similar results in planar areas. @@ -98,22 +104,24 @@ Arguments:: sometimes ignoring it can result in slightly better image output quality. --mesh-size - The maximum vertex count of the output mesh. Default: - 100000 + The maximum vertex count of the output mesh. + Default: 100000 --mesh-octree-depth Oct-tree depth used in the mesh reconstruction, increase to get more vertices, recommended values are - 8-12. Default: 9 + 8-12. + Default: 9 --mesh-samples = 1.0> Number of points per octree node, recommended and - default value: 1.0 + Default: 1.0 --mesh-point-weight This floating point value specifies the importance that interpolation of the point samples is given in the formulation of the screened Poisson equation. The results of the original (unscreened) Poisson Reconstruction can be obtained by setting this value - to 0.Default= 4 + to 0. + Default: 4 --fast-orthophoto Skips dense reconstruction and 3D model generation. It generates an orthophoto directly from the sparse reconstruction. If you just need an orthophoto and do @@ -122,7 +130,8 @@ Arguments:: --crop Automatically crop image outputs by creating a smooth buffer around the dataset boundaries, shrinked by N - meters. Use 0 to disable cropping. Default: 3 + meters. Use 0 to disable cropping. + Default: 3 --pc-classify Classify the point cloud outputs using a Simple Morphological Filter. You can control the behavior of this option by tweaking the --dem-* parameters. @@ -134,46 +143,58 @@ Arguments:: --pc-filter Filters the point cloud by removing points that deviate more than N standard deviations from the local - mean. Set to 0 to disable filtering. Default: 2.5 + mean. Set to 0 to disable filtering. + Default: 2.5 --smrf-scalar Simple Morphological Filter elevation scalar - parameter. Default: 1.25 + parameter. + Default: 1.25 --smrf-slope Simple Morphological Filter slope parameter (rise over - run). Default: 0.15 + run). + Default: 0.15 --smrf-threshold Simple Morphological Filter elevation threshold - parameter (meters). Default: 0.5 + parameter (meters). + Default: 0.5 --smrf-window Simple Morphological Filter window radius parameter - (meters). Default: 18.0 + (meters). + Default: 18.0 --texturing-data-term - Data term: [area, gmi]. Default: gmi + Data term: [area, gmi]. + Default: gmi --texturing-nadir-weight Affects orthophotos only. Higher values result in sharper corners, but can affect color distribution and blurriness. Use lower values for planar areas and higher values for urban areas. The default value works - well for most scenarios. Default: 16 + well for most scenarios. + Default: 16 --texturing-outlier-removal-type Type of photometric outlier removal method: [none, - gauss_damping, gauss_clamping]. Default: - gauss_clamping + gauss_damping, gauss_clamping]. + Default: gauss_clamping --texturing-skip-visibility-test - Skip geometric visibility test. Default: False + Skip geometric visibility test. + Default: False --texturing-skip-global-seam-leveling - Skip global seam leveling. Useful for IR data.Default: - False + Skip global seam leveling. Useful for IR data. + Default: False --texturing-skip-local-seam-leveling - Skip local seam blending. Default: False + Skip local seam blending. + Default: False --texturing-skip-hole-filling - Skip filling of holes in the mesh. Default: False + 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 + camera. + Default: False --texturing-tone-mapping Turn on gamma tone mapping or none for no tone - mapping. Choices are 'gamma' or 'none'. Default: none + mapping. Choices are 'gamma' or 'none'. + Default: none --gcp 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 @@ -194,20 +215,25 @@ Arguments:: 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=3 + neighbor interpolation. + Default: 3 --dem-resolution - DSM/DTM resolution in cm / pixel. Default: 5 + DSM/DTM resolution in cm / pixel. + Default: 5 --dem-decimation 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 + points. Useful for speeding up generation. + Default: 1 --dem-euclidean-map Computes an euclidean raster map for each DEM. The map reports the distance from each cell to the nearest NODATA value (before any hole filling takes place). This can be useful to isolate the areas that have been - filled. Default: False + filled. + Default: False --orthophoto-resolution 0.0> - Orthophoto resolution in cm / pixel. Default: 5 + Orthophoto resolution in cm / pixel. + Default: 5 --orthophoto-no-tiled Set this parameter if you want a stripped geoTIFF. Default: False @@ -226,12 +252,13 @@ Arguments:: --orthophoto-cutline Generates a polygon around the cropping area that cuts the orthophoto around the edges of features. This polygon can be useful for stitching seamless mosaics - with multiple overlapping orthophotos. Default: False + with multiple overlapping orthophotos. + Default: False --build-overviews Build orthophoto overviews using gdaladdo. - --verbose, -v Print additional messages to the console Default: - False - --time Generates a benchmark file with runtime info Default: - False + --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. --split Average number of images per submodel. When splitting @@ -245,7 +272,7 @@ Arguments:: cluster. This is done to ensure that neighboring submodels overlap. --sm-cluster - URL to a nodeodm-proxy instance for distributing a + URL to a ClusterODM instance for distributing a split-merge workflow on multiple nodes in parallel. Default: None --merge Choose what to merge in the merge step in a split diff --git a/source/large.rst b/source/large.rst index 677e1c018..264d0c17a 100644 --- a/source/large.rst +++ b/source/large.rst @@ -142,7 +142,7 @@ While a process is running, it is also possible to list the tasks, and view the # TASK OUTPUT [lines] Autoscaling ClusterODM -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ ClusterODM also includes the option to autoscale on multiple platforms, including, to date, Amazon and Digital Ocean. This allows users to reduce costs associated with always-on instances as well as being able to scale processing based on demand.