API reference
This page provides an auto-generated summary of the geometric features API. For more details and examples, refer to the relevant chapters in the main part of the documentation.
Command-line scripts
Entry point for combining features from a file |
|
Entry point for differencing features from a file |
|
Entry point for splitting features that cross +/- 180 degrees |
|
Entry point for merging features from the geometric_data cache |
|
Entry point for plotting features from a file |
|
Set the group name of the feature collection |
|
Features in the collection are split into individual files in the geometric_data cache |
|
Features in the collection are simplified using |
|
Features in the collection are tagged with the given tag(s) |
Python package
Reading Geometric Features
|
An object for keeping track of where geometric features are cached and downloading missing features as needed. |
|
Read one or more features from the cached collection of geometric features. |
Splitting new data into Geometric Features
|
Split a feature collection into individual files for each feature. |
|
Make a json file with all the available features and tags by component and object type, used to update the file when new geometric features are added to the repo |
Reading a Feature Collection
|
Read a feature collection from a geojson file. |
Creating a Feature Collection
|
An object for representing and manipulating a collection of geoscientific geometric features. |
Manipulating a Feature Collection
|
Add a feature to the feature collection if it isn't already present |
|
Merge another feature collection into this one |
|
Add tags to all features in the collection |
|
Set the group name of a feature collection |
|
Combines the geometry of the feature collection into a single feature |
|
Use features from a masking collection to mask out (remove part of the geometry from) this collection. |
Split features at +/-180 degrees (the antimeridian) to make them valid geojson geometries |
|
|
Features in the collection are simplified using |
Is this feature already in the collection? |
|
|
Write the feature collection to a geojson file |
|
Plot the features on a map using cartopy. |
Aggregation
|
Get a geojson mask file and the appropriate file suffix for the given region group. |
Aggregates ocean regions into the following larger sub-basins: * Arctic Ocean Basin * North Atlantic Basin * South Atlantic Basin * North Pacific Basin * South Pacific Basin * Indian Ocean Basin * Southern Ocean Basin |
|
Aggregate Global Ocean as well as Atlantic, Pacific, Indian, Arctic, Southern Ocean, Equatorial (global 15S-15N), and Mediterranean basins |
|
Aggregate features defining the ocean basins used in computing the meridional overturning circulation (MOC) |
|
Aggregate ocean-relevant Arctic regions |
|
Aggregate Antarctic regions similar to Timmermann et al. (2013). |
|
Aggregate Greenland continental shelf regions similar to ISMIP6 |
|
Aggregate 106 Antarctic ice shelves and ice-shelf regions |
|
Aggregate standard transport transects |
|
Aggregate sea-ice-relevant Arctic regions |
|
Aggregate regions defining median monthly arctic sea ice extent (1981-2010) from the QGreenland dataset (doi:10.5281/zenodo.12823307). |
|
Aggregate NASA Greenland ice sheet basin regions extended to continental shelf. |