- classmethod Regions.from_geodataframe(df, *, name=None, source=None, overlap=None)
GeoDataFrame to be transformed to a Regions class.
- namestr, optional
name of the Regions. If None uses
- sourcestr, optional
Source of the shapefile. If None uses
- overlapbool | None, default: None
Indicates if (some of) the regions overlap and determines the behaviour of the
mask_3Densures overlapping regions are correctly assigned to grid points, while
maskraises an Error (because overlapping regions cannot be represented by a 2 dimensional mask).
If False assumes non-overlapping regions. Grid points are silently assigned to the region with the higher number.
If None (default) checks if any gridpoint belongs to more than one region. If this is the case
mask_3Dcorrectly assigns them and
maskraises an Error.