geometric_features.geometric_features.GeometricFeatures.read¶
-
GeometricFeatures.
read
(componentName, objectType, featureNames=None, tags=None, allTags=True)[source]¶ Read one or more features from the cached collection of geometric features. If any of the requested features have not been cached, they are downloaded from the
geometric_features
GitHub repository. If neitherfeatureNames
nortags
are specified, all features of the component and object type are read in.Parameters: - componentName : {‘bedmap2’, ‘iceshelves’, ‘landice’, ‘natural_earth’, ‘ocean’}
The component from which to retieve the geometric features
- objectType : {‘point’, ‘transect’, ‘region’}
The type of geometry to load, a point (0D), transect (1D) or region (2D)
- featureNames : list of str, optional
The names of geometric features to read
- tags : list of str, optional
A list of tags to check for. A feature is only read in if it has all tags.
- allTags : bool, optional
Whether a feature must have all tags (instead of any of the tags)
Returns: - fc :
FeatureCollection
The feature collection read in