From d929d7b8fa2b8842750e74ccb6f914efd10dffd0 Mon Sep 17 00:00:00 2001 From: Stephen Mather <1174901+smathermather@users.noreply.github.com> Date: Sat, 29 Jul 2023 01:05:18 -0400 Subject: [PATCH] Update docs to reflect dem resolution defaults (#1683) * Update docs to reflect dem resolution defaults * Also ignore ignore-gsd, but also don't advertise it in orthophoto resolution. Replaces https://github.com/OpenDroneMap/docs/pull/176#issuecomment-1656550757 * Helpful note on GSD limit for elevation models too! * Change ignore-gsd language to have greater clarity --- opendm/config.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/opendm/config.py b/opendm/config.py index 91c89c2a..77a40829 100755 --- a/opendm/config.py +++ b/opendm/config.py @@ -272,10 +272,11 @@ def config(argv=None, parser=None): action=StoreTrue, nargs=0, default=False, - help='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: %(default)s') + help='Ignore Ground Sampling Distance (GSD).' + 'A memory and processor hungry change relative to the default behavior if set to true. ' + 'Ordinarily, GSD estimates are used to cap 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. ' + 'Never set --ignore-gsd to true unless you are positive you need it, and even then: don't use it. Default: %(default)s') parser.add_argument('--no-gpu', action=StoreTrue, @@ -543,7 +544,7 @@ def config(argv=None, parser=None): action=StoreValue, type=float, default=5, - help='DSM/DTM resolution in cm / pixel. Note that this value is capped to 2x the ground sampling distance (GSD) estimate. To remove the cap, check --ignore-gsd also.' + help='DSM/DTM resolution in cm / pixel. Note that this value is capped by a ground sampling distance (GSD) estimate.' ' Default: %(default)s') parser.add_argument('--dem-decimation', @@ -570,7 +571,7 @@ def config(argv=None, parser=None): action=StoreValue, default=5, type=float, - help=('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. ' + help=('Orthophoto resolution in cm / pixel. Note that this value is capped by a ground sampling distance (GSD) estimate.' 'Default: %(default)s')) parser.add_argument('--orthophoto-no-tiled',