Regions¶
-
class
aeolus.region.
Region
(west_bound, east_bound, south_bound, north_bound, name='', description='')[source]¶ Bases:
object
Rectangular geographical region.
-
constraint
¶ A constraint object associated with the region
- Type
-
__init__
(west_bound, east_bound, south_bound, north_bound, name='', description='')[source]¶ Instantiate a Region object.
-
classmethod
from_cube
(cube, name=None, margin=None, margin_units='points', shift_lons=False)[source]¶ Create a Region from limits of longitude and latitude of the cube.
- Parameters
cube (iris.cube.Cube) – Source cube.
name (str, optional) – Name for the region. If not given, created automatically from cube’s name.
margin (scalar, optional) – Use margin number of points or degrees to create a region smaller than the cube.
margin_units (str, optional) – Units of margin. Can be “points” or “degrees”.
shift_lons (bool, optional) – Shift longitudes to -180…180.
- Returns
- Return type
-
property
constraint
Constraint to select data within the region.
-