Skip to content

Module titiler.core.dependencies

Common dependency.

Variables

RescaleType

Functions

BufferParams

def BufferParams(
    buffer: typing_extensions.Annotated[Union[float, NoneType], Query(PydanticUndefined)] = None
) -> Union[float, NoneType]

Tile buffer Parameter.

ColorFormulaParams

def ColorFormulaParams(
    color_formula: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = None
) -> Union[str, NoneType]

ColorFormula Parameter.

ColorMapParams

def ColorMapParams(
    colormap_name: typing_extensions.Annotated[Literal['brg', 'ice_r', 'plasma', 'greys', 'ocean', 'reds', 'topo_r', 'ylgn', 'haline_r', 'thermal_r', 'haline', 'topo', 'magma', 'cfastie', 'set2', 'puor', 'twilight_shifted', 'jet_r', 'purples', 'twilight_r', 'bupu_r', 'cmrmap_r', 'tarn_r', 'puor_r', 'gist_rainbow_r', 'reds_r', 'ylorbr_r', 'gist_gray', 'pubugn', 'coolwarm_r', 'flag_r', 'bugn', 'twilight', 'gist_ncar', 'orrd_r', 'gnuplot2', 'dense', 'ice', 'hsv_r', 'prism', 'speed_r', 'wistia', 'greens', 'afmhot', 'summer', 'pink', 'set3', 'bone_r', 'set1', 'tab20c', 'inferno', 'oranges_r', 'spring', 'pastel2_r', 'pastel2', 'delta_r', 'gnbu', 'piyg_r', 'ocean_r', 'purd_r', 'jet', 'brg_r', 'inferno_r', 'turbo_r', 'cmrmap', 'pastel1', 'dark2', 'gist_ncar_r', 'oranges', 'gist_stern', 'tab10_r', 'gist_gray_r', 'tab20b_r', 'cividis_r', 'autumn', 'tab20c_r', 'oxy_r', 'rplumbo', 'brbg_r', 'bwr', 'tempo', 'rdylgn_r', 'seismic_r', 'tab10', 'set2_r', 'cividis', 'pink_r', 'gist_heat', 'delta', 'phase_r', 'winter', 'gnuplot_r', 'ylgnbu', 'spring_r', 'gist_earth_r', 'rdylbu', 'tab20_r', 'coolwarm', 'accent', 'bugn_r', 'viridis_r', 'deep', 'ylgn_r', 'matter', 'binary_r', 'gist_yarg', 'rdpu', 'terrain_r', 'hot', 'ylgnbu_r', 'amp', 'autumn_r', 'flag', 'hsv', 'thermal', 'accent_r', 'ylorrd', 'gist_rainbow', 'winter_r', 'piyg', 'nipy_spectral', 'tempo_r', 'rdgy_r', 'tab20b', 'pastel1_r', 'rdpu_r', 'rdylbu_r', 'rainbow', 'nipy_spectral_r', 'gray', 'purples_r', 'prism_r', 'spectral', 'oxy', 'greys_r', 'terrain', 'paired_r', 'diff', 'rdylgn', 'amp_r', 'wistia_r', 'diff_r', 'ylorbr', 'plasma_r', 'afmhot_r', 'dense_r', 'turbo', 'matter_r', 'copper', 'solar_r', 'algae_r', 'dark2_r', 'gist_earth', 'rdgy', 'ylorrd_r', 'cool_r', 'solar', 'brbg', 'set1_r', 'rain', 'cool', 'bone', 'blues', 'prgn_r', 'turbid_r', 'gist_yarg_r', 'prgn', 'copper_r', 'cubehelix_r', 'viridis', 'cubehelix', 'tarn', 'curl_r', 'binary', 'curl', 'blues_r', 'rain_r', 'turbid', 'spectral_r', 'summer_r', 'pubugn_r', 'set3_r', 'twilight_shifted_r', 'phase', 'pubu', 'gnuplot2_r', 'pubu_r', 'hot_r', 'magma_r', 'rainbow_r', 'speed', 'deep_r', 'tab20', 'gnbu_r', 'orrd', 'bupu', 'gray_r', 'purd', 'balance_r', 'bwr_r', 'greens_r', 'algae', 'rdbu_r', 'gnuplot', 'gist_heat_r', 'rdbu', 'gist_stern_r', 'schwarzwald', 'paired', 'seismic', 'balance'], Query(PydanticUndefined)] = None,
    colormap: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = None
)

