Xarray Tiler API

Bbox Image

Create image from a bbox.

get/bbox/{minx},{miny},{maxx},{maxy}.{format}

Request

Base URL: https://map.cal-adapt.org (the document declares no server; this is the origin it was published from)
URL: https://map.cal-adapt.org/bbox/{minx},{miny},{maxx},{maxy}.{format}
Auth: none declared

Path parameters

minxnumber required

Bounding box min X

minynumber required

Bounding box min Y

maxxnumber required

Bounding box max X

maxynumber required

Bounding box max Y

format'png' | 'npy' | 'tif' | 'jpeg' | 'jpg' | 'jp2' | 'webp' | 'pngraw' required

Available Output image type.

Query parameters

urlstring required

Dataset URL

variablestring required

Xarray Variable name

drop_dimstring nullable

Dimension to drop

datetimestring nullable

Slice of time to read (if available)

groupstring nullable

Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.

decode_timesboolean nullable

Whether to decode times

string

OR

integer

OR

number

reproject'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'sum' | 'rms' nullable

WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.

max_sizeinteger nullable

heightinteger nullable

widthinteger nullable

resampling'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'gauss' | 'rms' nullable

RasterIO resampling algorithm. Defaults to nearest.

dst_crsstring nullable

Output Coordinate Reference System.

coord_crsstring nullable

Coordinate Reference System of the input coords. Default to epsg:4326.

algorithm'hillshade' | 'contours' | 'normalizedIndex' | 'terrarium' | 'terrainrgb'

Algorithm name

algorithm_paramsstring nullable

Algorithm parameter

rescalestring[] nullable

comma (',') delimited Min,Max range. Can set multiple time for multiple bands.

color_formulastring nullable

rio-color formula (info: https://github.com/mapbox/rio-color)

colormap_name'accent' | 'accent_r' | 'afmhot' | 'afmhot_r' | 'algae' | 'algae_r' | 'amp' | 'amp_r' | 'autumn' | 'autumn_r' | 'balance' | 'balance_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' | 'curl' | 'curl_r' | 'dark2' | 'dark2_r' | 'deep' | 'deep_r' | 'delta' | 'delta_r' | 'dense' | 'dense_r' | 'diff' | 'diff_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' | 'haline' | 'haline_r' | 'hot' | 'hot_r' | 'hsv' | 'hsv_r' | 'ice' | 'ice_r' | 'inferno' | 'inferno_r' | 'jet' | 'jet_r' | 'magma' | 'magma_r' | 'matter' | 'matter_r' | 'nipy_spectral' | 'nipy_spectral_r' | 'ocean' | 'ocean_r' | 'oranges' | 'oranges_r' | 'orrd' | 'orrd_r' | 'oxy' | 'oxy_r' | 'paired' | 'paired_r' | 'pastel1' | 'pastel1_r' | 'pastel2' | 'pastel2_r' | 'phase' | 'phase_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' | 'rain' | 'rain_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' | 'solar' | 'solar_r' | 'spectral' | 'spectral_r' | 'speed' | 'speed_r' | 'spring' | 'spring_r' | 'summer' | 'summer_r' | 'tab10' | 'tab10_r' | 'tab20' | 'tab20_r' | 'tab20b' | 'tab20b_r' | 'tab20c' | 'tab20c_r' | 'tarn' | 'tarn_r' | 'tempo' | 'tempo_r' | 'terrain' | 'terrain_r' | 'thermal' | 'thermal_r' | 'topo' | 'topo_r' | 'turbid' | 'turbid_r' | 'turbo' | 'turbo_r' | 'twilight' | 'twilight_r' | 'twilight_shifted' | 'twilight_shifted_r' | 'viridis' | 'viridis_r' | 'winter' | 'winter_r' | 'wistia' | 'wistia_r' | 'ylgn' | 'ylgn_r' | 'ylgnbu' | 'ylgnbu_r' | 'ylorbr' | 'ylorbr_r' | 'ylorrd' | 'ylorrd_r'

Colormap name

colormapstring nullable

JSON encoded custom Colormap

return_maskboolean nullable

Add mask to the output data. Defaults to True

Response

Return an image.

Changes

No recorded changes to this operation across all 1 revision of this API.