geometric_features.aggregation.get_aggregator_by_name

geometric_features.aggregation.get_aggregator_by_name(region_group)[source]

Get a geojson mask file and the appropriate file suffix for the given region group.

Parameters:

region_group (str) – The name of a region group to get mask features for, one of ‘Antarctic Regions’, ‘Arctic Ocean Regions’, ‘Arctic Sea Ice Regions’, ‘Ocean Basins’, ‘Ice Shelves’, ‘Ocean Subbasins’, ‘ISMIP6 Regions’, ‘MOC Basins’, ‘Transport Transects’, or ‘Arctic Transport Transects’

Returns:

function (callable) – An aggregation functions for collecting the features, which takes a geometric_features.GeometricFeatures object as its argument
prefix (str) – A prefix (or suffix) for use in file names that corresponds to the region group
date (str) – A date stamp when the regions in fc were last modified. This date can be used to cache masks based on these regions as long as the date remains the same.