From bf4425f0104bac7ae8a5b89ea2fb13ba80e595b3 Mon Sep 17 00:00:00 2001 From: MLicari1 Date: Tue, 25 Apr 2023 13:38:10 -0500 Subject: [PATCH] Add DEM docstring Made a more detailed doc string for the download DEM function. --- tools/RAiDER/dem.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/tools/RAiDER/dem.py b/tools/RAiDER/dem.py index 5d0d33dd2..fafaefac1 100644 --- a/tools/RAiDER/dem.py +++ b/tools/RAiDER/dem.py @@ -57,7 +57,18 @@ def download_dem( buf=0.02, overwrite=False, ): - """ Download a DEM if one is not already present. """ + """ + Download a DEM if one is not already present. + Args: + llbounds: list/ndarry of floats -lat/lon bounds of the area to download. Values should be ordered in the following way: [S, N, W, E] + writeDEM: boolean -write the DEM to file + outName: string -name of the DEM file + buf: float -buffer to add to the bounds + overwrite: boolean -overwrite existing DEM + Returns: + zvals: np.array -DEM heights + metadata: -metadata for the DEM + """ if os.path.exists(outName) and not overwrite: logger.info('Using existing DEM: %s', outName) zvals, metadata = rio_open(outName, returnProj=True)