Skip to content

Commit b0a2579

Browse files
committed
Add more information to slice caching config documentation
1 parent a224317 commit b0a2579

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/source/howtos/configuration.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,17 @@ are cached, this option saves a pair of ``slice`` objects that consist of
117117
only 3 integers each. This makes the amount of space used in the cache very
118118
small for many cached results.
119119
120+
The slicing operations in Pyresample typically involve finding the intersection
121+
between two geometries. This requires generating bounding polygons for the
122+
geometries and doing polygon intersection calculations that can handle
123+
projection anti-meridians. At the time of writing these calculations can take
124+
as long as 15 seconds depending on number of vertices used in the bounding
125+
polygons. One use case for these slices is reducing input data to only the
126+
overlap of the target area. This can be done before or during resampling as
127+
part of the algorithm or as part of a third-party resampling interface
128+
(ex. Satpy). In the future as optimizations are made to the polygon
129+
intersection logic this caching option should hopefully not be needed.
130+
120131
When setting this as an environment variable, this should be set with the
121132
string equivalent of the Python boolean values ``="True"`` or ``="False"``.
122133

0 commit comments

Comments
 (0)