CoordCRSParams

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

Coordinate Reference System Coordinates Param.

DatasetPathParams

def DatasetPathParams(
    url: typing_extensions.Annotated[str, Query(PydanticUndefined)]
) -> str

Create dataset path from args

DstCRSParams

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

Coordinate Reference System Coordinates Param.

RescalingParams

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

Min/Max data Rescaling

create_colormap_dependency

def create_colormap_dependency(
    cmap: rio_tiler.colormap.ColorMaps
) -> Callable

Create Colormap Dependency.

Classes

AssetsBidxExprParams

class AssetsBidxExprParams(
    indexes: typing_extensions.Annotated[Union[List[int], NoneType], Query(PydanticUndefined)] = None,
    assets: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = None,
    expression: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = None,
    asset_indexes: typing_extensions.Annotated[Union[Sequence[str], NoneType], Query(PydanticUndefined)] = None,
    asset_as_band: typing_extensions.Annotated[Union[bool, NoneType], Query(PydanticUndefined)] = None
)

Assets, Expression and Asset's band Indexes parameters.

Ancestors (in MRO)

  • titiler.core.dependencies.AssetsParams
  • titiler.core.dependencies.BidxParams
  • titiler.core.dependencies.DefaultDependency

Descendants

  • titiler.core.dependencies.AssetsBidxExprParamsOptional

Class variables

asset_as_band
asset_indexes
assets
expression
indexes

Methods

keys

def keys(
    self
)

Return Keys.

AssetsBidxExprParamsOptional

class AssetsBidxExprParamsOptional(
    indexes: typing_extensions.Annotated[Union[List[int], NoneType], Query(PydanticUndefined)] = None,
    assets: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = None,
    expression: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = None,
    asset_indexes: typing_extensions.Annotated[Union[Sequence[str], NoneType], Query(PydanticUndefined)] = None,
    asset_as_band: typing_extensions.Annotated[Union[bool, NoneType], Query(PydanticUndefined)] = None
)

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

Ancestors (in MRO)

  • titiler.core.dependencies.AssetsBidxExprParams
  • titiler.core.dependencies.AssetsParams
  • titiler.core.dependencies.BidxParams
  • titiler.core.dependencies.DefaultDependency

Class variables

asset_as_band
asset_indexes
assets
expression
indexes

Methods

keys

def keys(
    self
)

Return Keys.

AssetsBidxParams

class AssetsBidxParams(
    indexes: typing_extensions.Annotated[Union[List[int], NoneType], Query(PydanticUndefined)] = None,
    assets: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = None,
    asset_indexes: typing_extensions.Annotated[Union[Sequence[str], NoneType], Query(PydanticUndefined)] = None,
    asset_expression: typing_extensions.Annotated[Union[Sequence[str], NoneType], Query(PydanticUndefined)] = None
)

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

Ancestors (in MRO)

  • titiler.core.dependencies.AssetsParams
  • titiler.core.dependencies.BidxParams
  • titiler.core.dependencies.DefaultDependency

Class variables

asset_expression
asset_indexes
assets
indexes

Methods

keys

def keys(
    self
)

Return Keys.

AssetsParams

class AssetsParams(
    assets: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = None
)

Assets parameters.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Descendants

  • titiler.core.dependencies.AssetsBidxExprParams
  • titiler.core.dependencies.AssetsBidxParams

Class variables

assets

Methods

keys

def keys(
    self
)

Return Keys.

BandsExprParams

class BandsExprParams(
    bands: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = None,
    expression: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = 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: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = None,
    expression: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = 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: typing_extensions.Annotated[Union[List[str], NoneType], Query(PydanticUndefined)] = 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: typing_extensions.Annotated[Union[List[int], NoneType], Query(PydanticUndefined)] = None,
    expression: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = 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: typing_extensions.Annotated[Union[List[int], NoneType], Query(PydanticUndefined)] = None
)

