tio_tiler.types

rio_tiler.types

rio-tiler types.

AssetType module-attribute

AssetType = str | AssetWithOptions

BBox module-attribute

BBox = tuple[float, float, float, float]

ColorMapType module-attribute

ColorMapType = GDALColorMapType | DiscreteColorMapType | IntervalColorMapType

ColorTuple module-attribute

ColorTuple = tuple[int, int, int, int]

DataMaskType module-attribute

DataMaskType = tuple[numpy.ndarray, numpy.ndarray]

DiscreteColorMapType module-attribute

DiscreteColorMapType = dict[NumType, ColorTuple]

Discrete ColorMap, like GDALColorMapType but accept Float.

Matches only exact values for categorical data.

Example

{0.1: (0, 0, 0, 255), ...}

GDALColorMapType module-attribute

GDALColorMapType = dict[int, ColorTuple]

Continuous ColorMap Dict.

Expects 255 values, or it will be interpreted as a DiscreteColorMap.

Example

{1: (0, 0, 0, 255), ...}

Indexes module-attribute

Indexes = Sequence[int] | int

IntervalColorMapType module-attribute

IntervalColorMapType = Sequence[tuple[IntervalTuple, ColorTuple]]

Intervals ColorMap.

Example

[((0, 1), (0, 0, 0, 0)), ...]

IntervalTuple module-attribute

IntervalTuple = tuple[NumType, NumType]

NoData module-attribute

NoData = float | int | str

NumType module-attribute

NumType = float | int

RIOResampling module-attribute

RIOResampling = Literal['nearest', 'bilinear', 'cubic', 'cubic_spline', 'lanczos', 'average', 'mode', 'gauss', 'rms']

RasterIO() resampling method.

ref: gdal.org/api/raster_c_api.html#_CPPv418GDALRIOResampleAlg

WarpResampling module-attribute

WarpResampling = Literal['nearest', 'bilinear', 'cubic', 'cubic_spline', 'lanczos', 'average', 'mode', 'max', 'min', 'med', 'q1', 'q3', 'sum', 'rms']

WarpKernel resampling method.

ref: gdal.org/en/stable/api/gdalwarp_cpp.html#_CPPv415GDALResampleAlg

AssetInfo

Bases: TypedDict

Asset Reader Options.

dataset_statistics instance-attribute

dataset_statistics: NotRequired[Sequence[tuple[float, float]]]

env instance-attribute

env: NotRequired[dict]

media_type instance-attribute

media_type: str | None

metadata instance-attribute

metadata: NotRequired[dict]

method_options instance-attribute

method_options: dict

name instance-attribute

name: str

reader_options instance-attribute

reader_options: dict

url instance-attribute

url: Any

AssetWithOptions

Bases: TypedDict

Asset with additional options.

bands instance-attribute

bands: NotRequired[Sequence[str]]

expression instance-attribute

expression: NotRequired[str]

indexes instance-attribute

indexes: NotRequired[Indexes]

name instance-attribute

name: str