Code for resampling using bucket resampling.
│ │ │pyresample.bucket.BucketResampler(target_area, source_lons, source_lats)¶Bases: object
Bases: object
Class for bucket resampling.
│ │ │Bucket resampling is useful for calculating averages and hit-counts │ │ │ when aggregating data to coarser scale grids.
│ │ │Below are examples how to use the resampler.
│ │ │Read data using Satpy. The resampling can also be done (apart from │ │ │ fractions) directly from Satpy, but this demonstrates the direct │ │ │ low-level usage.
│ │ │ @@ -105,15 +105,15 @@ │ │ │get_average(data, fill_value=nan, mask_all_nan=False)¶Calculate bin-averages using bucket resampling.
│ │ │average – Binned and averaged data.
│ │ │Dask array
│ │ │ @@ -140,18 +140,18 @@ │ │ │get_fractions(data, categories=None, fill_value=nan)¶Get fraction of occurrences for each given categorical value.
│ │ │data (Numpy or Dask array) – Categorical data to be processed
categories (iterable or None) – One dimensional list of categories in the data, or None. If None, │ │ │ +
categories (iterable or None) – One dimensional list of categories in the data, or None. If None, │ │ │ categories are determined from the data by fully processing the │ │ │ data and finding the unique category values.
fill_value (float) – Fill value to replace missing values. Default: np.nan
fill_value (float) – Fill value to replace missing values. Default: np.nan
pyresample.bucket.round_to_resolution(arr, resolution)¶Round the values in arr to closest resolution element.
│ │ │data – Source data rounded to the closest resolution unit
│ │ │Numpy or Dask array
│ │ ├── ./usr/share/doc/python-pyresample-doc/html/api/pyresample.html │ │ │ @@ -85,15 +85,15 @@ │ │ │pyresample.area_config.AreaNotFound¶Bases: KeyError
Bases: KeyError
Exception raised when specified are is no found in file.
│ │ │pyresample.area_config.convert_def_to_yaml(def_area_file, yaml_area_file)¶Convert a legacy area def file to the yaml counter partself.
│ │ │ @@ -103,40 +103,40 @@ │ │ │pyresample.area_config.create_area_def(area_id, projection, width=None, height=None, area_extent=None, shape=None, upper_left_extent=None, center=None, resolution=None, radius=None, units=None, **kwargs)¶Takes data the user knows and tries to make an area definition from what can be found.
│ │ │area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection (deprecated)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ +
area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection (deprecated)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ one of ‘deg’, ‘degrees’, ‘meters’, ‘metres’, and any │ │ │ parameter supported by the │ │ │ cs2cs -lu │ │ │ command. Units are determined in the following priority:
│ │ │units expressed with each variable through a DataArray’s attrs attribute.
units passed to units
units used in projection
meters
width (str, optional) – Number of pixels in the x direction
height (str, optional) – Number of pixels in the y direction
area_extent (list, optional) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
shape (list, optional) – Number of pixels in the y and x direction (height, width)
upper_left_extent (list, optional) – Upper left corner of upper left pixel (x, y)
center (list, optional) – Center of projection (x, y)
resolution (list or float, optional) – Size of pixels: (dx, dy)
radius (list or float, optional) – Length from the center to the edges of the projection (dx, dy)
rotation (float, optional) – rotation in degrees(negative is cw)
nprocs (int, optional) – Number of processor cores to be used
width (str, optional) – Number of pixels in the x direction
height (str, optional) – Number of pixels in the y direction
area_extent (list, optional) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
shape (list, optional) – Number of pixels in the y and x direction (height, width)
upper_left_extent (list, optional) – Upper left corner of upper left pixel (x, y)
center (list, optional) – Center of projection (x, y)
resolution (list or float, optional) – Size of pixels: (dx, dy)
radius (list or float, optional) – Length from the center to the edges of the projection (dx, dy)
rotation (float, optional) – rotation in degrees(negative is cw)
nprocs (int, optional) – Number of processor cores to be used
lons (numpy array, optional) – Grid lons
lats (numpy array, optional) – Grid lats
optimize_projection – Whether the projection parameters have to be optimized for a DynamicAreaDefinition.
AreaDefinition or DynamicAreaDefinition – If shape and area_extent are found, an AreaDefinition object is returned. │ │ │ @@ -163,54 +163,54 @@ │ │ │
pyresample.area_config.get_area_def(area_id, area_name, proj_id, proj4_args, width, height, area_extent, rotation=0)¶Construct AreaDefinition object from arguments
│ │ │area_id (str) – ID of area
area_name (str) – Description of area
proj_id (str) – ID of projection
proj4_args (list, dict, or str) – Proj4 arguments as list of arguments or string
width (int) – Number of pixel in x dimension
height (int) – Number of pixel in y dimension
rotation (float) – Rotation in degrees (negative is cw)
area_extent (list) – Area extent as a list of ints (LL_x, LL_y, UR_x, UR_y)
area_id (str) – ID of area
area_name (str) – Description of area
proj_id (str) – ID of projection
proj4_args (list, dict, or str) – Proj4 arguments as list of arguments or string
width (int) – Number of pixel in x dimension
height (int) – Number of pixel in y dimension
rotation (float) – Rotation in degrees (negative is cw)
area_extent (list) – Area extent as a list of ints (LL_x, LL_y, UR_x, UR_y)
area_def – AreaDefinition object
│ │ │pyresample.area_config.load_area(area_file_name, *regions)¶Load area(s) from area file.
│ │ │area_file_name (str, pathlib.Path, stream, or list thereof) – List of paths or streams. Any str or pathlib.Path will be │ │ │ +
area_file_name (str, pathlib.Path, stream, or list thereof) – List of paths or streams. Any str or pathlib.Path will be
│ │ │ interpreted as a path to a file. Any stream will be interpreted
│ │ │ as containing a yaml definition. To read directly from a string,
│ │ │ use load_area_from_string().
regions (str argument list) – Regions to parse. If no regions are specified all │ │ │ regions in the file are returned
area_defs – If one area name is specified a single AreaDefinition object is returned. │ │ │ If several area names are specified a list of AreaDefinition objects is returned
│ │ │AreaNotFound: – If a specified area name is not found
│ │ │pyresample.area_config.load_area_from_string(area_strs, *regions)¶
│ │ │ Load area(s) from area strings.
│ │ │Like load_area(), but load from string
│ │ │ directly.
area_defs – If one area name is specified a single AreaDefinition object is returned. │ │ │ If several area names are specified a list of AreaDefinition objects is returned
│ │ │pyresample.area_config.parse_area_file(area_file_name, *regions)¶Parse area information from area file
│ │ │area_defs – List of AreaDefinition objects
│ │ │AreaNotFound: – If a specified area is not found
│ │ │Bases: pyresample.boundary.AreaBoundary
Boundaries for area definitions (pyresample).
│ │ │chart_grid (numpy array) – Grid of area cartesian coordinates
lons (numpy array) – Swath lons
lats (numpy array) – Swath lats
data (numpy array) – Swath data
radius_of_influence (float) – Cut off distance in meters
radius_of_influence (float) – Cut off distance in meters
valid_index – Boolean array of same size as lons and lats indicating relevant indices
│ │ │numpy array
│ │ │ @@ -366,15 +366,15 @@ │ │ │chart_grid (numpy array) – Grid of area cartesian coordinates
lons (numpy array) – Swath lons
lats (numpy array) – Swath lats
data (numpy array) – Swath data
radius_of_influence (float) – Cut off distance in meters
radius_of_influence (float) – Cut off distance in meters
valid_index – Boolean array of same size as lon and lat indicating relevant indices
│ │ │numpy array
│ │ │ @@ -390,15 +390,15 @@ │ │ │chart_grid (numpy array) – Grid of area cartesian coordinates
lons (numpy array) – Swath lons
lats (numpy array) – Swath lats
data (numpy array) – Swath data
radius_of_influence (float) – Cut off distance in meters
radius_of_influence (float) – Cut off distance in meters
(lons, lats, data) – Reduced swath data and coordinate set
│ │ │list of numpy arrays
│ │ │ @@ -415,15 +415,15 @@ │ │ │boundary_lons (numpy array) – Grid of area lons
boundary_lats (numpy array) – Grid of area lats
lons (numpy array) – Swath lons
lats (numpy array) – Swath lats
data (numpy array) – Swath data
radius_of_influence (float) – Cut off distance in meters
radius_of_influence (float) – Cut off distance in meters
(lons, lats, data) – Reduced swath data and coordinate set
│ │ │list of numpy arrays
│ │ │ @@ -440,15 +440,15 @@ │ │ │grid_lons (numpy array) – Grid of area lons
grid_lats (numpy array) – Grid of area lats
lons (numpy array) – Swath lons
lats (numpy array) – Swath lats
data (numpy array) – Swath data
radius_of_influence (float) – Cut off distance in meters
radius_of_influence (float) – Cut off distance in meters
(lons, lats, data) – Reduced swath data and coordinate set
│ │ │list of numpy arrays
│ │ │ @@ -458,24 +458,24 @@ │ │ │ │ │ │pyresample.geo_filter.GridFilter(area_def, filter, nprocs=1)¶Bases: object
Bases: object
Geographic filter from a grid.
│ │ │grid_ll_x (float) – Projection x coordinate of lower left corner of lower left pixel
grid_ll_y (float) – Projection y coordinate of lower left corner of lower left pixel
grid_ur_x (float) – Projection x coordinate of upper right corner of upper right pixel
grid_ur_y (float) – Projection y coordinate of upper right corner of upper right pixel
proj4_string (str) – Projection definition as a PROJ.4 string.
grid_ll_x (float) – Projection x coordinate of lower left corner of lower left pixel
grid_ll_y (float) – Projection y coordinate of lower left corner of lower left pixel
grid_ur_x (float) – Projection x coordinate of upper right corner of upper right pixel
grid_ur_y (float) – Projection y coordinate of upper right corner of upper right pixel
proj4_string (str) – Projection definition as a PROJ.4 string.
mask (numpy array) – Mask as boolean numpy array
filter(geometry_def, data)¶pyresample.geometry.AreaDefinition(area_id, description, proj_id, projection, width, height, area_extent, rotation=None, nprocs=1, lons=None, lats=None, dtype=<class 'numpy.float64'>)¶Bases: pyresample.geometry.BaseDefinition
Holds definition of an area.
│ │ │area_id (str) – Identifier for the area
description (str) – Human-readable description of the area
proj_id (str) – ID of projection
projection (dict or str or pyproj.crs.CRS) – Dictionary of PROJ parameters or string of PROJ or WKT parameters.
│ │ │ -Can also be a pyproj.crs.CRS object.
width (int) – x dimension in number of pixels, aka number of grid columns
height (int) – y dimension in number of pixels, aka number of grid rows
area_extent (list) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
rotation (float, optional) – rotation in degrees (negative is clockwise)
nprocs (int, optional) – Number of processor cores to be used for certain calculations
area_id (str) – Identifier for the area
description (str) – Human-readable description of the area
proj_id (str) – ID of projection
projection (dict or str or pyproj.crs.CRS) – Dictionary of PROJ parameters or string of PROJ or WKT parameters.
│ │ │ +Can also be a pyproj.crs.CRS object.
width (int) – x dimension in number of pixels, aka number of grid columns
height (int) – y dimension in number of pixels, aka number of grid rows
area_extent (list) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
rotation (float, optional) – rotation in degrees (negative is clockwise)
nprocs (int, optional) – Number of processor cores to be used for certain calculations
area_id¶Identifier for the area
│ │ │ │ │ │description¶Human-readable description of the area
│ │ │ │ │ │proj_id¶ID of projection
│ │ │ │ │ │projection¶Dictionary or string with Proj.4 parameters
│ │ │ │ │ │width¶x dimension in number of pixels, aka number of grid columns
│ │ │ │ │ │height¶y dimension in number of pixels, aka number of grid rows
│ │ │ │ │ │rotation¶rotation in degrees (negative is cw)
│ │ │ │ │ │size¶Number of points in grid
│ │ │ │ │ │area_extent¶Area extent as a tuple (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
│ │ │ │ │ │area_extent_ll¶Area extent in lons lats as a tuple (lower_left_lon, lower_left_lat, upper_right_lon, upper_right_lat)
│ │ │ │ │ │pixel_size_x¶Pixel width in projection units
│ │ │ │ │ │pixel_size_y¶Pixel height in projection units
│ │ │ │ │ │upper_left_extent¶Coordinates (x, y) of upper left corner of upper left pixel in projection units
│ │ │ │ │ │pixel_upper_left¶Coordinates (x, y) of center of upper left pixel in projection units
│ │ │ │ │ │pixel_offset_x¶x offset between projection center and upper left corner of upper │ │ │ left pixel in units of pixels.
│ │ │ │ │ │pixel_offset_y¶y offset between projection center and upper left corner of upper │ │ │ left pixel in units of pixels..
│ │ │ │ │ │crs¶Coordinate reference system object similar to the PROJ parameters in │ │ │ proj_dict and proj_str. This is the preferred attribute to use │ │ │ when working with the pyproj library. Note, however, that this │ │ │ object is not thread-safe and should not be passed between threads.
│ │ │crs_wkt¶WellKnownText version of the CRS object. This is the preferred │ │ │ way of describing CRS information as a string.
│ │ │ │ │ │cartesian_coords¶Grid cartesian coordinates
│ │ │ │ │ │aggregate(**dims)¶from_area_of_interest(area_id, projection, shape, center, resolution, units=None, **kwargs)¶Create an AreaDefinition from center, resolution, and shape.
│ │ │area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
shape (list) – Number of pixels in the y and x direction (height, width)
center (list) – Center of projection (x, y)
resolution (list or float) – Size of pixels: (dx, dy). Can be specified with one value if dx == dy
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ +
area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
shape (list) – Number of pixels in the y and x direction (height, width)
center (list) – Center of projection (x, y)
resolution (list or float) – Size of pixels: (dx, dy). Can be specified with one value if dx == dy
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ one of ‘deg’, ‘degrees’, ‘meters’, ‘metres’, and any │ │ │ parameter supported by the │ │ │ cs2cs -lu │ │ │ command. Units are determined in the following priority:
│ │ │units expressed with each variable through a DataArray’s attrs attribute.
units passed to units
units used in projection
meters
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
lons (numpy array, optional) – Grid lons
lats (numpy array, optional) – Grid lats
AreaDefinition
│ │ │from_cf(cf_file, variable=None, y=None, x=None)¶Create an AreaDefinition object from a netCDF/CF file.
│ │ │nc_file (string or object) – path to a netCDF/CF file, or opened xarray.Dataset object
nc_file (string or object) – path to a netCDF/CF file, or opened xarray.Dataset object
variable (string, optional) – name of the variable to load the AreaDefinition from │ │ │ If variable is None the file will be searched for valid CF │ │ │ area definitions
y (string, optional) – name of the variable to use as ‘y’ axis of the CF area definition │ │ │ If y is None an appropriate ‘y’ axis will be deduced from the CF file
x (string, optional) – name of the variable to use as ‘x’ axis of the CF area definition │ │ │ If x is None an appropriate ‘x’ axis will be deduced from the CF file
from_circle(area_id, projection, center, radius, shape=None, resolution=None, units=None, **kwargs)¶Create an AreaDefinition from center, radius, and shape or from center, radius, and resolution.
│ │ │area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
center (list) – Center of projection (x, y)
radius (list or float) – Length from the center to the edges of the projection (dx, dy)
shape (list, optional) – Number of pixels in the y and x direction (height, width)
resolution (list or float, optional) – Size of pixels: (dx, dy)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ +
area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
center (list) – Center of projection (x, y)
radius (list or float) – Length from the center to the edges of the projection (dx, dy)
shape (list, optional) – Number of pixels in the y and x direction (height, width)
resolution (list or float, optional) – Size of pixels: (dx, dy)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ one of ‘deg’, ‘degrees’, ‘meters’, ‘metres’, and any │ │ │ parameter supported by the │ │ │ cs2cs -lu │ │ │ command. Units are determined in the following priority:
│ │ │units expressed with each variable through a DataArray’s attrs attribute.
units passed to units
units used in projection
meters
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
lons (numpy array, optional) – Grid lons
lats (numpy array, optional) – Grid lats
optimize_projection – Whether the projection parameters have to be optimized for a DynamicAreaDefinition.
AreaDefinition or DynamicAreaDefinition – If shape or resolution are provided, an AreaDefinition object is returned. │ │ │ @@ -910,34 +910,34 @@ │ │ │
from_extent(area_id, projection, shape, area_extent, units=None, **kwargs)¶Create an AreaDefinition object from area_extent and shape.
│ │ │area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
shape (list) – Number of pixels in the y and x direction (height, width)
area_extent (list) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ +
area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
shape (list) – Number of pixels in the y and x direction (height, width)
area_extent (list) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ one of ‘deg’, ‘degrees’, ‘meters’, ‘metres’, and any │ │ │ parameter supported by the │ │ │ cs2cs -lu │ │ │ command. Units are determined in the following priority:
│ │ │units expressed with each variable through a DataArray’s attrs attribute.
units passed to units
units used in projection
meters
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
lons (numpy array, optional) – Grid lons
lats (numpy array, optional) – Grid lats
AreaDefinition
│ │ │from_ul_corner(area_id, projection, shape, upper_left_extent, resolution, units=None, **kwargs)¶Create an AreaDefinition object from upper_left_extent, resolution, and shape.
│ │ │area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
shape (list) – Number of pixels in the y and x direction (height, width)
upper_left_extent (list) – Upper left corner of upper left pixel (x, y)
resolution (list or float) – Size of pixels in meters: (dx, dy). Can be specified with one value if dx == dy
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ +
area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
shape (list) – Number of pixels in the y and x direction (height, width)
upper_left_extent (list) – Upper left corner of upper left pixel (x, y)
resolution (list or float) – Size of pixels in meters: (dx, dy). Can be specified with one value if dx == dy
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ one of ‘deg’, ‘degrees’, ‘meters’, ‘metres’, and any │ │ │ parameter supported by the │ │ │ cs2cs -lu │ │ │ command. Units are determined in the following priority:
│ │ │units expressed with each variable through a DataArray’s attrs attribute.
units passed to units
units used in projection
meters
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection
rotation (float, optional) – rotation in degrees (negative is cw)
nprocs (int, optional) – Number of processor cores to be used
lons (numpy array, optional) – Grid lons
lats (numpy array, optional) – Grid lats
AreaDefinition
│ │ │get_lonlat(row, col)¶Retrieve lon and lat values of single point in area grid.
│ │ │(lon, lat)
│ │ │tuple of floats
│ │ │ @@ -1040,20 +1040,20 @@ │ │ │get_lonlats(nprocs=None, data_slice=None, cache=False, dtype=None, chunks=None)¶Return lon and lat arrays of area.
│ │ │nprocs (int, optional) – Number of processor cores to be used. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used. │ │ │ Defaults to the nprocs set when instantiating object
data_slice (slice object, optional) – Calculate only coordinates for specified slice
cache (bool, optional) – Store result the result. Requires data_slice to be None
dtype (numpy.dtype, optional) – Data type of the returned arrays
chunks (int or tuple, optional) – Create dask arrays and use this chunk size
cache (bool, optional) – Store result the result. Requires data_slice to be None
dtype (numpy.dtype, optional) – Data type of the returned arrays
chunks (int or tuple, optional) – Create dask arrays and use this chunk size
(lons, lats) – Grids of area lons and and lats
│ │ │tuple of numpy arrays
│ │ │ @@ -1071,16 +1071,16 @@ │ │ │get_proj_coords(data_slice=None, dtype=None, chunks=None)¶Get projection coordinates of grid.
│ │ │data_slice (slice object, optional) – Calculate only coordinates for specified slice
dtype (numpy.dtype, optional) – Data type of the returned arrays
chunks (int or tuple, optional) – Create dask arrays and use this chunk size
dtype (numpy.dtype, optional) – Data type of the returned arrays
chunks (int or tuple, optional) – Create dask arrays and use this chunk size
(target_x, target_y) (tuple of numpy arrays) – Grids of area x- and y-coordinates in projection units
.. versionchanged:: 1.11.0 – Removed ‘cache’ keyword argument and add ‘chunks’ for creating │ │ │ dask arrays.
get_proj_vectors(dtype=None, chunks=None)¶Calculate 1D projection coordinates for the X and Y dimension.
│ │ │dtype (numpy.dtype) – Numpy data type for the returned arrays
chunks (int or tuple) – Return dask arrays with the chunk size specified. If this is a │ │ │ +
dtype (numpy.dtype) – Numpy data type for the returned arrays
chunks (int or tuple) – Return dask arrays with the chunk size specified. If this is a │ │ │ tuple then the first element is the Y array’s chunk size and the │ │ │ second is the X array’s chunk size.
tuple ((X, Y) where X and Y are 1-dimensional numpy arrays)
get_xy_from_proj_coords(xm, ym)¶
│ │ │ Find closest grid cell index for a specified projection coordinate.
│ │ │If xm, ym is a tuple of sequences of projection coordinates, a tuple │ │ │ of masked arrays are returned.
│ │ │xm (list or array) – point or sequence of x-coordinates in │ │ │ +
xm (list or array) – point or sequence of x-coordinates in │ │ │ meters (map projection)
ym (list or array) – point or sequence of y-coordinates in │ │ │ +
ym (list or array) – point or sequence of y-coordinates in │ │ │ meters (map projection)
column and row grid cell indexes as 2 scalars or arrays
│ │ │x, y
│ │ │ValueError – if the return point is outside the area domain
│ │ │ +ValueError – if the return point is outside the area domain
│ │ │lonlat2colrow(lons, lats)¶pyresample.geometry.BaseDefinition(lons=None, lats=None, nprocs=1)¶Bases: object
Bases: object
Base class for geometry definitions.
│ │ │Changed in version 1.8.0: BaseDefinition no longer checks the validity of the provided
│ │ │ longitude and latitude coordinates to improve performance. Longitude
│ │ │ arrays are expected to be between -180 and 180 degrees, latitude -90
│ │ │ to 90 degrees. Use check_and_wrap() to preprocess
│ │ │ your arrays.
get_area_extent_for_subset(row_LR, col_LR, row_UL, col_UL)¶
│ │ │ Calculate extent for a subdomain of this area.
│ │ │Rows are counted from upper left to lower left and columns are │ │ │ counted from upper left to upper right.
│ │ │row_LR (int) – row of the lower right pixel
col_LR (int) – col of the lower right pixel
row_UL (int) – row of the upper left pixel
col_UL (int) – col of the upper left pixel
row_LR (int) – row of the lower right pixel
col_LR (int) – col of the lower right pixel
row_UL (int) – row of the upper left pixel
col_UL (int) – col of the upper left pixel
Area extent (LL_x, LL_y, UR_x, UR_y) of the subset
│ │ │area_extent (tuple)
│ │ │ +area_extent (tuple)
│ │ │Ulrich Hamann
│ │ │get_cartesian_coords(nprocs=None, data_slice=None, cache=False)¶Retrieve cartesian coordinates of geometry definition.
│ │ │nprocs (int, optional) – Number of processor cores to be used. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used. │ │ │ Defaults to the nprocs set when instantiating object
data_slice (slice object, optional) – Calculate only cartesian coordnates for the defined slice
cache (bool, optional) – Store result the result. Requires data_slice to be None
cache (bool, optional) – Store result the result. Requires data_slice to be None
cartesian_coords
│ │ │numpy array
│ │ │ @@ -1363,16 +1363,16 @@ │ │ │get_lonlat(row, col)¶Retrieve lon and lat of single pixel.
│ │ │(lon, lat)
│ │ │tuple of floats
│ │ │ @@ -1405,15 +1405,15 @@ │ │ │ │ │ │intersection(other)¶Return the corners of the intersection polygon of the current area with other.
│ │ │other (object) – Instance of subclass of BaseDefinition
│ │ │ +other (object) – Instance of subclass of BaseDefinition
│ │ │(corner1, corner2, corner3, corner4)
│ │ │tuple of points
│ │ │overlap_rate(other)¶Get how much the current area overlaps an other area.
│ │ │ │ │ │overlaps(other)¶Test if the current area overlaps the other area.
│ │ │This is based solely on the corners of areas, assuming the │ │ │ boundaries to be great circles.
│ │ │ │ │ │Concatenate coordinate definitions.
│ │ │geocentric_resolution(ellps='WGS84', radius=None, nadir_factor=2)¶Calculate maximum geocentric pixel resolution.
│ │ │ -If lons is a xarray.DataArray object with a resolution
│ │ │ +
If lons is a xarray.DataArray object with a resolution
│ │ │ attribute, this will be used instead of loading the longitude and
│ │ │ latitude data. In this case the resolution attribute is assumed to
│ │ │ mean the nadir resolution of a swath and will be multiplied by the
│ │ │ nadir_factor to adjust for increases in the spatial resolution
│ │ │ towards the limb of the swath.
ellps (str) – PROJ Ellipsoid for the Cartographic projection │ │ │ +
ellps (str) – PROJ Ellipsoid for the Cartographic projection │ │ │ used as the target geocentric coordinate reference system. │ │ │ Default: ‘WGS84’. Ignored if radius is provided.
radius (float) – Spherical radius of the Earth to use instead of │ │ │ +
radius (float) – Spherical radius of the Earth to use instead of │ │ │ the definitions in ellps.
nadir_factor (int) – Number to multiply the nadir resolution │ │ │ +
nadir_factor (int) – Number to multiply the nadir resolution │ │ │ attribute by to reflect pixel size on the limb of the swath.
coordinate system (X, Y, Z) representing the Earth.
│ │ │pyresample.geometry.DimensionError¶Bases: ValueError
Bases: ValueError
Wrap ValueError.
│ │ │pyresample.geometry.DynamicAreaDefinition(area_id=None, description=None, projection=None, width=None, height=None, area_extent=None, resolution=None, optimize_projection=False, rotation=None)¶Bases: object
Bases: object
An AreaDefintion containing just a subset of the needed parameters.
│ │ │The purpose of this class is to be able to adapt the area extent and shape │ │ │ of the area to a given set of longitudes and latitudes, such that e.g. │ │ │ polar satellite granules can be resampled optimally to a given projection.
│ │ │freeze(lonslats=None, resolution=None, shape=None, proj_info=None)¶Create an AreaDefinition from this area with help of some extra info.
│ │ │lonlats (SwathDefinition or tuple) – The geographical coordinates to contain in the resulting area. │ │ │ +
lonlats (SwathDefinition or tuple) – The geographical coordinates to contain in the resulting area.
│ │ │ A tuple should be (lons, lats).
resolution – the resolution of the resulting area.
shape – the shape of the resulting area.
proj_info – complementing parameters to the projection info.
and shape parameters are ignored if the instance is created (Resolution) –
the optimize_projection flag set to True. (with) –
Bases: pyresample.geometry.CoordinateDefinition
Grid defined by lons and lats.
│ │ │shape¶Grid shape as (rows, cols)
│ │ │ │ │ │size¶Number of elements in grid
│ │ │ │ │ │pyresample.geometry.IncompatibleAreas¶Bases: ValueError
Bases: ValueError
Error when the areas to combine are not compatible.
│ │ │pyresample.geometry.StackedAreaDefinition(*definitions, **kwargs)¶Bases: pyresample.geometry.BaseDefinition
Bases: pyresample.geometry.CoordinateDefinition
Swath defined by lons and lats.
│ │ │size¶Number of elements in swath
│ │ │ │ │ │cartesian_coords¶Swath cartesian coordinates
│ │ │ │ │ │aggregate(**dims)¶Samples from image based on index arrays.
│ │ │row_indices (numpy array) – Row indices. Dimensions must match col_indices
col_indices (numpy array) – Col indices. Dimensions must match row_indices
source_image (numpy array) – Source image
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ +
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
image_data – Resampled image
│ │ │Samples from image based on lon lat arrays │ │ │ using nearest neighbour method in cartesian projection coordinate systems.
│ │ │lons (numpy array) – Lons. Dimensions must match lats
lats (numpy array) – Lats. Dimensions must match lons
source_area_def (object) – Source definition as AreaDefinition object
source_area_def (object) – Source definition as AreaDefinition object
source_image_data (numpy array) – Source image data
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ +
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
nprocs (int, optional) – Number of processor cores to be used
nprocs (int, optional) – Number of processor cores to be used
image_data – Resampled image data
│ │ │numpy array
│ │ │ @@ -1983,16 +1983,16 @@ │ │ │pyresample.grid.get_linesample(lons, lats, source_area_def, nprocs=1)¶
│ │ │ Returns index row and col arrays for resampling
│ │ │lons (numpy array) – Lons. Dimensions must match lats
lats (numpy array) – Lats. Dimensions must match lons
source_area_def (object) – Source definition as AreaDefinition object
nprocs (int, optional) – Number of processor cores to be used
source_area_def (object) – Source definition as AreaDefinition object
nprocs (int, optional) – Number of processor cores to be used
(row_indices, col_indices) – Arrays for resampling area by array indexing
│ │ │tuple of numpy arrays
│ │ │ @@ -2004,21 +2004,21 @@ │ │ │pyresample.grid.get_resampled_image(target_area_def, source_area_def, source_image_data, fill_value=0, nprocs=1, segments=None)¶Resamples image using nearest neighbour method in cartesian │ │ │ projection coordinate systems.
│ │ │target_area_def (object) – Target definition as AreaDefinition object
source_area_def (object) – Source definition as AreaDefinition object
target_area_def (object) – Target definition as AreaDefinition object
source_area_def (object) – Source definition as AreaDefinition object
source_image_data (numpy array) – Source image data
fill_value ({int, None} optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
nprocs (int, optional) – Number of processor cores to be used
nprocs (int, optional) – Number of processor cores to be used
segments ({int, None} optional) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated.
image_data – Resampled image data
│ │ │Handles resampling of images with assigned geometry definitions
│ │ │pyresample.image.ImageContainer(image_data, geo_def, fill_value=0, nprocs=1)¶Bases: object
Bases: object
Holds image with geometry definition. │ │ │ Allows indexing with linesample arrays.
│ │ │image_data (numpy array) – Image data
geo_def (object) – Geometry definition
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ +
geo_def (object) – Geometry definition
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
nprocs (int, optional) – Number of processor cores to be used
nprocs (int, optional) – Number of processor cores to be used
image_data¶Image data
│ │ │ @@ -2063,37 +2063,37 @@ │ │ │ │ │ │geo_def¶Geometry definition
│ │ │ │ │ │fill_value¶Resample result fill value
│ │ │ │ │ │nprocs¶Number of processor cores to be used for geometry operations
│ │ │ │ │ │get_array_from_linesample(row_indices, col_indices)¶Bases: pyresample.image.ImageContainer
Holds image with geometry definition. │ │ │ Allows bilinear to new geometry definition.
│ │ │image_data (numpy array) – Image data
geo_def (object) – Geometry definition
radius_of_influence (float) – Cut off distance in meters
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ +
geo_def (object) – Geometry definition
radius_of_influence (float) – Cut off distance in meters
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ reduces execution time
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ +
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
reduce_data (bool, optional) – Perform coarse data reduction before resampling in order │ │ │ +
reduce_data (bool, optional) – Perform coarse data reduction before resampling in order │ │ │ to reduce execution time
nprocs (int, optional) – Number of processor cores to be used for geometry operations
segments (int or None) – Number of segments to use when resampling. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used for geometry operations
segments (int or None) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
image_data¶geo_def¶Geometry definition
│ │ │ │ │ │radius_of_influence¶Cut off distance in meters
│ │ │ │ │ │epsilon¶Allowed uncertainty in meters
│ │ │ │ │ │fill_value¶Resample result fill value
│ │ │ │ │ │reduce_data¶Perform coarse data reduction before resampling
│ │ │ │ │ │nprocs¶Number of processor cores to be used
│ │ │ │ │ │segments¶Number of segments to use when resampling
│ │ │ │ │ │resample(target_geo_def)¶Resamples image to area definition using bilinear approach
│ │ │ │ │ │Bases: pyresample.image.ImageContainer
Holds image with geometry definition. │ │ │ Allows nearest neighbour to new geometry definition.
│ │ │image_data (numpy array) – Image data
geo_def (object) – Geometry definition
radius_of_influence (float) – Cut off distance in meters
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ +
geo_def (object) – Geometry definition
radius_of_influence (float) – Cut off distance in meters
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ reduces execution time
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ +
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
reduce_data (bool, optional) – Perform coarse data reduction before resampling in order │ │ │ +
reduce_data (bool, optional) – Perform coarse data reduction before resampling in order │ │ │ to reduce execution time
nprocs (int, optional) – Number of processor cores to be used for geometry operations
segments (int or None) – Number of segments to use when resampling. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used for geometry operations
segments (int or None) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
image_data¶geo_def¶Geometry definition
│ │ │ │ │ │radius_of_influence¶Cut off distance in meters
│ │ │ │ │ │epsilon¶Allowed uncertainty in meters
│ │ │ │ │ │fill_value¶Resample result fill value
│ │ │ │ │ │reduce_data¶Perform coarse data reduction before resampling
│ │ │ │ │ │nprocs¶Number of processor cores to be used
│ │ │ │ │ │segments¶Number of segments to use when resampling
│ │ │ │ │ │resample(target_geo_def)¶Resamples image to area definition using nearest neighbour │ │ │ approach
│ │ │ │ │ │Bases: pyresample.image.ImageContainer
Holds image with area definition. ‘ │ │ │ Allows quick resampling within area.
│ │ │image_data (numpy array) – Image data
geo_def (object) – Area definition as AreaDefinition object
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ +
geo_def (object) – Area definition as AreaDefinition object
fill_value (int or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
nprocs (int, optional) – Number of processor cores to be used for geometry operations
segments (int or None) – Number of segments to use when resampling. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used for geometry operations
segments (int or None) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
image_data¶geo_def¶Area definition as AreaDefinition object
│ │ │ │ │ │fill_value¶Resample result fill value │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
│ │ │ │ │ │nprocs¶Number of processor cores to be used
│ │ │ │ │ │segments¶Number of segments to use when resampling
│ │ │ │ │ │resample(target_area_def)¶Resamples image to area definition using nearest neighbour │ │ │ approach in projection coordinates.
│ │ │target_area_def (object) – Target area definition as AreaDefinition object
│ │ │ +target_area_def (object) – Target area definition as AreaDefinition object
│ │ │image_container – ImageContainerQuick object of resampled area
│ │ │Handles reprojection of geolocated data. Several types of resampling are │ │ │ supported
│ │ │pyresample.kd_tree.EmptyResult¶Bases: ValueError
Bases: ValueError
pyresample.kd_tree.XArrayResamplerNN(source_geo_def, target_geo_def, radius_of_influence=None, neighbours=1, epsilon=0)¶Bases: object
Bases: object
get_neighbour_info(mask=None)¶Return neighbour info.
│ │ │data (xarray.DataArray) – Source data pixels to sample
fill_value (float) – Output fill value when no source data is │ │ │ +
data (xarray.DataArray) – Source data pixels to sample
fill_value (float) – Output fill value when no source data is
│ │ │ near the target pixel. When omitted, if the input data is an
│ │ │ integer array then the maximum value for that integer type is
│ │ │ used, but otherwise, NaN is used and can be detected in the
│ │ │ result with res.isnull().
query_resample_kdtree(resample_kdtree, tlons, tlats, valid_oi, mask)¶pyresample.kd_tree.get_neighbour_info(source_geo_def, target_geo_def, radius_of_influence, neighbours=8, epsilon=0, reduce_data=True, nprocs=1, segments=None)¶Returns neighbour info
│ │ │source_geo_def (object) – Geometry definition of source
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
neighbours (int, optional) – The number of neigbours to consider for each grid point
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ +
source_geo_def (object) – Geometry definition of source
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
neighbours (int, optional) – The number of neigbours to consider for each grid point
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ reduces execution time
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ +
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ to reduce execution time
nprocs (int, optional) – Number of processor cores to be used
segments (int or None) – Number of segments to use when resampling. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used
segments (int or None) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
(valid_input_index, valid_output_index,
index_array, distance_array) (tuple of numpy arrays) – Neighbour resampling info
pyresample.kd_tree.get_sample_from_neighbour_info(resample_type, output_shape, data, valid_input_index, valid_output_index, index_array, distance_array=None, weight_funcs=None, fill_value=0, with_uncert=False)¶
│ │ │ Resamples swath based on neighbour info
│ │ │resample_type ({'nn', 'custom'}) – ‘nn’: Use nearest neighbour resampling │ │ │ ‘custom’: Resample based on weight_funcs
data (numpy array) – Source data
valid_input_index (numpy array) – valid_input_index from get_neighbour_info
valid_output_index (numpy array) – valid_output_index from get_neighbour_info
index_array (numpy array) – index_array from get_neighbour_info
distance_array (numpy array, optional) – distance_array from get_neighbour_info │ │ │ Not needed for ‘nn’ resample type
weight_funcs (list of function objects or function object, optional) – List of weight functions f(dist) to use for the weighting │ │ │ of each channel 1 to k. │ │ │ If only one channel is resampled weight_funcs is │ │ │ a single function object. │ │ │ Must be supplied when using ‘custom’ resample type
fill_value (int, float, numpy floating, numpy integer or None, optional) – Set undetermined pixels to this value. │ │ │ +
fill_value (int, float, numpy floating, numpy integer or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
result – Source data resampled to target geometry
│ │ │pyresample.kd_tree.resample_custom(source_geo_def, data, target_geo_def, radius_of_influence, weight_funcs, neighbours=8, epsilon=0, fill_value=0, reduce_data=True, nprocs=1, segments=None, with_uncert=False)¶Resamples data using kd-tree custom radial weighting neighbour approach
│ │ │source_geo_def (object) – Geometry definition of source
source_geo_def (object) – Geometry definition of source
data (numpy array) – Array of single channel data points or │ │ │ (source_geo_def.shape, k) array of k channels of datapoints
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
weight_funcs (list of function objects or function object) – List of weight functions f(dist) to use for the weighting │ │ │ of each channel 1 to k. │ │ │ If only one channel is resampled weight_funcs is │ │ │ a single function object.
neighbours (int, optional) – The number of neigbours to consider for each grid point
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ +
neighbours (int, optional) – The number of neigbours to consider for each grid point
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ reduces execution time
fill_value ({int, None}, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ +
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ to reduce execution time
nprocs (int, optional) – Number of processor cores to be used
nprocs (int, optional) – Number of processor cores to be used
segments ({int, None}) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
data (numpy array (default)) – Source data resampled to target geometry
pyresample.kd_tree.resample_gauss(source_geo_def, data, target_geo_def, radius_of_influence, sigmas, neighbours=8, epsilon=0, fill_value=0, reduce_data=True, nprocs=1, segments=None, with_uncert=False)¶Resamples data using kd-tree gaussian weighting neighbour approach.
│ │ │source_geo_def (object) – Geometry definition of source
source_geo_def (object) – Geometry definition of source
data (numpy array) – Array of single channel data points or │ │ │ (source_geo_def.shape, k) array of k channels of datapoints
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
sigmas (list of floats or float) – List of sigmas to use for the gauss weighting of each │ │ │ +
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
sigmas (list of floats or float) – List of sigmas to use for the gauss weighting of each │ │ │ channel 1 to k, w_k = exp(-dist^2/sigma_k^2). │ │ │ If only one channel is resampled sigmas is a single float value.
neighbours (int, optional) – The number of neigbours to consider for each grid point
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ +
neighbours (int, optional) – The number of neigbours to consider for each grid point
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ reduces execution time
fill_value ({int, None}, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ +
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ to reduce execution time
nprocs (int, optional) – Number of processor cores to be used
segments (int or None) – Number of segments to use when resampling. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used
segments (int or None) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
with_uncert (bool, optional) – Calculate uncertainty estimates
with_uncert (bool, optional) – Calculate uncertainty estimates
data (numpy array (default)) – Source data resampled to target geometry
data, stddev, counts (numpy array, numpy array, numpy array (if with_uncert == True)) – Source data resampled to target geometry. │ │ │ Weighted standard devaition for all pixels having more than one source value │ │ │ @@ -2734,28 +2734,28 @@ │ │ │
pyresample.kd_tree.resample_nearest(source_geo_def, data, target_geo_def, radius_of_influence, epsilon=0, fill_value=0, reduce_data=True, nprocs=1, segments=None)¶Resamples data using kd-tree nearest neighbour approach
│ │ │source_geo_def (object) – Geometry definition of source
source_geo_def (object) – Geometry definition of source
data (numpy array) – 1d array of single channel data points or │ │ │ (source_size, k) array of k channels of datapoints
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ +
target_geo_def (object) – Geometry definition of target
radius_of_influence (float) – Cut off distance in meters
epsilon (float, optional) – Allowed uncertainty in meters. Increasing uncertainty │ │ │ reduces execution time
fill_value (int, float, numpy floating, numpy integer or None, optional) – Set undetermined pixels to this value. │ │ │ +
fill_value (int, float, numpy floating, numpy integer or None, optional) – Set undetermined pixels to this value. │ │ │ If fill_value is None a masked array is returned │ │ │ with undetermined pixels masked
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ +
reduce_data (bool, optional) – Perform initial coarse reduction of source dataset in order │ │ │ to reduce execution time
nprocs (int, optional) – Number of processor cores to be used
segments (int or None) – Number of segments to use when resampling. │ │ │ +
nprocs (int, optional) – Number of processor cores to be used
segments (int or None) – Number of segments to use when resampling. │ │ │ If set to None an estimate will be calculated
data – Source data resampled to target geometry
│ │ │pyresample.plot.area_def2basemap(area_def, **kwargs)¶Get Basemap object from an AreaDefinition object.
│ │ │bmap
│ │ │pyresample.plot.ellps2axis(ellps_name)¶Get semi-major and semi-minor axis from ellipsis definition.
│ │ │ellps_name (str) – Standard name of ellipsis
│ │ │ +ellps_name (str) – Standard name of ellipsis
│ │ │(a, b)
│ │ │semi-major and semi-minor axis
│ │ │pyresample.plot.save_quicklook(filename, area_def, data, vmin=None, vmax=None, label='Variable (units)', num_meridians=45, num_parallels=10, coast_res='110m', cmap='RdBu_r')¶Display and save default quicklook plot.
│ │ │filename (str) – path to output file
area_def (object) – geometry.AreaDefinition object
filename (str) – path to output file
area_def (object) – geometry.AreaDefinition object
data (numpy array | numpy masked array) – 2D array matching area_def. Use masked array for transparent values
vmin (float, optional) – Min value for luminescence scaling
vmax (float, optional) – Max value for luminescence scaling
label (str, optional) – Label for data
num_meridians (int, optional) – Number of meridians to plot on the globe
num_parallels (int, optional) – Number of parallels to plot on the globe
vmin (float, optional) – Min value for luminescence scaling
vmax (float, optional) – Max value for luminescence scaling
label (str, optional) – Label for data
num_meridians (int, optional) – Number of meridians to plot on the globe
num_parallels (int, optional) – Number of parallels to plot on the globe
coast_res ({'c', 'l', 'i', 'h', 'f'}, optional) – Resolution of coastlines
pyresample.plot.show_quicklook(area_def, data, vmin=None, vmax=None, label='Variable (units)', num_meridians=45, num_parallels=10, coast_res='110m', cmap='RdBu_r')¶Display default quicklook plot.
│ │ │area_def (object) – geometry.AreaDefinition object
area_def (object) – geometry.AreaDefinition object
data (numpy array | numpy masked array) – 2D array matching area_def. Use masked array for transparent values
vmin (float, optional) – Min value for luminescence scaling
vmax (float, optional) – Max value for luminescence scaling
label (str, optional) – Label for data
num_meridians (int, optional) – Number of meridians to plot on the globe
num_parallels (int, optional) – Number of parallels to plot on the globe
vmin (float, optional) – Min value for luminescence scaling
vmax (float, optional) – Max value for luminescence scaling
label (str, optional) – Label for data
num_meridians (int, optional) – Number of meridians to plot on the globe
num_parallels (int, optional) – Number of parallels to plot on the globe
coast_res ({'c', 'l', 'i', 'h', 'f'}, optional) – Resolution of coastlines
bmap
│ │ │Base resampler class made for subclassing.
│ │ │pyresample.resampler.BaseResampler(source_geo_def, target_geo_def)¶Bases: object
Bases: object
Base abstract resampler class.
│ │ │compute(data, **kwargs)¶Do the actual resampling.
│ │ │This must be implemented by subclasses.
│ │ │data (xarray.DataArray) – Data to be resampled
cache_dir (str) – directory to cache precomputed results │ │ │ +
data (xarray.DataArray) – Data to be resampled
cache_dir (str) – directory to cache precomputed results │ │ │ (default False, optional)
mask_area (bool) – Mask geolocation data where data values are │ │ │ +
mask_area (bool) – Mask geolocation data where data values are │ │ │ invalid. This should be used when data values │ │ │ may affect what neighbors are considered valid.
Returns (xarray.DataArray): Data resampled to the target area
│ │ │Some generalized spherical functions.
│ │ │base type is a numpy array of size (n, 2) (2 for lon and lats)
│ │ │pyresample.spherical.Arc(start, end)¶Bases: object
Bases: object
An arc of the great circle between two points.
│ │ │angle(other_arc)¶Oriented angle between two arcs.
│ │ │pyresample.spherical.CCoordinate(cart)¶Bases: object
Bases: object
Cartesian coordinates
│ │ │cross(point)¶cross product with another vector.
│ │ │pyresample.spherical.SCoordinate(lon, lat)¶Bases: object
Bases: object
Spherical coordinates.
│ │ │cross2cart(point)¶Compute the cross product, and convert to cartesian coordinates.
│ │ │pyresample.spherical.SphPolygon(vertices, radius=1)¶Bases: object
Bases: object
Spherical polygon.
│ │ │Vertices as a 2-column array of (col 1) lons and (col 2) lats is given in │ │ │ radians. │ │ │ The inside of the polygon is defined by the vertices being defined │ │ │ clockwise around it.
│ │ │Classes for spherical geometry operations
│ │ │pyresample.spherical_geometry.Arc(start, end)¶Bases: object
Bases: object
An arc of the great circle between two points.
│ │ │angle(other_arc, snap=True)¶Oriented angle between two arcs.
│ │ │pyresample.spherical_geometry.Coordinate(lon=None, lat=None, x__=None, y__=None, z__=None, R__=1)¶Bases: object
Bases: object
Point on earth in terms of lat and lon.
│ │ │cross(point)¶cross product with another vector.
│ │ │Git implementation of _version.py.
│ │ │pyresample.version.NotThisMethod¶Bases: Exception
Bases: Exception
Exception raised if a method is not valid for the current scenario.
│ │ │pyresample.version.VersioneerConfig¶Bases: object
Bases: object
Container for Versioneer configuration parameters.
│ │ │pyresample.version.get_config()¶Create, populate and return the VersioneerConfig() object.
│ │ │ @@ -3440,40 +3440,40 @@ │ │ │pyresample.create_area_def(area_id, projection, width=None, height=None, area_extent=None, shape=None, upper_left_extent=None, center=None, resolution=None, radius=None, units=None, **kwargs)¶Takes data the user knows and tries to make an area definition from what can be found.
│ │ │area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection (deprecated)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ +
area_id (str) – ID of area
projection (dict or str) – Projection parameters as a proj4_dict or proj4_string
description (str, optional) – Description/name of area. Defaults to area_id
proj_id (str, optional) – ID of projection (deprecated)
units (str, optional) –
Units that provided arguments should be interpreted as. This can be │ │ │ one of ‘deg’, ‘degrees’, ‘meters’, ‘metres’, and any │ │ │ parameter supported by the │ │ │ cs2cs -lu │ │ │ command. Units are determined in the following priority:
│ │ │units expressed with each variable through a DataArray’s attrs attribute.
units passed to units
units used in projection
meters
width (str, optional) – Number of pixels in the x direction
height (str, optional) – Number of pixels in the y direction
area_extent (list, optional) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
shape (list, optional) – Number of pixels in the y and x direction (height, width)
upper_left_extent (list, optional) – Upper left corner of upper left pixel (x, y)
center (list, optional) – Center of projection (x, y)
resolution (list or float, optional) – Size of pixels: (dx, dy)
radius (list or float, optional) – Length from the center to the edges of the projection (dx, dy)
rotation (float, optional) – rotation in degrees(negative is cw)
nprocs (int, optional) – Number of processor cores to be used
width (str, optional) – Number of pixels in the x direction
height (str, optional) – Number of pixels in the y direction
area_extent (list, optional) – Area extent as a list (lower_left_x, lower_left_y, upper_right_x, upper_right_y)
shape (list, optional) – Number of pixels in the y and x direction (height, width)
upper_left_extent (list, optional) – Upper left corner of upper left pixel (x, y)
center (list, optional) – Center of projection (x, y)
resolution (list or float, optional) – Size of pixels: (dx, dy)
radius (list or float, optional) – Length from the center to the edges of the projection (dx, dy)
rotation (float, optional) – rotation in degrees(negative is cw)
nprocs (int, optional) – Number of processor cores to be used
lons (numpy array, optional) – Grid lons
lats (numpy array, optional) – Grid lats
optimize_projection – Whether the projection parameters have to be optimized for a DynamicAreaDefinition.
AreaDefinition or DynamicAreaDefinition – If shape and area_extent are found, an AreaDefinition object is returned. │ │ │ @@ -3500,78 +3500,78 @@ │ │ │
pyresample.get_area_def(area_id, area_name, proj_id, proj4_args, width, height, area_extent, rotation=0)¶Construct AreaDefinition object from arguments
│ │ │area_id (str) – ID of area
area_name (str) – Description of area
proj_id (str) – ID of projection
proj4_args (list, dict, or str) – Proj4 arguments as list of arguments or string
width (int) – Number of pixel in x dimension
height (int) – Number of pixel in y dimension
rotation (float) – Rotation in degrees (negative is cw)
area_extent (list) – Area extent as a list of ints (LL_x, LL_y, UR_x, UR_y)
area_id (str) – ID of area
area_name (str) – Description of area
proj_id (str) – ID of projection
proj4_args (list, dict, or str) – Proj4 arguments as list of arguments or string
width (int) – Number of pixel in x dimension
height (int) – Number of pixel in y dimension
rotation (float) – Rotation in degrees (negative is cw)
area_extent (list) – Area extent as a list of ints (LL_x, LL_y, UR_x, UR_y)
area_def – AreaDefinition object
│ │ │pyresample.load_area(area_file_name, *regions)¶Load area(s) from area file.
│ │ │area_file_name (str, pathlib.Path, stream, or list thereof) – List of paths or streams. Any str or pathlib.Path will be │ │ │ +
area_file_name (str, pathlib.Path, stream, or list thereof) – List of paths or streams. Any str or pathlib.Path will be
│ │ │ interpreted as a path to a file. Any stream will be interpreted
│ │ │ as containing a yaml definition. To read directly from a string,
│ │ │ use load_area_from_string().
regions (str argument list) – Regions to parse. If no regions are specified all │ │ │ regions in the file are returned
area_defs – If one area name is specified a single AreaDefinition object is returned. │ │ │ If several area names are specified a list of AreaDefinition objects is returned
│ │ │AreaNotFound: – If a specified area name is not found
│ │ │pyresample.parse_area_file(area_file_name, *regions)¶Parse area information from area file
│ │ │area_defs – List of AreaDefinition objects
│ │ │AreaNotFound: – If a specified area is not found
│ │ │pyresample.utils.cf.load_cf_area(nc_file, variable=None, y=None, x=None)¶Load an AreaDefinition object from a netCDF/CF file.
│ │ │nc_file (string or object) – path to a netCDF/CF file, or opened xarray.Dataset object
nc_file (string or object) – path to a netCDF/CF file, or opened xarray.Dataset object
variable (string, optional) – name of the variable to load the AreaDefinition from. │ │ │ If the variable is not a CF grid_mapping container variable, │ │ │ it should be a variable having a :grid_mapping attribute. │ │ │ If variable is None the file will be searched for valid CF │ │ │ area definitions
y (string, optional) – name of the variable to use as ‘y’ axis of the CF area definition │ │ │ If y is None an appropriate ‘y’ axis will be deduced from the CF file
are_def, cf_info – cf_info holds info about how the AreaDefinition was defined in the CF file.
│ │ │geometry.AreaDefinition object, dict
│ │ │ +geometry.AreaDefinition object, dict
│ │ │pyresample.utils.proj4.proj4_radius_parameters(proj4_dict)¶Calculate ‘a’ and ‘b’ radius parameters.
│ │ │ │ │ │pyresample.utils.proj4.proj4_str_to_dict(proj4_str)¶pyresample.utils.rasterio.get_area_def_from_raster(source, area_id=None, name=None, proj_id=None, proj_dict=None)¶Construct AreaDefinition object from raster.
│ │ │source (str, Dataset, DatasetReader or DatasetWriter) – A file name. Also it can be osgeo.gdal.Dataset,
│ │ │ +
source (str, Dataset, DatasetReader or DatasetWriter) – A file name. Also it can be osgeo.gdal.Dataset,
│ │ │ rasterio.io.DatasetReader or rasterio.io.DatasetWriter
area_id (str, optional) – ID of area
name (str, optional) – Name of area
proj_id (str, optional) – ID of projection
proj_dict (dict, optional) – PROJ.4 parameters
area_id (str, optional) – ID of area
name (str, optional) – Name of area
proj_id (str, optional) – ID of projection
proj_dict (dict, optional) – PROJ.4 parameters
area_def – AreaDefinition object
│ │ │lons, lats
│ │ │ValueError – If latitude array is not between -90 and 90
│ │ │ +ValueError – If latitude array is not between -90 and 90
│ │ │pyresample.utils.check_slice_orientation(sli)¶pyresample.utils.fwhm2sigma(fwhm)¶Calculate sigma for gauss function from FWHM (3 dB level)
│ │ │ │ │ │pyresample.utils.generate_nearest_neighbour_linesample_arrays(source_area_def, target_area_def, radius_of_influence, nprocs=1)¶Generate linesample arrays for nearest neighbour grid resampling
│ │ │source_area_def (object) – Source area definition as geometry definition object
target_area_def (object) – Target area definition as geometry definition object
radius_of_influence (float) – Cut off distance in meters
nprocs (int, optional) – Number of processor cores to be used
source_area_def (object) – Source area definition as geometry definition object
target_area_def (object) – Target area definition as geometry definition object
radius_of_influence (float) – Cut off distance in meters
nprocs (int, optional) – Number of processor cores to be used
(row_indices, col_indices)
│ │ │tuple of numpy arrays
│ │ │ @@ -250,17 +250,17 @@ │ │ │pyresample.utils.generate_quick_linesample_arrays(source_area_def, target_area_def, nprocs=1)¶Generate linesample arrays for quick grid resampling
│ │ │source_area_def (object) – Source area definition as geometry definition object
target_area_def (object) – Target area definition as geometry definition object
nprocs (int, optional) – Number of processor cores to be used
source_area_def (object) – Source area definition as geometry definition object
target_area_def (object) – Target area definition as geometry definition object
nprocs (int, optional) – Number of processor cores to be used
(row_indices, col_indices)
│ │ │tuple of numpy arrays
│ │ ├── ./usr/share/doc/python-pyresample-doc/html/geo_def.html │ │ │ @@ -65,18 +65,18 @@ │ │ │check_and_wrap() to preprocess your arrays.
│ │ │ An AreaDefinition, or area, is the primary
│ │ │ way of specifying a uniformly spaced geographic region in pyresample. It is
│ │ │ also one of the only geometry objects that understands geographic projections.
│ │ │ -Areas use the PROJ.4 method for describing projected
│ │ │ +Areas use the PROJ.4 method for describing projected
│ │ │ coordinate reference systems (CRS). If the projection for an area is not
│ │ │ described by longitude/latitude coordinates then it is typically described
│ │ │ -in X/Y coordinates in meters. See the PROJ.4
│ │ │ +in X/Y coordinates in meters. See the PROJ.4
│ │ │ documentation for more information on projections and coordinate reference
│ │ │ systems.
The following arguments are needed to initialize an area:
│ │ │area_id: ID of area
description: Description
proj_id: ID of projection (being deprecated)
Note
│ │ │Projection (CRS) information is stored internally using the pyproj
│ │ │ -library’s CRS object. To meet certain standards
│ │ │ +library’s CRS object. To meet certain standards
│ │ │ for representing CRS information, pyproj may rename parameters or use
│ │ │ completely different parameters from what you provide.
The create_area_def function accepts some parameters in multiple forms
│ │ │ to make it as easy as possible. For example, the resolution and radius
│ │ │ keyword arguments can be specified with one value if dx == dy:
>>> proj_string = '+proj=laea +lat_0=-90 +lon_0=0 +a=6371228.0 +units=m'