kopia lustrzana https://github.com/OpenDroneMap/docs
Auto-generate options and flags section, version
Piero Toffanin
rodzic
9a8bdc9c28
commit
ab8bf2f1b3
7
Makefile
7
Makefile
|
|
@ -14,10 +14,13 @@ help:
|
|||
|
||||
.PHONY: help Makefile
|
||||
|
||||
livehtml:
|
||||
autogenerate:
|
||||
python scripts/extract_odm_strings.py https://raw.githubusercontent.com/OpenDroneMap/ODM/master/opendm/config.py scripts/arguments.template.rst source/arguments.rst
|
||||
|
||||
livehtml: autogenerate
|
||||
sphinx-autobuild --open-browser -H 0.0.0.0 -b html "$(SOURCEDIR)" "$(BUILDDIR)"
|
||||
|
||||
deploy:
|
||||
deploy: autogenerate
|
||||
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" -nW
|
||||
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/sw" -D language='sw' -nW
|
||||
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='ar' -nW
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
.. _arguments:
|
||||
|
||||
Options and Flags
|
||||
-----------------
|
||||
|
||||
Arguments
|
||||
`````````
|
||||
|
||||
$arguments
|
||||
|
||||
|
||||
`Learn to edit <https://github.com/opendronemap/docs#how-to-make-your-first-contribution>`_ and help improve `this page <https://github.com/OpenDroneMap/docs/blob/publish/source/arguments.rst>`_!
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
#!/usr/bin/python3
|
||||
|
||||
import argparse, os, urllib.request, ast, sys
|
||||
from io import StringIO
|
||||
from string import Template
|
||||
|
||||
parser = argparse.ArgumentParser(description='Extract ODM strings.')
|
||||
parser.add_argument('input', type=str,
|
||||
help='URL to ODM\'s config.py')
|
||||
parser.add_argument('template', type=str,
|
||||
help='Template rst to use')
|
||||
parser.add_argument('output', type=str,
|
||||
help='Where to write resulting rst file')
|
||||
args = parser.parse_args()
|
||||
|
||||
url = args.input
|
||||
outfile = args.output
|
||||
tmplfile = args.template
|
||||
|
||||
strings = []
|
||||
print("Fetching %s ..." % url)
|
||||
res = urllib.request.urlopen(url)
|
||||
config_file = res.read().decode('utf-8')
|
||||
# config_file = open("test.py").read()
|
||||
|
||||
options = {}
|
||||
args_map = {}
|
||||
class ArgumentParserStub(argparse.ArgumentParser):
|
||||
def add_argument(self, *args, **kwargs):
|
||||
argparse.ArgumentParser.add_argument(self, *args, **kwargs)
|
||||
options[args[0]] = {}
|
||||
args_map[args[0]] = args[1:]
|
||||
|
||||
for name, value in kwargs.items():
|
||||
options[args[0]][str(name)] = str(value)
|
||||
|
||||
def add_mutually_exclusive_group(self):
|
||||
return ArgumentParserStub()
|
||||
|
||||
# Voodoo! :)
|
||||
# ( parse AST, extract "def config()" function, set module to only
|
||||
# contain that function, execute module in current scope,
|
||||
# run config function)
|
||||
root = ast.parse(config_file)
|
||||
new_body = []
|
||||
for stmt in root.body:
|
||||
# Assignments
|
||||
if hasattr(stmt, 'targets'):
|
||||
new_body.append(stmt)
|
||||
|
||||
# Functions
|
||||
elif hasattr(stmt, 'name'):
|
||||
new_body.append(stmt)
|
||||
|
||||
root.body = new_body
|
||||
exec(compile(root, filename="<ast>", mode="exec"))
|
||||
|
||||
|
||||
# Misc variables needed to get config to run
|
||||
__version__ = '?'
|
||||
class context:
|
||||
root_path = ''
|
||||
num_cores = 4
|
||||
class io:
|
||||
def path_or_json_string_to_dict(s):
|
||||
return s
|
||||
def path_or_json_string(s):
|
||||
return s
|
||||
class log:
|
||||
def ODM_ERROR(s):
|
||||
pass
|
||||
|
||||
config(["--project-path", "/bogus", "name"], parser=ArgumentParserStub())
|
||||
for opt in options:
|
||||
h = options[opt].get('help')
|
||||
if h:
|
||||
h = h.replace("\n", "")
|
||||
h = h.replace('%(default)s', '``' + options[opt].get('default', '') + '``')
|
||||
h = h.replace('%(choices)s', options[opt].get('choices', ''))
|
||||
options[opt]['help'] = h
|
||||
else:
|
||||
options[opt]['help'] = ''
|
||||
|
||||
print("Found %s ODM options" % len(options))
|
||||
|
||||
if len(options) > 0:
|
||||
subst = ""
|
||||
|
||||
keys = list(options.keys())
|
||||
keys.sort(key=lambda a: a.replace("-", ""))
|
||||
|
||||
for opt in keys:
|
||||
subst += "``%s%s`` %s\n %s\n\n" % (
|
||||
opt,
|
||||
"," + ",".join(args_map[opt]) if len(args_map[opt]) > 0 else "",
|
||||
options[opt].get('metavar', ''),
|
||||
options[opt].get('help', '')
|
||||
)
|
||||
|
||||
with open(tmplfile) as f:
|
||||
tmpl = Template(f.read())
|
||||
|
||||
|
||||
with open(outfile, "w") as f:
|
||||
f.write(tmpl.substitute(arguments=subst))
|
||||
|
||||
print("Wrote %s" % outfile)
|
||||
else:
|
||||
print("No strings found")
|
||||
|
|
@ -6,350 +6,250 @@ Options and Flags
|
|||
Arguments
|
||||
`````````
|
||||
|
||||
-h, --help
|
||||
Show 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. Disabling is useful for deriving maximum quality from imagery, but can be computationally expensive.
|
||||
|
||||
Default: ``2048``
|
||||
|
||||
--end-with <string>, -e <string>
|
||||
Options: ``dataset`` | ``split`` | ``merge`` | ``opensfm`` | ``mve``
|
||||
| ``odm_filterpoints`` | ``odm_meshing`` | ``mvs_texturing`` |
|
||||
``odm_georeferencing`` | ``odm_dem`` | ``odm_orthophoto``
|
||||
|
||||
--pc-ept
|
||||
Generates Entwine Point Cloud. Useful on its own, this flag is automatically added when running in WebODM and useful for creating the correct directory structure when running on NodeODM or command line for import into WebODM.
|
||||
|
||||
--rerun <string>, -r <string>
|
||||
Options: ``dataset`` | ``split`` | ``merge`` | ``opensfm`` | ``mve``
|
||||
| ``odm_filterpoints`` | ``odm_meshing`` | ``mvs_texturing`` |
|
||||
``odm_georeferencing`` | ``odm_dem`` | ``odm_orthophoto``
|
||||
|
||||
--rerun-all
|
||||
Force rerun of all tasks.
|
||||
|
||||
--rerun-from <string>
|
||||
Options: ``dataset`` | ``split`` | ``merge`` | ``opensfm`` | ``mve``
|
||||
| ``odm_filterpoints`` | ``odm_meshing`` | ``mvs_texturing`` |
|
||||
``odm_georeferencing`` | ``odm_dem`` | ``odm_orthophoto``
|
||||
|
||||
--proj <PROJ4 string>
|
||||
Projection used to transform the model into geographic coordinates.
|
||||
|
||||
--min-num-features <integer>
|
||||
Minimum number of features to extract per image. More features leads to better results but slower execution.
|
||||
|
||||
Default: ``8000``
|
||||
|
||||
--feature-quality
|
||||
Set feature extraction quality. Higher quality generates better features, but requires more memory and takes longer.
|
||||
|
||||
Options: ``ultra`` | ``high`` | ``medium`` | ``low`` | ``lowest``
|
||||
|
||||
Default: ``high``
|
||||
|
||||
--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. Off by default unless ``--camera`` parameter used.
|
||||
|
||||
--camera-lens <string>
|
||||
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.
|
||||
|
||||
Options: ``auto`` | ``perspective`` | ``brown`` | ``fisheye`` | ``spherical``
|
||||
|
||||
Default: ``auto``
|
||||
|
||||
--radiometric-calibration <string>
|
||||
Set the radiometric calibration to perform on images. When processing multispectral images you should set this option to obtain reflectance values (otherwise you will get digital number (DN) values).
|
||||
|
||||
[``camera``] applies black level, vignetting, row gradient gain/exposure compensation (if appropriate EXIF tags are found).
|
||||
|
||||
[``camera+sun``] is experimental, applies all the corrections of [``camera``] and additionally compensates for spectral radiance registered via a downwelling light sensor (DLS) taking in consideration the angle of the sun.
|
||||
|
||||
Options: ``none`` | ``camera`` | ``camera+sun``
|
||||
|
||||
Default: ``none``
|
||||
|
||||
--max-concurrency <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: *number of cores*
|
||||
|
||||
--depthmap-resolution <positive float>
|
||||
Controls the density of the point cloud by setting the resolution of the depthmap images. Higher values take longer to compute and more memory but produce denser point clouds.
|
||||
|
||||
Default: ``640``
|
||||
|
||||
--opensfm-depthmap-min-consistent-views <integer: 2 ≤ x ≤ 9>
|
||||
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. Only applies if using OpenSfM for dense matching.
|
||||
|
||||
Default: ``3``
|
||||
|
||||
--opensfm-depthmap-method <string>
|
||||
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.
|
||||
|
||||
Options: ``PATCH_MATCH`` | ``PATCH_MATCH_SAMPLE`` | ``BRUTE_FORCE``
|
||||
|
||||
Default: ``PATCH_MATCH``
|
||||
|
||||
--opensfm-depthmap-min-patch-sd <positive float>
|
||||
When using ``PATCH_MATCH`` or ``PATCH_MATCH_SAMPLE``, controls the standard deviation threshold to include patches. Patches with lower standard deviation are ignored.
|
||||
|
||||
Default: ``1``
|
||||
|
||||
--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.
|
||||
|
||||
--mve-confidence <float: 0 ≤ x ≤ 1>
|
||||
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``
|
||||
|
||||
--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.
|
||||
|
||||
--skip-3dmodel
|
||||
Skip generation of a full 3D model. This can save time if you only need 2D results such as orthophotos and DEMs.
|
||||
|
||||
--use-opensfm-dense
|
||||
Use opensfm to compute dense point cloud alternatively.
|
||||
|
||||
--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.
|
||||
|
||||
--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. For relatively low noise, values in the range of [1-5] can be used. For noisier datasets, large values in the range of [15-20] may be employed.
|
||||
|
||||
Default: ``1.0``
|
||||
|
||||
--mesh-point-weight <positive float>
|
||||
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``
|
||||
|
||||
--fast-orthophoto
|
||||
**Experimental.** 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.
|
||||
|
||||
--crop <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``
|
||||
|
||||
--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``
|
||||
|
||||
--pc-csv
|
||||
Export the georeferenced point cloud in CSV format.
|
||||
|
||||
Default: ``False``
|
||||
|
||||
--pc-las
|
||||
Export the georeferenced point cloud in LAS format.
|
||||
|
||||
Default: ``False``
|
||||
|
||||
--pc-filter <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``
|
||||
|
||||
--smrf-scalar <positive float>
|
||||
Simple Morphological Filter elevation scalar parameter.
|
||||
|
||||
Default: ``1.25``
|
||||
|
||||
--smrf-slope <positive float>
|
||||
Simple Morphological Filter slope parameter (rise over run).
|
||||
|
||||
Default: ``0.15``
|
||||
|
||||
--smrf-threshold <positive float>
|
||||
Simple Morphological Filter elevation threshold parameter (meters).
|
||||
|
||||
Default: ``0.5``
|
||||
|
||||
--smrf-window <positive float>
|
||||
Simple Morphological Filter window radius parameter (meters).
|
||||
|
||||
Default: ``18.0``
|
||||
|
||||
--texturing-data-term <string>
|
||||
Options: ``area`` | ``gmi``
|
||||
|
||||
Default: ``gmi``
|
||||
|
||||
--texturing-nadir-weight <integer: 0 ≤ x ≤ 32>
|
||||
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``
|
||||
|
||||
--texturing-outlier-removal-type <string>
|
||||
Type of photometric outlier removal method.
|
||||
|
||||
Options: ``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.
|
||||
|
||||
Options: ``gamma`` | ``none``
|
||||
|
||||
Default: ``none``
|
||||
|
||||
--gcp <path string>
|
||||
Path to the file containing the ground control points used for georeferencing. The file needs to have the following line format: ``easting northing height pixelrow pixelcol imagename``
|
||||
|
||||
Default: None.
|
||||
|
||||
--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 simple morphological filter. Check the ``--dem*`` and ``--smrf*`` parameters for finer tuning.
|
||||
|
||||
--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.
|
||||
|
||||
--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: ``3``
|
||||
|
||||
--dem-resolution <float>
|
||||
DSM/DTM resolution in cm / pixel.
|
||||
|
||||
Default: ``5``
|
||||
|
||||
--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-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``
|
||||
|
||||
--orthophoto-resolution <float: x ﹥0.0>
|
||||
Orthophoto resolution in cm / pixel.
|
||||
|
||||
Default: ``5``
|
||||
|
||||
--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 <string>
|
||||
Control whether the created orthophoto is a BigTIFF or classic TIFF. BigTIFF is a variant for files larger than 4GiB of data. See GDAL specs: https://www.gdal.org/frmt_gtiff.html for more info.
|
||||
|
||||
Options: ``YES`` | ``NO`` | ``IF_NEEDED`` | ``IF_SAFER``
|
||||
|
||||
Default: ``IF_SAFER``
|
||||
|
||||
--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``
|
||||
|
||||
--build-overviews
|
||||
``--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``
|
||||
``--camera-lens`` <string>
|
||||
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. Can be set to one of: ['auto', 'perspective', 'brown', 'fisheye', 'spherical']. Default: ``auto``
|
||||
|
||||
--version
|
||||
Displays software version number and exits.
|
||||
``--cameras`` <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: ````
|
||||
|
||||
--split <positive integer>
|
||||
``--crop`` <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``
|
||||
|
||||
``--debug``
|
||||
Print debug messagesDefault: ``False``
|
||||
|
||||
``--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-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``
|
||||
|
||||
``--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=``3``
|
||||
|
||||
``--dem-resolution`` <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``
|
||||
|
||||
``--depthmap-resolution`` <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``
|
||||
|
||||
``--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.
|
||||
|
||||
``--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.
|
||||
|
||||
``--end-with,-e`` <string>
|
||||
Can be one of:dataset | split | merge | opensfm | openmvs | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto | odm_report
|
||||
|
||||
``--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.
|
||||
|
||||
``--feature-quality`` <string>
|
||||
Set feature extraction quality. Higher quality generates better features, but requires more memory and takes longer. Can be one of: ['ultra', 'high', 'medium', 'low', 'lowest']. Default: ``high``
|
||||
|
||||
``--feature-type`` <string>
|
||||
Choose the algorithm for extracting keypoints and computing descriptors. Can be one of: ['sift', 'hahog']. Default: ``sift``
|
||||
|
||||
``--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``
|
||||
|
||||
``--gcp`` <path string>
|
||||
Path to the file containing the ground control points used for georeferencing. Default: ``None``. 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]
|
||||
|
||||
``--geo`` <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). Default: ``None``. 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)]
|
||||
|
||||
``--gps-accuracy`` <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``
|
||||
|
||||
``-h,--help``
|
||||
show this help message and exit
|
||||
|
||||
``--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.
|
||||
|
||||
``--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``
|
||||
|
||||
``--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-type`` <string>
|
||||
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. Can be one of: ['flann', 'bow']. Default: ``flann``
|
||||
|
||||
``--max-concurrency`` <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``
|
||||
|
||||
``--merge`` <string>
|
||||
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``
|
||||
|
||||
``--mesh-octree-depth`` <positive integer>
|
||||
Oct-tree depth used in the mesh reconstruction, increase to get more vertices, recommended values are 8-12. Default: ``10``
|
||||
|
||||
``--mesh-point-weight`` <positive float>
|
||||
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``
|
||||
|
||||
``--mesh-samples`` <float >= 1.0>
|
||||
Number of points per octree node, recommended and default value: ``1.0``
|
||||
|
||||
``--mesh-size`` <positive integer>
|
||||
The maximum vertex count of the output mesh. Default: ``200000``
|
||||
|
||||
``--min-num-features`` <integer>
|
||||
Minimum number of features to extract per image. More features leads to better results but slower execution. Default: ``8000``
|
||||
|
||||
``name`` <project name>
|
||||
Name of Project (i.e subdirectory of projects folder)
|
||||
|
||||
``--opensfm-depthmap-method`` <string>
|
||||
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``
|
||||
|
||||
``--opensfm-depthmap-min-consistent-views`` <integer: 2 <= x <= 9>
|
||||
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``
|
||||
|
||||
``--opensfm-depthmap-min-patch-sd`` <positive float>
|
||||
When using PATCH_MATCH or PATCH_MATCH_SAMPLE, controls the standard deviation threshold to include patches. Patches with lower standard deviation are ignored. Default: ``1``
|
||||
|
||||
``--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``
|
||||
|
||||
``--orthophoto-compression`` <string>
|
||||
Set the compression to use for orthophotos. Options: ['JPEG', 'LZW', 'PACKBITS', 'DEFLATE', 'LZMA', 'NONE'].Default: ``DEFLATE``
|
||||
|
||||
``--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``
|
||||
|
||||
``--orthophoto-no-tiled``
|
||||
Set this parameter if you want a stripped geoTIFF.Default: ``False``
|
||||
|
||||
``--orthophoto-png``
|
||||
Set this parameter if you want to generate a PNG rendering of the orthophoto.Default: ``False``
|
||||
|
||||
``--orthophoto-resolution`` <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``
|
||||
|
||||
``--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``
|
||||
|
||||
``--pc-csv``
|
||||
Export the georeferenced point cloud in CSV format. Default: ``False``
|
||||
|
||||
``--pc-ept``
|
||||
Export the georeferenced point cloud in Entwine Point Tile (EPT) format. Default: ``False``
|
||||
|
||||
``--pc-filter`` <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``
|
||||
|
||||
``--pc-las``
|
||||
Export the georeferenced point cloud in LAS format. Default: ``False``
|
||||
|
||||
``--pc-quality`` <string>
|
||||
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.Can be one of: ['ultra', 'high', 'medium', 'low', 'lowest']. Default: ``medium``
|
||||
|
||||
``--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``
|
||||
|
||||
``--pc-sample`` <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. Set to 0 to disable sampling.Default: ``0``
|
||||
|
||||
``--primary-band`` <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``
|
||||
|
||||
``--project-path`` <path>
|
||||
Path to the project folder
|
||||
|
||||
``--radiometric-calibration`` <string>
|
||||
Set the radiometric calibration to perform on images. When processing multispectral images you should set this option to obtain reflectance values (otherwise you will get digital number values). [camera] applies black level, vignetting, row gradient gain/exposure compensation (if appropriate EXIF tags are found). [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. Can be set to one of: ['none', 'camera', 'camera+sun']. Default: ``none``
|
||||
|
||||
``--rerun,-r`` <string>
|
||||
Can be one of:dataset | split | merge | opensfm | openmvs | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto | odm_report
|
||||
|
||||
``--rerun-all``
|
||||
force rerun of all tasks
|
||||
|
||||
``--rerun-from`` <string>
|
||||
Can be one of:dataset | split | merge | opensfm | openmvs | odm_filterpoints | odm_meshing | mvs_texturing | odm_georeferencing | odm_dem | odm_orthophoto | odm_report
|
||||
|
||||
``--resize-to`` <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``
|
||||
|
||||
``--skip-3dmodel``
|
||||
Skip generation of a full 3D model. This can save time if you only need 2D results such as orthophotos and DEMs.
|
||||
|
||||
``--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``
|
||||
|
||||
``--sm-cluster`` <string>
|
||||
URL to a ClusterODM instance for distributing a split-merge workflow on multiple nodes in parallel. Default: ``None``
|
||||
|
||||
``--smrf-scalar`` <positive float>
|
||||
Simple Morphological Filter elevation scalar parameter. Default: ``1.25``
|
||||
|
||||
``--smrf-slope`` <positive float>
|
||||
Simple Morphological Filter slope parameter (rise over run). Default: ``0.15``
|
||||
|
||||
``--smrf-threshold`` <positive float>
|
||||
Simple Morphological Filter elevation threshold parameter (meters). Default: ``0.5``
|
||||
|
||||
``--smrf-window`` <positive float>
|
||||
Simple Morphological Filter window radius parameter (meters). Default: ``18.0``
|
||||
|
||||
``--split`` <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.
|
||||
|
||||
--split-overlap <positive integer>
|
||||
|
||||
``--split-multitracks``
|
||||
Split multi-track reconstructions.
|
||||
|
||||
``--split-overlap`` <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.
|
||||
|
||||
--optimize-disk-space
|
||||
Delete heavy intermediate files (such as original orthos, dtm, dsm) to optimize disk space usage, while keeping the compressed versions. 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. Also, in this mode, the "reports" does not get written under the output 'opensfm' folder.
|
||||
|
||||
Default: ``False``
|
||||
|
||||
--sm-cluster <string>
|
||||
URL to a ClusterODM instance for distributing a split-merge workflow on multiple nodes in parallel.
|
||||
|
||||
Default: *None*
|
||||
|
||||
--merge <string>
|
||||
Choose what to merge in the merge step in a split dataset. By default all available outputs are merged.
|
||||
|
||||
Default: ``all``
|
||||
|
||||
``--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-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-tone-mapping`` <string>
|
||||
Turn on gamma tone mapping or none for no tone mapping. Choices are 'gamma' or 'none'. Default: ``none``
|
||||
|
||||
``--tiles``
|
||||
Generate static tiles for orthophotos and DEMs that are suitable for viewers like Leaflet or OpenLayers. Default: ``False``
|
||||
|
||||
``--time``
|
||||
Generates a benchmark file with runtime infoDefault: ``False``
|
||||
|
||||
``--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.
|
||||
|
||||
``--use-exif``
|
||||
Use this tag if you have a gcp_list.txt but want to use the exif geotags instead
|
||||
|
||||
``--use-fixed-camera-params``
|
||||
Turn off camera parameter optimization during bundler
|
||||
|
||||
``--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-opensfm-dense``
|
||||
Use opensfm to compute dense point cloud alternatively
|
||||
|
||||
``--verbose,-v``
|
||||
Print additional messages to the consoleDefault: ``False``
|
||||
|
||||
``--version``
|
||||
Displays version number and exits.
|
||||
|
||||
|
||||
|
||||
|
||||
`Learn to edit <https://github.com/opendronemap/docs#how-to-make-your-first-contribution>`_ and help improve `this page <https://github.com/OpenDroneMap/docs/blob/publish/source/arguments.rst>`_!
|
||||
|
|
|
|||
|
|
@ -13,10 +13,12 @@ project = 'OpenDroneMap'
|
|||
copyright = '2020, OpenDroneMap'
|
||||
author = 'OpenDroneMap'
|
||||
|
||||
# The short X.Y version
|
||||
version = '2.0.0'
|
||||
import urllib.request
|
||||
res = urllib.request.urlopen("https://raw.githubusercontent.com/OpenDroneMap/ODM/master/VERSION")
|
||||
version = res.read().decode('utf-8').strip()
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '2.0.0'
|
||||
release = version
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue