Module titiler.core.dependencies¶

Common dependency.

Variables¶

RescaleType

Functions¶

ColorMapParams¶

def ColorMapParams(
    colormap_name: titiler.core.dependencies.ColorMapName = Query(None),
    colormap: str = Query(None)
) -> Union[Dict[int, Tuple[int, int, int, int]], Sequence[Tuple[Tuple[Union[float, int], Union[float, int]], Tuple[int, int, int, int]]], NoneType]

Colormap Dependency.

CoordCRSParams¶

def CoordCRSParams(
    crs: str = Query(None)
) -> Union[rasterio.crs.CRS, NoneType]

Coordinate Reference System Coordinates Param.

DatasetPathParams¶

def DatasetPathParams(
    url: str = Query(Ellipsis)
) -> str

Create dataset path from args

DstCRSParams¶

def DstCRSParams(
    crs: str = Query(None)
) -> Union[rasterio.crs.CRS, NoneType]

Coordinate Reference System Coordinates Param.

RescalingParams¶

def RescalingParams(
    rescale: Union[List[str], NoneType] = Query(None)
) -> Union[List[Tuple[float, ...]], NoneType]

Min/Max data Rescaling

Classes¶

AssetsBidxExprParams¶

class AssetsBidxExprParams(
    assets: Union[List[str], NoneType] = Query(None),
    expression: Union[str, NoneType] = Query(None),
    asset_indexes: Union[Sequence[str], NoneType] = Query(None),
    asset_as_band: Union[bool, NoneType] = Query(None)
)

Assets, Expression and Asset's band Indexes parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Descendants¶

titiler.core.dependencies.AssetsBidxExprParamsOptional

Class variables¶

asset_as_band

asset_indexes

assets

expression

Methods¶

keys¶

def keys(
    self
)

Return Keys.

AssetsBidxExprParamsOptional¶

class AssetsBidxExprParamsOptional(
    assets: Union[List[str], NoneType] = Query(None),
    expression: Union[str, NoneType] = Query(None),
    asset_indexes: Union[Sequence[str], NoneType] = Query(None),
    asset_as_band: Union[bool, NoneType] = Query(None)
)

Assets, Expression and Asset's band Indexes parameters but with no requirement.

Ancestors (in MRO)¶

titiler.core.dependencies.AssetsBidxExprParams
titiler.core.dependencies.DefaultDependency

Class variables¶

asset_as_band

asset_indexes

assets

expression

Methods¶

keys¶

def keys(
    self
)

Return Keys.

AssetsBidxParams¶

class AssetsBidxParams(
    assets: List[str] = Query(None),
    asset_indexes: Union[Sequence[str], NoneType] = Query(None),
    asset_expression: Union[Sequence[str], NoneType] = Query(None)
)

Assets, Asset's band Indexes and Asset's band Expression parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.AssetsParams
titiler.core.dependencies.DefaultDependency

Class variables¶

asset_expression

asset_indexes

assets

Methods¶

keys¶

def keys(
    self
)

Return Keys.

AssetsParams¶

class AssetsParams(
    assets: List[str] = Query(None)
)

Assets parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Descendants¶

titiler.core.dependencies.AssetsBidxParams

Class variables¶

assets

Methods¶

keys¶

def keys(
    self
)

Return Keys.

BandsExprParams¶

class BandsExprParams(
    bands: List[str] = Query(None),
    expression: Union[str, NoneType] = Query(None)
)

Band names and Expression parameters (Band or Expression required).

Ancestors (in MRO)¶

titiler.core.dependencies.ExpressionParams
titiler.core.dependencies.BandsParams
titiler.core.dependencies.DefaultDependency

Class variables¶

bands

expression

Methods¶

keys¶

def keys(
    self
)

Return Keys.

BandsExprParamsOptional¶

class BandsExprParamsOptional(
    bands: List[str] = Query(None),
    expression: Union[str, NoneType] = Query(None)
)

Optional Band names and Expression parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.ExpressionParams
titiler.core.dependencies.BandsParams
titiler.core.dependencies.DefaultDependency

Class variables¶

bands

expression

Methods¶

keys¶

def keys(
    self
)

Return Keys.

BandsParams¶

class BandsParams(
    bands: List[str] = Query(None)
)

Band names parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Descendants¶

titiler.core.dependencies.BandsExprParamsOptional
titiler.core.dependencies.BandsExprParams

Class variables¶

bands

Methods¶

keys¶

def keys(
    self
)

Return Keys.

BidxExprParams¶

class BidxExprParams(
    indexes: Union[List[int], NoneType] = Query(None),
    expression: Union[str, NoneType] = Query(None)
)

Band Indexes and Expression parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.ExpressionParams
titiler.core.dependencies.BidxParams
titiler.core.dependencies.DefaultDependency

Class variables¶

expression

indexes

Methods¶

keys¶

def keys(
    self
)

Return Keys.

BidxParams¶

class BidxParams(
    indexes: Union[List[int], NoneType] = Query(None)
)

Band Indexes parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Descendants¶

titiler.core.dependencies.BidxExprParams

Class variables¶

indexes

Methods¶

keys¶

def keys(
    self
)

Return Keys.

ColorMapName¶

class ColorMapName(
    /,
    *args,
    **kwargs
)

An enumeration.

Ancestors (in MRO)¶

enum.Enum

