Module rio_tiler.io.xarray¶

rio_tiler.io.xarray: Xarray Reader.

Variables¶

WGS84_CRS

rioxarray

xarray

Classes¶

XarrayReader¶

class XarrayReader(
    input: 'xarray.DataArray',
    tms: 'TileMatrixSet' = <TileMatrixSet title='Google Maps Compatible for the World' id='WebMercatorQuad' crs='http://www.opengis.net/def/crs/EPSG/0/3857>,
    geographic_crs: 'CRS' = CRS.from_epsg(4326)
)

Xarray Reader.

Attributes¶

Name	Type	Description	Default
dataset	xarray.DataArray	Xarray DataArray dataset.	None
tms	morecantile.TileMatrixSet	TileMatrixSet grid definition. Defaults to `WebMercatorQuad`.	`WebMercatorQuad`
geographic_crs	rasterio.crs.CRS	CRS to use as geographic coordinate system. Defaults to WGS84.	WGS84

Ancestors (in MRO)¶

rio_tiler.io.base.BaseReader
rio_tiler.io.base.SpatialMixin

Instance variables¶

band_names

Return list of band names in DataArray.

maxzoom

Return dataset maxzoom.

minzoom

Return dataset minzoom.

Methods¶

feature¶

def feature(
    self,
    shape: 'Dict',
    dst_crs: 'Optional[CRS]' = None,
    shape_crs: 'CRS' = CRS.from_epsg(4326),
    resampling_method: 'Optional[WarpResampling]' = None,
    reproject_method: 'WarpResampling' = 'nearest',
    nodata: 'Optional[NoData]' = None
) -> 'ImageData'

Read part of a dataset defined by a geojson feature.

Parameters:

Name	Type	Description	Default
shape	dict	Valid GeoJSON feature.	None
dst_crs	rasterio.crs.CRS	Overwrite target coordinate reference system.	None
shape_crs	rasterio.crs.CRS	Input geojson coordinate reference system. Defaults to `epsg:4326`.	`epsg:4326`
resampling_method	WarpResampling	DEPRECATED, WarpKernel resampling algorithm. Defaults to `nearest`.	`nearest`
reproject_method	WarpResampling	WarpKernel resampling algorithm. Defaults to `nearest`.	`nearest`
nodata	int or float	Overwrite dataset internal nodata value.	None

Returns:

Type	Description
rio_tiler.models.ImageData	ImageData instance with data, mask and input spatial info.

geographic_bounds¶

def geographic_bounds(
    ...
)

Return dataset bounds in geographic_crs.

get_maxzoom¶

def get_maxzoom(
    self
) -> 'int'

Define dataset maximum zoom level.

get_minzoom¶

def get_minzoom(
    self
) -> 'int'

Define dataset minimum zoom level.

info¶

def info(
    self
) -> 'Info'

Return xarray.DataArray info.

part¶

def part(
    self,
    bbox: 'BBox',
    dst_crs: 'Optional[CRS]' = None,
    bounds_crs: 'CRS' = CRS.from_epsg(4326),
    resampling_method: 'Optional[WarpResampling]' = None,
    reproject_method: 'WarpResampling' = 'nearest',
    auto_expand: 'bool' = True,
    nodata: 'Optional[NoData]' = None
) -> 'ImageData'

Read part of a dataset.

Parameters:

Name	Type	Description	Default
bbox	tuple	Output bounds (left, bottom, right, top) in target crs ("dst_crs").	None
dst_crs	rasterio.crs.CRS	Overwrite target coordinate reference system.	None
bounds_crs	rasterio.crs.CRS	Bounds Coordinate Reference System. Defaults to `epsg:4326`.	`epsg:4326`
resampling_method	WarpResampling	DEPRECATED, WarpKernel resampling algorithm. Defaults to `nearest`.	`nearest`
reproject_method	WarpResampling	WarpKernel resampling algorithm. Defaults to `nearest`.	`nearest`
auto_expand	boolean	When True, rioxarray's clip_box will expand clip search if only 1D raster found with clip. When False, will throw `OneDimensionalRaster` error if only 1 x or y data point is found. Defaults to True.	True
nodata	int or float	Overwrite dataset internal nodata value.	None

Returns:

Type	Description
rio_tiler.models.ImageData	ImageData instance with data, mask and input spatial info.

point¶

def point(
    self,
    lon: 'float',
    lat: 'float',
    coord_crs: 'CRS' = CRS.from_epsg(4326),
    nodata: 'Optional[NoData]' = None
) -> 'PointData'

Read a pixel value from a dataset.

Parameters:

Name	Type	Description	Default
lon	float	Longitude.	None
lat	float	Latitude.	None
coord_crs	rasterio.crs.CRS	Coordinate Reference System of the input coords. Defaults to `epsg:4326`.	`epsg:4326`
nodata	int or float	Overwrite dataset internal nodata value.	None

Returns:

Type	Description
None	PointData

preview¶

def preview(
    self,
    max_size: 'int' = 1024,
    height: 'Optional[int]' = None,
    width: 'Optional[int]' = None
) -> 'ImageData'

Return a preview of a dataset.

Parameters:

Name	Type	Description	Default
max_size	int	Limit the size of the longest dimension of the dataset read, respecting bounds X/Y aspect ratio. Defaults to 1024.	1024
height	int	Output height of the array.	None
width	int	Output width of the array.	None

Returns:

Type	Description
rio_tiler.models.ImageData	ImageData instance with data, mask and input spatial info.

statistics¶

def statistics(
    self,
    categorical: 'bool' = False,
    categories: 'Optional[List[float]]' = None,
    percentiles: 'Optional[List[int]]' = None,
    hist_options: 'Optional[Dict]' = None,
    max_size: 'int' = 1024,
    **kwargs: 'Any'
) -> 'Dict[str, BandStatistics]'

Return bands statistics from a dataset.

tile¶

def tile(
    self,
    tile_x: 'int',
    tile_y: 'int',
    tile_z: 'int',
    tilesize: 'int' = 256,
    resampling_method: 'Optional[WarpResampling]' = None,
    reproject_method: 'WarpResampling' = 'nearest',
    auto_expand: 'bool' = True,
    nodata: 'Optional[NoData]' = None
) -> 'ImageData'

Read a Web Map tile from a dataset.

Parameters:

Name	Type	Description	Default
tile_x	int	Tile's horizontal index.	None
tile_y	int	Tile's vertical index.	None
tile_z	int	Tile's zoom level index.	None
tilesize	int	Output image size. Defaults to `256`.	`256`
resampling_method	WarpResampling	DEPRECATED, WarpKernel resampling algorithm. Defaults to `nearest`.	`nearest`
reproject_method	WarpResampling	WarpKernel resampling algorithm. Defaults to `nearest`.	`nearest`
auto_expand	boolean	When True, rioxarray's clip_box will expand clip search if only 1D raster found with clip. When False, will throw `OneDimensionalRaster` error if only 1 x or y data point is found. Defaults to True.	True
nodata	int or float	Overwrite dataset internal nodata value.	None

Returns:

Type	Description
rio_tiler.models.ImageData	ImageData instance with data, mask and tile spatial info.

tile_exists¶

def tile_exists(
    self,
    tile_x: int,
    tile_y: int,
    tile_z: int
) -> bool

Check if a tile intersects the dataset bounds.

Parameters:

Name	Type	Description	Default
tile_x	int	Tile's horizontal index.	None
tile_y	int	Tile's vertical index.	None
tile_z	int	Tile's zoom level index.	None

Returns:

Type	Description
bool	True if the tile intersects the dataset bounds.