Band Indexes parameters.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Descendants

  • titiler.core.dependencies.BidxExprParams
  • titiler.core.dependencies.AssetsBidxExprParams
  • titiler.core.dependencies.AssetsBidxParams

Class variables

indexes

Methods

keys

def keys(
    self
)

Return Keys.

DatasetParams

class DatasetParams(
    nodata: typing_extensions.Annotated[Union[str, int, float, NoneType], Query(PydanticUndefined)] = None,
    unscale: typing_extensions.Annotated[bool, Query(PydanticUndefined)] = False,
    resampling_method: typing_extensions.Annotated[Literal['nearest', 'bilinear', 'cubic', 'cubic_spline', 'lanczos', 'average', 'mode', 'gauss', 'rms'], Query(PydanticUndefined)] = 'nearest',
    reproject_method: typing_extensions.Annotated[Literal['nearest', 'bilinear', 'cubic', 'cubic_spline', 'lanczos', 'average', 'mode', 'sum', 'rms'], Query(PydanticUndefined)] = 'nearest'
)

Low level WarpedVRT Optional parameters.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

nodata
reproject_method
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.BandsParams
  • titiler.core.dependencies.PreviewParams
  • titiler.core.dependencies.PartFeatureParams
  • titiler.core.dependencies.DatasetParams
  • titiler.core.dependencies.ImageRenderingParams
  • titiler.core.dependencies.StatisticsParams
  • titiler.core.dependencies.HistogramParams
  • titiler.core.dependencies.TileParams

Methods

keys

def keys(
    self
)

Return Keys.

ExpressionParams

class ExpressionParams(
    expression: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = 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: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = None,
    range: typing_extensions.Annotated[Union[str, NoneType], Query(PydanticUndefined)] = None
)

Numpy Histogram options.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

bins
range

Methods

keys

def keys(
    self
)

Return Keys.

ImageRenderingParams

class ImageRenderingParams(
    add_mask: typing_extensions.Annotated[bool, Query(PydanticUndefined)] = True
)

Image Rendering options.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

add_mask

Methods

keys

def keys(
    self
)

Return Keys.

PartFeatureParams

class PartFeatureParams(
    max_size: typing_extensions.Annotated[Union[int, NoneType], 'Maximum image size to read onto.'] = None,
    height: typing_extensions.Annotated[Union[int, NoneType], 'Force output image height.'] = None,
    width: typing_extensions.Annotated[Union[int, NoneType], 'Force output image width.'] = None
)

Common parameters for bbox and feature.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

height
max_size
width

Methods

keys

def keys(
    self
)

Return Keys.

PreviewParams

class PreviewParams(
    max_size: typing_extensions.Annotated[int, 'Maximum image size to read onto.'] = 1024,
    height: typing_extensions.Annotated[Union[int, NoneType], 'Force output image height.'] = None,
    width: typing_extensions.Annotated[Union[int, NoneType], 'Force output image width.'] = None
)

Common Preview parameters.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

height
max_size
width

Methods

keys

def keys(
    self
)

Return Keys.

StatisticsParams

class StatisticsParams(
    categorical: typing_extensions.Annotated[bool, Query(PydanticUndefined)] = False,
    categories: typing_extensions.Annotated[Union[List[Union[float, int]], NoneType], Query(PydanticUndefined)] = None,
    percentiles: typing_extensions.Annotated[Union[List[int], NoneType], Query(PydanticUndefined)] = None
)

Statistics options.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

categorical
categories
percentiles

Methods

keys

def keys(
    self
)

Return Keys.

TileParams

class TileParams(
    buffer: typing_extensions.Annotated[Union[float, NoneType], Query(PydanticUndefined)] = None,
    padding: typing_extensions.Annotated[Union[int, NoneType], Query(PydanticUndefined)] = None
)

Tile options.

Ancestors (in MRO)

  • titiler.core.dependencies.DefaultDependency

Class variables

buffer
padding

Methods

keys

def keys(
    self
)

Return Keys.