--- title: "Feature Image" method: POST path: "/tiles/cog/feature.{format}" tags: ["Cloud Optimized GeoTIFF"] --- # Feature Image `POST /tiles/cog/feature.{format}` ## Request - Base URL: `https://app.chloris.earth` (the document declares no server; this is the origin it was published from) - URL: `https://app.chloris.earth/tiles/cog/feature.{format}` - Auth: API key in query parameter `access_token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Create image from a geojson feature. ## Path parameters - `format` 'png' | 'npy' | 'tif' | 'jpeg' | 'jpg' | 'jp2' | 'webp' | 'pngraw', required: Available Output image type. ## Query parameters - `data_path` string, nullable: The reporting unit entry's dataPath parameter. Should be used instead of `url` in most cases. - `carbon_pool` string, nullable: The carbon pool for the report unit layer. Valid options are: agb, bgb, dom. Defaults to agb. Requires data_path to be set. - `product_type` string, nullable: The product type for the report unit layer. Valid options are: stock, change, cumulative_change, forest, nonforest, forest_area_gain, forest_area_loss, forest_area_degradation. Requires data_path to be set. - `product_variant` string, nullable: The product variant id for the report unit layer. May be omitted to use the default variant. Requires data_path and product_type to be set. Deprecated in favor of carbon_pool and resolution. - `resolution` integer, nullable: The nominal group distance in meters report unit layer. May be omitted to use highest resolution available for the given zoom level. Requires data_path and product_type to be set. - `year` integer, nullable: The year for the report unit layer. Should be used instead of `bidx` in most cases. Requires data_path and product_type to be set. - `analysis_completed_at` string, nullable: The analysisCompletedAt from the report unit entry to ensure the latest data is fetched. - `url` string, nullable: Dataset URL, may be omitted if using data_path (recommended). - `bidx` integer[], nullable: Dataset band indexes - `expression` string, nullable: rio-tiler's band math expression - `nodata` union: Overwrite internal Nodata value - number - integer - string - `unscale` boolean, nullable: Apply internal Scale/Offset. Defaults to `False`. - `resampling` 'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'gauss' | 'rms', nullable: RasterIO resampling algorithm. Defaults to `nearest`. - `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_size` integer, nullable - `height` integer, nullable - `width` integer, nullable - `coord_crs` string, nullable: Coordinate Reference System of the input coords. Default to `epsg:4326`. - `dst_crs` string, nullable: Output Coordinate Reference System. - `algorithm` 'hillshade' | 'contours' | 'normalizedIndex' | 'terrarium' | 'terrainrgb': Algorithm name - `algorithm_params` string, nullable: Algorithm parameter - `rescale` string[], nullable: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. - `color_formula` string, nullable: rio-color formula (info: https://github.com/mapbox/rio-color) - `colormap_name` 'turbo' | 'rplumbo' | 'turbid' | 'summer_r' | 'pubu' | 'pastel2' | 'greys' | 'oxy' | 'jet_r' | 'ylgnbu_r' | 'gist_yarg_r' | 'coolwarm_r' | 'solar_r' | 'tab20c_r' | 'balance_r' | 'algae' | 'speed' | 'rdylgn' | 'gist_yarg' | 'delta_r' | 'set2' | 'gray_r' | 'spectral' | 'rainbow' | 'jet' | 'greens_r' | 'gnuplot2' | 'flag_r' | 'topo_r' | 'viridis' | 'cubehelix' | 'spring' | 'set1_r' | 'rain_r' | 'pastel2_r' | 'tab10_r' | 'gist_gray_r' | 'hot_r' | 'gist_earth' | 'nipy_spectral_r' | 'purples' | 'twilight_r' | 'amp' | 'gist_gray' | 'copper_r' | 'brbg_r' | 'rdylbu' | 'diff_r' | 'phase_r' | 'ice_r' | 'puor' | 'curl' | 'thermal' | 'inferno_r' | 'gist_stern_r' | 'deep' | 'seismic_r' | 'set2_r' | 'dense_r' | 'seismic' | 'haline' | 'diff' | 'bwr' | 'dense' | 'rdgy' | 'tarn_r' | 'prgn' | 'blues' | 'rdylbu_r' | 'rdpu_r' | 'accent' | 'oranges' | 'matter' | 'hsv' | 'orrd_r' | 'copper' | 'brg_r' | 'pubugn' | 'blues_r' | 'rain' | 'algae_r' | 'rdbu_r' | 'rainbow_r' | 'pubu_r' | 'reds_r' | 'winter' | 'puor_r' | 'spectral_r' | 'flag' | 'inferno' | 'gnbu_r' | 'wistia_r' | 'hot' | 'prism' | 'pubugn_r' | 'balance' | 'afmhot' | 'nipy_spectral' | 'brbg' | 'spring_r' | 'terrain' | 'coolwarm' | 'cividis_r' | 'ylorbr' | 'purd_r' | 'bugn_r' | 'ylgn' | 'bupu_r' | 'amp_r' | 'turbid_r' | 'oranges_r' | 'paired' | 'magma_r' | 'oxy_r' | 'set3_r' | 'purples_r' | 'rdylgn_r' | 'plasma_r' | 'curl_r' | 'ylorrd_r' | 'plasma' | 'wistia' | 'pink' | 'bone_r' | 'set3' | 'ylgnbu' | 'tempo_r' | 'brg' | 'thermal_r' | 'dark2_r' | 'gist_heat' | 'ylorbr_r' | 'twilight' | 'prgn_r' | 'twilight_shifted_r' | 'piyg' | 'gist_earth_r' | 'speed_r' | 'gist_rainbow_r' | 'gist_rainbow' | 'gist_ncar' | 'piyg_r' | 'ylgn_r' | 'set1' | 'ice' | 'cubehelix_r' | 'tab20c' | 'binary' | 'accent_r' | 'delta' | 'bone' | 'gnuplot' | 'reds' | 'tab20' | 'greys_r' | 'gist_heat_r' | 'schwarzwald' | 'rdgy_r' | 'tab10' | 'bupu' | 'cividis' | 'pink_r' | 'tarn' | 'purd' | 'tab20_r' | 'gist_ncar_r' | 'viridis_r' | 'gist_stern' | 'gray' | 'gnbu' | 'tab20b' | 'turbo_r' | 'summer' | 'pastel1_r' | 'binary_r' | 'tempo' | 'cmrmap' | 'ylorrd' | 'matter_r' | 'afmhot_r' | 'ocean' | 'tab20b_r' | 'phase' | 'pastel1' | 'prism_r' | 'haline_r' | 'magma' | 'orrd' | 'cmrmap_r' | 'cfastie' | 'winter_r' | 'hsv_r' | 'terrain_r' | 'solar' | 'gnuplot_r' | 'topo' | 'cool_r' | 'autumn_r' | 'gnuplot2_r' | 'cool' | 'twilight_shifted' | 'ocean_r' | 'rdpu' | 'autumn' | 'greens' | 'bwr_r' | 'deep_r' | 'rdbu' | 'dark2' | 'paired_r' | 'bugn' | '2024-02-23_cumulative_change_light' | '2023-07-18_forest_area_gain_light' | '2023-07-18_forest_area_loss_light' | '2023-07-18_non_forest_light' | '2023-07-18_forest_light' | '2023-07-18_forest_area_degradation_light' | '2024-04-09_stock_light_650' | '2023-06-07_stock_light_100' | '2023-06-07_stock_light_150' | '2023-06-07_stock_light_200' | '2023-06-07_stock_light_250' | '2022-11-18_change_light': Colormap name - `colormap` string, nullable: JSON encoded custom Colormap - `return_mask` boolean, nullable: Add mask to the output data. Defaults to `True` ## Request body - Feature: Feature Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'Feature', required - `geometry` union, required - PointInput: Point Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'Point', required - `coordinates` union, required - unknown[] - unknown - unknown[] - unknown - MultiPoint: MultiPoint Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'MultiPoint', required - `coordinates` union[], required - union - unknown[] - unknown - unknown[] - unknown - LineString: LineString Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'LineString', required - `coordinates` union[], required - union - unknown[] - unknown - unknown[] - unknown - MultiLineString: MultiLineString Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'MultiLineString', required - `coordinates` array[], required - union[] - union - unknown[] - … - unknown[] - … - Polygon: Polygon Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'Polygon', required - `coordinates` array[], required - union[] - union - unknown[] - … - unknown[] - … - MultiPolygon: MultiPolygon Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'MultiPolygon', required - `coordinates` array[], required - array[] - union[] - union - … - GeometryCollectionInput: GeometryCollection Model - `bbox` union - unknown[] - unknown - unknown[] - unknown - `type` 'GeometryCollection', required - `geometries` union[], required - union - PointInput: Point Model - `bbox` union - … - `type` 'Point', required - `coordinates` union, required - … - MultiPoint: MultiPoint Model - `bbox` union - … - `type` 'MultiPoint', required - `coordinates` union[], required - … - LineString: LineString Model - `bbox` union - … - `type` 'LineString', required - `coordinates` union[], required - … - MultiLineString: MultiLineString Model - `bbox` union - … - `type` 'MultiLineString', required - `coordinates` array[], required - … - Polygon: Polygon Model - `bbox` union - … - `type` 'Polygon', required - `coordinates` array[], required - … - MultiPolygon: MultiPolygon Model - `bbox` union - … - `type` 'MultiPolygon', required - `coordinates` array[], required - … - GeometryCollectionInput (recursive) - `properties` union, required - object - BaseModel - `id` union - integer - string ## Response `200` Return an image. ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/chloris/apis/chloris-geospatial-s-dynamic-tiler.md) - [All operations](https://skmtc.dev/chloris/apis/chloris-geospatial-s-dynamic-tiler/llms.txt) - [OpenAPI document](https://skmtc.dev/chloris/apis/chloris-geospatial-s-dynamic-tiler/revisions/8c654362f5b5?raw)