hydromt icon indicating copy to clipboard operation
hydromt copied to clipboard

get_geodataframe and clipping by geom according to docs

Open shartgring opened this issue 9 months ago • 0 comments

HydroMT version checks

  • [X] I have checked that the issue still exists on the latest versions of the docs on main here

Kind of issue

Docs are unclear

Location of the documentation

https://deltares.github.io/hydromt/latest/_generated/hydromt.data_catalog.DataCatalog.get_geodataframe.html

Documentation problem

According to the docs, the option is provided to clip the data:

"To clip the data to the area of interest, provide a bbox or geom, with optional additional buffer and align arguments. To return only the dataframe columns of interest provide the variables argument."

Does it really clip the data? After following the code, I end up in open_vector() in hydromt.io where the geom is used for the intersection of the data and the area of interest. That is not the same as clipping. Or am I missing something? I am not entirely sure and therefore asking ;)

Suggested fix for documentation

In the case that the data is indeed not clipped: add that the data is not really clipped but that the intersection is used to get the geodataframe

shartgring avatar May 22 '24 09:05 shartgring