Class variables¶

accent

accent_r

afmhot

afmhot_r

autumn

autumn_r

binary

binary_r

blues

blues_r

bone

bone_r

brbg

brbg_r

brg

brg_r

bugn

bugn_r

bupu

bupu_r

bwr

bwr_r

cfastie

cividis

cividis_r

cmrmap

cmrmap_r

cool

cool_r

coolwarm

coolwarm_r

copper

copper_r

cubehelix

cubehelix_r

dark2

dark2_r

flag

flag_r

gist_earth

gist_earth_r

gist_gray

gist_gray_r

gist_heat

gist_heat_r

gist_ncar

gist_ncar_r

gist_rainbow

gist_rainbow_r

gist_stern

gist_stern_r

gist_yarg

gist_yarg_r

gnbu

gnbu_r

gnuplot

gnuplot2

gnuplot2_r

gnuplot_r

gray

gray_r

greens

greens_r

greys

greys_r

hot

hot_r

hsv

hsv_r

inferno

inferno_r

jet

jet_r

magma

magma_r

name

nipy_spectral

nipy_spectral_r

ocean

ocean_r

oranges

oranges_r

orrd

orrd_r

paired

paired_r

pastel1

pastel1_r

pastel2

pastel2_r

pink

pink_r

piyg

piyg_r

plasma

plasma_r

prgn

prgn_r

prism

prism_r

pubu

pubu_r

pubugn

pubugn_r

puor

puor_r

purd

purd_r

purples

purples_r

rainbow

rainbow_r

rdbu

rdbu_r

rdgy

rdgy_r

rdpu

rdpu_r

rdylbu

rdylbu_r

rdylgn

rdylgn_r

reds

reds_r

rplumbo

schwarzwald

seismic

seismic_r

set1

set1_r

set2

set2_r

set3

set3_r

spectral

spectral_r

spring

spring_r

summer

summer_r

tab10

tab10_r

tab20

tab20_r

tab20b

tab20b_r

tab20c

tab20c_r

terrain

terrain_r

twilight

twilight_r

twilight_shifted

twilight_shifted_r

value

viridis

viridis_r

winter

winter_r

wistia

wistia_r

ylgn

ylgn_r

ylgnbu

ylgnbu_r

ylorbr

ylorbr_r

ylorrd

ylorrd_r

DatasetParams¶

class DatasetParams(
    nodata: Union[str, int, float, NoneType] = Query(None),
    unscale: Union[bool, NoneType] = Query(False),
    resampling_method: titiler.core.dependencies.ResamplingName = Query(ResamplingName.nearest)
)

Low level WarpedVRT Optional parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Class variables¶

nodata

resampling_method

unscale

Methods¶

keys¶

def keys(
    self
)

Return Keys.

DefaultDependency¶

class DefaultDependency(

)

Dataclass with dict unpacking

Descendants¶

titiler.core.dependencies.BidxParams
titiler.core.dependencies.ExpressionParams
titiler.core.dependencies.AssetsParams
titiler.core.dependencies.AssetsBidxExprParams
titiler.core.dependencies.BandsParams
titiler.core.dependencies.ImageParams
titiler.core.dependencies.DatasetParams
titiler.core.dependencies.ImageRenderingParams
titiler.core.dependencies.StatisticsParams
titiler.core.dependencies.HistogramParams

Methods¶

keys¶

def keys(
    self
)

Return Keys.

ExpressionParams¶

class ExpressionParams(
    expression: Union[str, NoneType] = Query(None)
)

Expression parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Descendants¶

titiler.core.dependencies.BidxExprParams
titiler.core.dependencies.BandsExprParamsOptional
titiler.core.dependencies.BandsExprParams

Class variables¶

expression

Methods¶

keys¶

def keys(
    self
)

Return Keys.

HistogramParams¶

class HistogramParams(
    bins: Union[str, NoneType] = Query(None),
    range: Union[str, NoneType] = Query(None)
)

Numpy Histogram options.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Class variables¶

bins

range

Methods¶

keys¶

def keys(
    self
)

Return Keys.

ImageParams¶

class ImageParams(
    max_size: Union[int, NoneType] = Query(1024),
    height: Union[int, NoneType] = Query(None),
    width: Union[int, NoneType] = Query(None)
)

Common Preview/Crop parameters.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Class variables¶

height

max_size

width

Methods¶

keys¶

def keys(
    self
)

Return Keys.

ImageRenderingParams¶

class ImageRenderingParams(
    add_mask: bool = Query(True)
)

Image Rendering options.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Class variables¶

add_mask

Methods¶

keys¶

def keys(
    self
)

Return Keys.

ResamplingName¶

class ResamplingName(
    /,
    *args,
    **kwargs
)

An enumeration.

Ancestors (in MRO)¶

enum.Enum

Class variables¶

average

bilinear

cubic

cubic_spline

gauss

lanczos

max

med

min

mode

name

nearest

q1

q3

rms

sum

value

StatisticsParams¶

class StatisticsParams(
    categorical: bool = Query(False),
    categories: List[Union[float, int]] = Query(None),
    percentiles: List[int] = Query([2, 98])
)

Statistics options.

Ancestors (in MRO)¶

titiler.core.dependencies.DefaultDependency

Class variables¶

categorical

categories

percentiles

Methods¶

keys¶

def keys(
    self
)

Return Keys.