/usr/lib/python2.7/dist-packages/cartopy/feature.py is in python-cartopy 0.14.2+dfsg1-2build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | # (C) British Crown Copyright 2011 - 2016, Met Office
#
# This file is part of cartopy.
#
# cartopy is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cartopy is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cartopy. If not, see <https://www.gnu.org/licenses/>.
"""
This module defines :class:`Feature` instances, for use with
ax.add_feature().
"""
from __future__ import (absolute_import, division, print_function)
from abc import ABCMeta, abstractmethod
import os.path
import numpy as np
import shapely.geometry as sgeom
import six
import cartopy.io.shapereader as shapereader
import cartopy.crs
COLORS = {'land': np.array((240, 240, 220)) / 256.,
'land_alt1': np.array((220, 220, 220)) / 256.,
'water': np.array((152, 183, 226)) / 256.}
"""
A dictionary of colors useful for drawing Features.
The named keys in this dictionary represent the "type" of
feature being plotted.
"""
_NATURAL_EARTH_GEOM_CACHE = {}
"""
Caches a mapping between (name, category, scale) and a tuple of the
resulting geometries.
Provides a significant performance benefit (when combined with object id
caching in GeoAxes.add_geometries) when producing multiple maps of the
same projection.
"""
class Feature(six.with_metaclass(ABCMeta)):
"""
Represents a collection of points, lines and polygons with convenience
methods for common drawing and filtering operations.
Args:
* crs - the coordinate reference system of this Feature
Kwargs:
Keyword arguments to be used when drawing this feature.
.. seealso::
To add features to the current matplotlib axes, see
:func:`GeoAxes <cartopy.mpl.geoaxes.GeoAxes.add_feature>`.
"""
def __init__(self, crs, **kwargs):
self._crs = crs
self._kwargs = dict(kwargs)
@property
def crs(self):
"""The cartopy CRS for the geometries in this feature."""
return self._crs
@property
def kwargs(self):
"""
The read-only dictionary of keyword arguments that are used when
creating the matplotlib artists for this feature.
"""
return dict(self._kwargs)
@abstractmethod
def geometries(self):
"""
Returns an iterator of (shapely) geometries for this feature.
"""
pass
def intersecting_geometries(self, extent):
"""
Returns an iterator of shapely geometries that intersect with
the given extent. The extent is assumed to be in the CRS of
the feature. If extent is None, the method returns all
geometries for this dataset.
"""
if extent is not None:
extent_geom = sgeom.box(extent[0], extent[2],
extent[1], extent[3])
return (geom for geom in self.geometries() if
extent_geom.intersects(geom))
else:
return self.geometries()
class ShapelyFeature(Feature):
"""
A class capable of drawing a collection of
shapely geometries.
"""
def __init__(self, geometries, crs, **kwargs):
"""
Args:
* geometries:
A collection of shapely geometries.
* crs:
The cartopy CRS in which the provided geometries are defined.
Kwargs:
Keyword arguments to be used when drawing this feature.
"""
super(ShapelyFeature, self).__init__(crs, **kwargs)
self._geoms = tuple(geometries)
def geometries(self):
return iter(self._geoms)
class NaturalEarthFeature(Feature):
"""
A simple interface to Natural Earth shapefiles.
See http://www.naturalearthdata.com/
"""
def __init__(self, category, name, scale, **kwargs):
"""
Args:
* category:
The category of the dataset, i.e. either 'cultural' or 'physical'.
* name:
The name of the dataset, e.g. 'admin_0_boundary_lines_land'.
* scale:
The dataset scale, i.e. one of '10m', '50m', or '110m'.
Corresponding to 1:10,000,000, 1:50,000,000, and 1:110,000,000
respectively.
Kwargs:
Keyword arguments to be used when drawing this feature.
"""
super(NaturalEarthFeature, self).__init__(cartopy.crs.PlateCarree(),
**kwargs)
self.category = category
self.name = name
self.scale = scale
def geometries(self):
key = (self.name, self.category, self.scale)
if key not in _NATURAL_EARTH_GEOM_CACHE:
path = shapereader.natural_earth(resolution=self.scale,
category=self.category,
name=self.name)
geometries = tuple(shapereader.Reader(path).geometries())
_NATURAL_EARTH_GEOM_CACHE[key] = geometries
else:
geometries = _NATURAL_EARTH_GEOM_CACHE[key]
return iter(geometries)
class GSHHSFeature(Feature):
"""
An interface to the GSHHS dataset.
See https://www.ngdc.noaa.gov/mgg/shorelines/gshhs.html
Args:
* scale:
The dataset scale. One of 'auto', 'coarse', 'low', 'intermediate',
'high, or 'full' (default is 'auto').
* levels:
A list of integers 1-4 corresponding to the desired GSHHS feature
levels to draw (default is [1] which corresponds to coastlines).
Kwargs:
Keyword arguments to be used when drawing the feature. Defaults
are edgecolor='black' and facecolor='none'.
"""
_geometries_cache = {}
"""
A mapping from scale and level to GSHHS shapely geometry::
{(scale, level): geom}
This provides a perfomance boost when plotting in interactive mode or
instantiating multiple GSHHS artists, by reducing repeated file IO.
"""
def __init__(self, scale='auto', levels=None, **kwargs):
super(GSHHSFeature, self).__init__(cartopy.crs.PlateCarree(), **kwargs)
if scale not in ('auto', 'a', 'coarse', 'c', 'low', 'l',
'intermediate', 'i', 'high', 'h', 'full', 'f'):
raise ValueError("Unknown GSHHS scale '{}'.".format(scale))
self._scale = scale
if levels is None:
levels = [1]
self._levels = set(levels)
unknown_levels = self._levels.difference([1, 2, 3, 4])
if unknown_levels:
raise ValueError("Unknown GSHHS levels "
"'{}'.".format(unknown_levels))
# Default kwargs
self._kwargs.setdefault('edgecolor', 'black')
self._kwargs.setdefault('facecolor', 'none')
def _scale_from_extent(self, extent):
"""
Returns the appropriate scale (e.g. 'i') for the given extent
expressed in PlateCarree CRS.
"""
# Default to coarse scale
scale = 'c'
if extent is not None:
# Upper limit on extent in degrees.
scale_limits = (('c', 20.0),
('l', 10.0),
('i', 2.0),
('h', 0.5),
('f', 0.1))
width = abs(extent[1] - extent[0])
height = abs(extent[3] - extent[2])
min_extent = min(width, height)
if min_extent != 0:
for scale, limit in scale_limits:
if min_extent > limit:
break
return scale
def geometries(self):
return self.intersecting_geometries(extent=None)
def intersecting_geometries(self, extent):
if self._scale == 'auto':
scale = self._scale_from_extent(extent)
else:
scale = self._scale[0]
if extent is not None:
extent_geom = sgeom.box(extent[0], extent[2],
extent[1], extent[3])
for level in self._levels:
geoms = GSHHSFeature._geometries_cache.get((scale, level))
if geoms is None:
# Load GSHHS geometries from appropriate shape file.
# TODO selective load based on bbox of each geom in file.
path = shapereader.gshhs(scale, level)
geoms = tuple(shapereader.Reader(path).geometries())
GSHHSFeature._geometries_cache[(scale, level)] = geoms
for geom in geoms:
if extent is None or extent_geom.intersects(geom):
yield geom
class WFSFeature(Feature):
"""
A class capable of drawing a collection of geometries
obtained from an OGC Web Feature Service (WFS).
This feature requires additional dependencies. If installed via pip,
try ``pip install cartopy[ows]``.
"""
def __init__(self, wfs, features, **kwargs):
"""
Args:
* wfs: string or :class:`owslib.wfs.WebFeatureService` instance
The WebFeatureService instance, or URL of a WFS service, from which
to retrieve the geometries.
* features: string or list of strings
The typename(s) of features available from the web service that
will be retrieved. Somewhat analogous to layers in WMS/WMTS.
Kwargs:
Keyword arguments to be used when drawing this feature.
"""
try:
from cartopy.io.ogc_clients import WFSGeometrySource
except ImportError as e:
six.raise_from(ImportError(
'WFSFeature requires additional dependencies. If installed '
'via pip, try `pip install cartopy[ows]`.\n'), e)
self.source = WFSGeometrySource(wfs, features)
crs = self.source.default_projection()
super(WFSFeature, self).__init__(crs, **kwargs)
# Default kwargs
self._kwargs.setdefault('edgecolor', 'black')
self._kwargs.setdefault('facecolor', 'none')
def geometries(self):
min_x, min_y, max_x, max_y = self.crs.boundary.bounds
geoms = self.source.fetch_geometries(self.crs,
extent=(min_x, max_x,
min_y, max_y))
return iter(geoms)
def intersecting_geometries(self, extent):
geoms = self.source.fetch_geometries(self.crs, extent)
return iter(geoms)
BORDERS = NaturalEarthFeature('cultural', 'admin_0_boundary_lines_land',
'110m', edgecolor='black', facecolor='none')
"""Small scale (1:110m) country boundaries."""
COASTLINE = NaturalEarthFeature('physical', 'coastline', '110m',
edgecolor='black', facecolor='none')
"""Small scale (1:110m) coastline, including major islands."""
LAKES = NaturalEarthFeature('physical', 'lakes', '110m',
edgecolor='face',
facecolor=COLORS['water'])
"""Small scale (1:110m) natural and artificial lakes."""
LAND = NaturalEarthFeature('physical', 'land', '110m',
edgecolor='face',
facecolor=COLORS['land'])
"""Small scale (1:110m) land polygons, including major islands."""
OCEAN = NaturalEarthFeature('physical', 'ocean', '110m',
edgecolor='face',
facecolor=COLORS['water'])
"""Small scale (1:110m) ocean polygons."""
RIVERS = NaturalEarthFeature('physical', 'rivers_lake_centerlines', '110m',
edgecolor=COLORS['water'],
facecolor='none')
"""Small scale (1:110m) single-line drainages, including lake centerlines."""
|