Skip to content

Commit

Permalink
gdalwarper.cpp: more details about OPTIMIZE_SIZE
Browse files Browse the repository at this point in the history
and document XSCALE and YSCALE warping options

Ref #10813
  • Loading branch information
rouault committed Sep 16, 2024
1 parent ce6bae8 commit 5f5694b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
17 changes: 16 additions & 1 deletion alg/gdalwarper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1167,6 +1167,17 @@ CPLErr GDALWarpDstAlphaMasker(void *pMaskFuncArg, int nBandCount,
* will be selected, not just those whose center point falls within the
* polygon.</li>
*
* <li>XSCALE=<ratio>: Ratio expressing the resampling factor along the target
* horizontal axis. Equals to one for no resampling, below one for downsampling
* and above one for upsampling. This is automatically computed, for each
* processing chunk, and may thus vary among them, depending on the
* shape of output regions vs input regions. Such variations can be undesired
* in some situations. If the resampling factor can be considered as constant
* over the warped area, setting a constant value can lead to more reproducible
* pixel output.</li>
*
* <li>YSCALE=<ratio>: Same as XSCALE, but along the horizontal axis.</li>
*
* <li>OPTIMIZE_SIZE: This defaults to FALSE, but may be set to TRUE
* typically when writing to a compressed dataset (GeoTIFF with
* COMPRESS creation option set for example) for achieving a smaller
Expand All @@ -1176,7 +1187,11 @@ CPLErr GDALWarpDstAlphaMasker(void *pMaskFuncArg, int nBandCount,
* of the file. However sticking to target block size may cause major
* processing slowdown for some particular reprojections. Starting
* with GDAL 3.8, OPTIMIZE_SIZE mode is automatically enabled when it is safe
* to do so.</li>
* to do so.
* As this parameter influences the shape of warping chunk, and by default the
* XSCALE and YSCALE parameters are computed per warping chunk, this parameter may
* influence the pixel output.
* </li>
*
* <li>NUM_THREADS: (GDAL >= 1.10) Can be set to a numeric value or ALL_CPUS to
* set the number of threads to use to parallelize the computation part of the
Expand Down
1 change: 1 addition & 0 deletions doc/source/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3360,6 +3360,7 @@ UpdateFeature
updateTime
UpperLeftX
UpperLeftY
upsampling
upsert
uri
url
Expand Down

0 comments on commit 5f5694b

Please sign in to comment.