OpenDroneMap-docs/source/arguments.rst

1824 wiersze
36 KiB
ReStructuredText

..
AUTO-GENERATED by extract_odm_strings.py! DO NOT EDIT!
If you want to add more details to a command, edit a
.rst file in arguments_edit/<argument>.rst
#################
Options and Flags
#################
If you want to add more details to a command, `learn to edit <https://github.com/opendronemap/docs#how-to-make-your-first-contribution>`_ and help improve the matching file in the ``arguments_edit`` `project folder <https://github.com/OpenDroneMap/docs/tree/publish/source/arguments_edit>`_!
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*************
auto-boundary
*************
Automatically set a boundary using camera shot locations to limit the area of the reconstruction. This can help remove far away background artifacts (sky, background landscapes, etc.). See also --boundary. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
********
boundary
********
**Options:** *<json>*
GeoJSON polygon limiting the area of the reconstruction. Can be specified either as path to a GeoJSON file or as a JSON string representing the contents of a GeoJSON file. Default: ``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***************
build-overviews
***************
Build orthophoto overviews for faster display in programs such as QGIS. Default: ``False``
| Parameter Type:
| **Boolean**
| Parameter Domain:
| True: ``--build-overviews``
| False: ``null``
| Parameter Default:
| False: ``null``
----
======== ========
Resource Impact
======== ========
CPU ●●○ | Medium
GPU ○○○ | None
HDD ●●○ | Medium
RAM ●●○ | Medium
Time ●●○ | Medium
======== ========
----
What Are Overviews?
-------------------
Overviews (sometimes referred to as pyramids) are an optimization that reduce the time it takes to render GeoTIFF files; Larger file-size is the tradeoff for this increased rendering performance.
Overviews are lower-resolution copies of the raster data (Power of two factor [128x128, 256x256, etc]) that are stored either internally or externally in a sidecar.
In the case of OpenDroneMap, the Overviews will always be internal.
When are Overviews appropriate?
-------------------------------
One would likely want to use Overviews for nearly every instance, with some few (relatively rare) exceptions.
* Small File Size is paramount
* Reading software does not support internal Overviews
Why would one use Overviews?
----------------------------
Overviews speed preview of the raster data by allowing the program rendering the raster to choose the closest size pyramid to match the resolution of the display extent that it is being rendered into, potentially saving a significant amount of time retrieving the full-size raster, buffering it, and then downscaling it for display.
In the case of WebODM, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map.
Example Images
--------------
True: ``--build-overviews``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127073339-6b2a0a4f-6ede-4dc1-8da4-5bc9646de304.png
:alt: QGIS displaying the generated Overviews
The Layer Properties panel demonstrates that this OpenDroneMap-generated GeoTIFF has internal Overviews.
False: ``null``
^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127074349-a3f84c4c-d05c-4bf1-bd7c-790781ad0fe3.png
:alt: QGIS displaying the file is lacking Overviews
The Layer Properties panel demonstrates that this OpenDroneMap-generated GeoTIFF lacks internal Overviews.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********
camera-lens
***********
**Options:** *auto | perspective | brown | fisheye | spherical*
Set a camera projection type. Manually setting a value can help improve geometric undistortion. By default the application tries to determine a lens type from the images metadata. . Default: ``auto``
| Parameter Type:
| **String**
| Parameter Domain:
| ``auto`` : Automatic selection of best camera projection model.
| ``brown`` : Robust rectilinear projection model. Preferred by ``auto``.
| ``fisheye`` : Wide-angle / non-rectilinear projection model.
| ``perspective`` : Legacy rectilinear projection model.
| ``spherical`` : 360° camera projection model.
| Parameter Default:
| ``auto``
----
======== ========
Resource Impact
======== ========
CPU ●○○ | Low
GPU ○○○ | None
HDD ●○○ | Low
RAM ●○○ | Low
Time ●○○ | Low
======== ========
----
What Are Camera Lens Models?
----------------------------
Camera Lens Models are projection/distortion models that OpenSFM uses to correct for the optics of the camera platforms that record our images. These corrections are essential for proper camera/scene modeling, and therefore, proper reconstruction of the data.
When are manual selections appropriate?
---------------------------------------
Manually choosing a Camera Lens Model is currently only recommended in the case of Spherical Cameras (GoPro Fusion, GoPro Max, Insta360, Kodak PixPro, etc.) as these are currently not detected automatically by OpenSFM.
Why would one use a particular Camera Lens Model?
-------------------------------------------------
In rare cases, OpenSFM may not be able to detect (or retrieve from its Camera database) the correct Camera Lens Model for your particular sensor, in which case you should select the closest appropriate model. When in doubt, try specifying ``brown`` first.
Example Images
--------------
The following examples are all data taken with a standard Rectilinear Lens. Manual selection of the various Camera Lens Models is demonstrated to show some differences in how this will affect reconstruction.
``auto`` : Rectilinear Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127077336-ae79a958-a953-4376-86fd-430d0e5457f2.png
:alt: Rectilinear data rendered by ``auto`` Camera Lens Model
This Point Cloud shows a proper reconstruction via the ``auto`` (``brown``) Camera Lens Model, which is appropriate for this sensor.
``brown`` : Rectilinear Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127077753-580a174e-7572-4315-8801-224ce097d9fc.png
:alt: Rectilinear data rendered by ``brown`` Camera Lens Model
As in the prior example, this Point Cloud is reconstructed via the ``brown`` Camera Lens Model.
``fisheye`` : Rectilinear Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127077826-53d459fe-5e4e-4b10-8e70-fbddf775c4f7.png
:alt: Rectilinear data rendered by ``fisheye`` Camera Lens Model
In this Point Cloud reconstruction, severe bowling and other artifacts have been introduced via the use of the wrong Camera Lens Model.
``perspective`` : Rectilinear Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127077485-699f9e61-72a6-45f2-990f-f5748b6ee99f.png
:alt: Rectilinear data rendered by ``perspective`` Camera Lens Model
This Point Cloud rendered well, very similar to the ``auto`` and ``brown`` examples. One may see artifacts in the ``perspective`` Camera Lens Model in very large collections, or over very flat/homogenus terrain (agricultural fields). In such cases, forcing ``brown`` may help.
``spherical`` : Rectilinear Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127078960-27e35cbb-a378-4d0d-92e2-42dbfd1edd7c.png
:alt: Rectilinear data rendered by ``spherical`` Camera Lens Model
This Point Cloud failed to reconstruct properly due to the manual selection of the ``fisheye`` Camera Lens Model. Similar failures to reconstruct can often indicate the wrong manual selection, or in edge cases, wrong ``auto`` selection of the Camera Lens Model, and you are advised to try another Model that is more appropriate.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******
cameras
*******
**Options:** *<json>*
Use the camera parameters computed from another dataset instead of calculating them. Can be specified either as path to a cameras.json file or as a JSON string representing the contents of a cameras.json file. Default: ``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***
cog
***
Create Cloud-Optimized GeoTIFFs instead of normal GeoTIFFs. Default: ``False``
| Parameter Type:
| **Boolean**
| Parameter Domain:
| True: ``--cog``
| False: ``null``
| Parameter Default:
| False: ``null``
----
======== ========
Resource Impact
======== ========
CPU ●●○ | Medium
GPU ○○○ | None
HDD ●●○ | Medium
RAM ●●○ | Medium
Time ●●○ | Medium
======== ========
----
What Are Cloud Optimized GeoTIFFs (COGs)?
------------------------------------------
Cloud Optimized GeoTIFFs (COGs hereafter) are a special formulation of GeoTIFF files that take advantage of internal overivews as well as tiling (and various forms of compression).
In the case of WebODM, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by WebODM.
When are COGs appropriate?
---------------------------
COGs are most appropriate when the GeoTIFF is going to be hosted online and/or accessed by a program which can take advantage of HTTP GetRange Requests and/or internal overviews and tiles.
Why would one use COGs?
----------------------------
The COG structure (internal overviews and tiling) allows for rapid viewing of the data in programs which are capable of reading tiled data and overviews (most GIS software [QGIS etc]). This advantage holds true whether or not the file is hosted online and served via HTTP or whether it is stored locally.
With these features in place, a COG should display much more quickly in a given application than a more legacy formatted GeoTIFF with no overviews and striped structure.
Example Images
---------------
True: ``--cog``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127079824-c85fa5a9-842a-4f28-a380-b6404aac7ef2.png
:alt: GDAL Info showing LAYOUT=COG
The Raster Information tool in QGIS can print information from gdalinfo which can be used to confirm the conformance of a GeoTIFF to the COG spec.
.. figure:: https://user-images.githubusercontent.com/19295950/138731905-d10483bd-b91b-4f63-bfb4-89c0f50bf74b.png
:alt: QGIS Layer Properties showing Internal Overviews
The Layer Properties panel can show that there are in fact internal overviews. Keep in mind that not every GeoTIFF has internal overviews, but every COG must.
.. figure:: https://user-images.githubusercontent.com/19295950/138733095-fb5f07ef-fbb0-48f4-8401-25cbf5294b9d.png
:alt: QGIS Layer Properties showing an on-disk file size of 8.78 MB
Note that the on-disk file size is 8.78 MB for the COG due to the presence of internal overviews when compared to the 6.30 MB of the non-COG GeoTIFF below.
False: ``null``
^^^^^^^^^^^^^^^
.. figure:: https://user-images.githubusercontent.com/19295950/127080115-7e09ba30-140f-402d-b00a-8bb0c7bc72ff.png
:alt: GDAL Info not showing LAYOUT=COG
The Raster Information tool in QGIS does not show LAYOUT=COG, which indicates that this GeoTIFF does not meet the COG spec.
.. figure:: https://user-images.githubusercontent.com/19295950/138732051-d227c98d-10a5-46de-ac99-8c5ffb0a12b2.png
:alt: QGIS Layer Properties not showing Internal Overviews
The Layer Properties panel shows that the GeoTIFF lacks all levels of Internal Pyramids.
.. figure:: https://user-images.githubusercontent.com/19295950/138733132-a9c4f8b4-673a-426b-a665-bde5e89e4de3.png
:alt: QGIS Layer Properties showing an on-disk file size of 6.30 MB
Note that the on-disk file size is 6.30 MB for the COG due to the lack of internal overviews when compared to the 8.78 MB of the COG GeoTIFF above.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******
copy-to
*******
**Options:** *<path>*
Copy output results to this folder after processing.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****
crop
****
**Options:** *<positive float>*
Automatically crop image outputs by creating a smooth buffer around the dataset boundaries, shrinked by N meters. Use 0 to disable cropping. Default: ``3``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****
debug
*****
Print debug messages. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**************
dem-decimation
**************
**Options:** *<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 of DEM results in very large datasets. Default: ``1``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****************
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``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****************
dem-gapfill-steps
*****************
**Options:** *<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: ``3``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**************
dem-resolution
**************
**Options:** *<float>*
DSM/DTM resolution in cm / pixel. Note that this value is capped by a ground sampling distance (GSD) estimate. To remove the cap, check --ignore-gsd also. Default: ``5``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******************
depthmap-resolution
*******************
**Options:** *<positive float>*
Legacy option (use --pc-quality instead). 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. Default: ``640``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***
dsm
***
Use this tag to build a DSM (Digital Surface Model, ground + objects) using a progressive morphological filter. Check the --dem\* parameters for finer tuning. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***
dtm
***
Use this tag to build a DTM (Digital Terrain Model, ground only) using a simple morphological filter. Check the --dem\* and --smrf\* parameters for finer tuning. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
********
end-with
********
**Options:** *dataset | split | merge | opensfm | openmvs | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto | odm_report | odm_postprocess*
End processing at this stage. . Default: ``odm_postprocess``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***************
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 not need a full 3D model, turn on this option. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***************
feature-quality
***************
**Options:** *ultra | high | medium | low | lowest*
Set feature extraction quality. Higher quality generates better features, but requires more memory and takes longer. . Default: ``high``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
feature-type
************
**Options:** *sift | orb | hahog*
Choose the algorithm for extracting keypoints and computing descriptors. . Default: ``sift``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********
force-gps
*********
Use images' GPS exif data for reconstruction, even if there are GCPs present.This flag is useful if you have high precision GPS measurements. If there are no GCPs, this flag does nothing. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***
gcp
***
**Options:** *<path string>*
Path to the file containing the ground control points used for georeferencing. The file needs to use the following format: EPSG:<code> or <+proj definition>geo_x geo_y geo_z im_x im_y image_name [gcp_name] [extra1] [extra2]Default: ``None``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***
geo
***
**Options:** *<path string>*
Path to the image geolocation file containing the camera center coordinates used for georeferencing. Note that omega/phi/kappa are currently not supported (you can set them to 0). The file needs to use the following format: EPSG:<code> or <+proj definition>image_name geo_x geo_y geo_z [omega (degrees)] [phi (degrees)] [kappa (degrees)] [horz accuracy (meters)] [vert accuracy (meters)]Default: ``None``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
gps-accuracy
************
**Options:** *<positive float>*
Set a value in meters for the GPS Dilution of Precision (DOP) information for all images. If your images are tagged with high precision GPS information (RTK), this value will be automatically set accordingly. You can use this option to manually set it in case the reconstruction fails. Lowering this option can sometimes help control bowling-effects over large areas. Default: ``10``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****
help
****
show this help message and exit
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
ignore-gsd
**********
Ignore Ground Sampling Distance (GSD). GSD caps the maximum resolution of image outputs and resizes images when necessary, resulting in faster processing and lower memory usage. Since GSD is an estimate, sometimes ignoring it can result in slightly better image output quality. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****************
matcher-distance
****************
**Options:** *<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``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****************
matcher-neighbors
*****************
**Options:** *<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. Default: ``8``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
matcher-type
************
**Options:** *flann | bow*
Matcher algorithm, Fast Library for Approximate Nearest Neighbors or Bag of Words. FLANN is slower, but more stable. BOW is faster, but can sometimes miss valid matches. . Default: ``flann``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***************
max-concurrency
***************
**Options:** *<positive integer>*
The maximum number of processes to use in various processes. Peak memory requirement is ~1GB per thread and 2 megapixel image resolution. Default: ``4``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****
merge
*****
**Options:** *all | pointcloud | orthophoto | dem*
Choose what to merge in the merge step in a split dataset. By default all available outputs are merged. Options: ['all', 'pointcloud', 'orthophoto', 'dem']. Default: ``all``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****************
mesh-octree-depth
*****************
**Options:** *<integer: 1 <= x <= 14>*
Octree depth used in the mesh reconstruction, increase to get more vertices, recommended values are 8-12. Default: ``11``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********
mesh-size
*********
**Options:** *<positive integer>*
The maximum vertex count of the output mesh. Default: ``200000``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****************
min-num-features
****************
**Options:** *<integer>*
Minimum number of features to extract per image. More features can be useful for finding more matches between images, potentially allowing the reconstruction of areas with little overlap or insufficient features. More features also slow down processing. Default: ``8000``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****
name
****
**Options:** *<dataset name>*
Name of dataset (i.e subfolder name within project folder). Default: ``code``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******************
optimize-disk-space
*******************
Delete heavy intermediate files to optimize disk space usage. This affects the ability to restart the pipeline from an intermediate stage, but allows datasets to be processed on machines that don't have sufficient disk space available. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********************
orthophoto-compression
**********************
**Options:** *JPEG | LZW | PACKBITS | DEFLATE | LZMA | NONE*
Set the compression to use for orthophotos. . Default: ``DEFLATE``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
******************
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``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**************
orthophoto-kmz
**************
Set this parameter if you want to generate a Google Earth (KMZ) rendering of the orthophoto. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******************
orthophoto-no-tiled
*******************
Set this parameter if you want a striped GeoTIFF. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**************
orthophoto-png
**************
Set this parameter if you want to generate a PNG rendering of the orthophoto. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********************
orthophoto-resolution
*********************
**Options:** *<float > 0.0>*
Orthophoto resolution in cm / pixel. Note that this value is capped by a ground sampling distance (GSD) estimate. To remove the cap, check --ignore-gsd also. Default: ``5``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********
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. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
******
pc-csv
******
Export the georeferenced point cloud in CSV format. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
******
pc-ept
******
Export the georeferenced point cloud in Entwine Point Tile (EPT) format. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********
pc-filter
*********
**Options:** *<positive float>*
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``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
pc-geometric
************
Improve the accuracy of the point cloud by computing geometrically consistent depthmaps. This increases processing time, but can improve results in urban scenes. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
******
pc-las
******
Export the georeferenced point cloud in LAS format. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
pc-quality
**********
**Options:** *ultra | high | medium | low | lowest*
Set point cloud quality. Higher quality generates better, denser point clouds, but requires more memory and takes longer. Each step up in quality increases processing time roughly by a factor of 4x.. Default: ``medium``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
pc-rectify
**********
Perform ground rectification on the point cloud. This means that wrongly classified ground points will be re-classified and gaps will be filled. Useful for generating DTMs. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********
pc-sample
*********
**Options:** *<positive float>*
Filters the point cloud by keeping only a single point around a radius N (in meters). This can be useful to limit the output resolution of the point cloud and remove duplicate points. Set to 0 to disable sampling. Default: ``0``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******
pc-tile
*******
Reduce the memory usage needed for depthmap fusion by splitting large scenes into tiles. Turn this on if your machine doesn't have much RAM and/or you've set --pc-quality to high or ultra. Experimental. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
primary-band
************
**Options:** *<string>*
When processing multispectral datasets, you can specify the name of the primary band that will be used for reconstruction. It's recommended to choose a band which has sharp details and is in focus. Default: ``auto``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
project-path
************
**Options:** *<path>*
Path to the project folder. Your project folder should contain subfolders for each dataset. Each dataset should have an "images" folder.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********************
radiometric-calibration
***********************
**Options:** *none | camera | camera+sun*
Set the radiometric calibration to perform on images. When processing multispectral and thermal images you should set this option to obtain reflectance/temperature values (otherwise you will get digital number values). [camera] applies black level, vignetting, row gradient gain/exposure compensation (if appropriate EXIF tags are found) and computes absolute temperature values. [camera+sun] is experimental, applies all the corrections of [camera], plus compensates for spectral radiance registered via a downwelling light sensor (DLS) taking in consideration the angle of the sun. . Default: ``none``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****
rerun
*****
**Options:** *dataset | split | merge | opensfm | openmvs | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto | odm_report | odm_postprocess*
Rerun this stage only and stop. . Default: ``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********
rerun-all
*********
Permanently delete all previous results and rerun the processing pipeline.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
rerun-from
**********
**Options:** *dataset | split | merge | opensfm | openmvs | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto | odm_report | odm_postprocess*
Rerun processing from this stage. . Default: ``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*********
resize-to
*********
**Options:** *<integer>*
Legacy option (use --feature-quality instead). Resizes images by the largest side for feature extraction purposes only. Set to -1 to disable. This does not affect the final orthophoto resolution quality and will not resize the original images. Default: ``2048``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
************
skip-3dmodel
************
Skip generation of a full 3D model. This can save time if you only need 2D results such as orthophotos and DEMs. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******************
skip-band-alignment
*******************
When processing multispectral datasets, ODM will automatically align the images for each band. If the images have been postprocessed and are already aligned, use this option. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********
skip-report
***********
Skip generation of PDF report. This can save time if you don't need a report. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
sm-cluster
**********
**Options:** *<string>*
URL to a ClusterODM instance for distributing a split-merge workflow on multiple nodes in parallel. Default: ``None``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********
smrf-scalar
***********
**Options:** *<positive float>*
Simple Morphological Filter elevation scalar parameter. Default: ``1.25``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
smrf-slope
**********
**Options:** *<positive float>*
Simple Morphological Filter slope parameter (rise over run). Default: ``0.15``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**************
smrf-threshold
**************
**Options:** *<positive float>*
Simple Morphological Filter elevation threshold parameter (meters). Default: ``0.5``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********
smrf-window
***********
**Options:** *<positive float>*
Simple Morphological Filter window radius parameter (meters). Default: ``18.0``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****
split
*****
**Options:** *<positive integer>*
Average number of images per submodel. When splitting a large dataset into smaller submodels, images are grouped into clusters. This value regulates the number of images that each cluster should have on average. Default: ``999999``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
******************
split-image-groups
******************
**Options:** *<path string>*
Path to the image groups file that controls how images should be split into groups. The file needs to use the following format: image_name group_nameDefault: ``None``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*************
split-overlap
*************
**Options:** *<positive integer>*
Radius of the overlap between submodels. After grouping images into clusters, images that are closer than this radius to a cluster are added to the cluster. This is done to ensure that neighboring submodels overlap. Default: ``150``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******************
texturing-data-term
*******************
**Options:** *gmi | area*
When texturing the 3D mesh, for each triangle, choose to prioritize images with sharp features (gmi) or those that cover the largest area (area). Default: ``gmi``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***************************
texturing-keep-unseen-faces
***************************
Keep faces in the mesh that are not seen in any camera. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
******************************
texturing-outlier-removal-type
******************************
**Options:** *none | gauss_clamping | gauss_damping*
Type of photometric outlier removal method. . Default: ``gauss_clamping``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********************************
texturing-skip-global-seam-leveling
***********************************
Skip normalization of colors across all images. Useful when processing radiometric data. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********************************
texturing-skip-local-seam-leveling
**********************************
Skip the blending of colors near seams. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********************
texturing-tone-mapping
**********************
**Options:** *none | gamma*
Turn on gamma tone mapping or none for no tone mapping. Can be one of ['none', 'gamma']. Default: ``none``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*****
tiles
*****
Generate static tiles for orthophotos and DEMs that are suitable for viewers like Leaflet or OpenLayers. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****
time
****
Generates a benchmark file with runtime info. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
**********
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. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
********
use-exif
********
Use this tag if you have a GCP File but want to use the EXIF information for georeferencing instead. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
***********************
use-fixed-camera-params
***********************
Turn off camera parameter optimization during bundle adjustment. This can be sometimes useful for improving results that exhibit doming/bowling or when images are taken with a rolling shutter camera. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
****************************
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. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******
verbose
*******
Print additional messages to the console. Default: ``False``
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>
*******
version
*******
Displays version number and exits.
.. raw:: html
<br>
<hr style="border-top: 6px double #8c8b8b">
<br>
<br>