Découpe un objet raster selon la forme d'une géométrie et renvoie le résultat sous la forme d'un nouvel objet raster.
Syntaxe
raster ST_ClipToRast(raster raster_obj,
geometry geom,
integer pyramidLevel default 0,
cstring bands default '',
float8[] nodata default NULL,
cstring clipOption default '',
cstring storageOption default '')
Paramètres
| Paramètre | Description |
|---|---|
raster_obj |
Objet raster à découper. |
geom |
Objet géométrique utilisé pour le découpage. |
pyramidLevel |
Niveau de pyramide. Valeur par défaut : 0. |
bands |
Bandes à découper. Accepte le format de plage ('0-2') ou le format de liste ('1,2,3'). L'index des bandes commence à 0. Valeur par défaut : '' (toutes les bandes). |
nodata |
Valeurs NoData sous la forme d'un tableau float8[]. Si le nombre de valeurs fournies est inférieur au nombre de bandes découpées, la valeur NoData prédéfinie est utilisée pour chaque bande restante. Si une bande ne possède aucune valeur NoData prédéfinie, 0 est utilisé. Valeur par défaut : NULL. |
clipOption |
Options de découpage sous la forme d'une chaîne JSON. Consultez les champs clipOption. Valeur par défaut : ''. |
storageOption |
Options de stockage pour le raster renvoyé, sous la forme d'une chaîne JSON. Consultez les champs storageOption. Valeur par défaut : ''. |
Champs clipOption
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
window_clip |
bool | false |
Indique s'il faut découper en utilisant le rectangle englobant de la géométrie plutôt que la forme géométrique elle-même. Définissez ce paramètre sur true pour découper selon le rectangle englobant minimal (MBR) ; définissez-le sur false pour découper directement selon la géométrie. |
rast_coord |
bool | false |
Indique si la géométrie utilise des coordonnées de pixels. Lorsque la valeur est true, la coordonnée x correspond au numéro de colonne et la coordonnée y au numéro de ligne du pixel. |
Champs storageOption
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
chunking |
boolean | Identique au raster d'origine | Indique s'il faut stocker les nouvelles données raster sous forme de blocs (chunks). |
chunkdim |
string | Identique au raster d'origine | Dimensions des blocs pour le nouveau raster. Ce paramètre prend effet uniquement lorsque chunking est défini sur true. |
chunktable |
string | '' |
Nom de la table de blocs pour le nouveau raster. Si ce paramètre est défini sur '', une table de blocs temporaire avec un nom aléatoire est créée et n'est valide que pour la session en cours. Spécifiez un nom pour créer une table de blocs permanente. |
compression |
string | lz4 |
Algorithme de compression. Valeurs valides : none, jpeg, zlib, png, lzo, lz4. |
quality |
integer | 75 |
Qualité de compression. Ce paramètre prend effet uniquement lorsque compression est défini sur jpeg. |
interleaving |
string | Identique au raster d'origine | Type d'entrelacement. Valeurs valides : bip (band interleaved by pixel, BIP), bil (band interleaved by line, BIL), bsq (band sequential, BSQ). |
endian |
string | Identique au raster d'origine | Ordre des octets. Valeurs valides : NDR (little-endian), XDR (big-endian). |
Remarques d'utilisation
Si
chunktableest défini surNULLou'', une table de blocs temporaire avec un nom aléatoire est créée. Cette table n'est valide que pour la session en cours. Spécifiez un nom pour créer une table de blocs permanente.-
La taille de cache par défaut pour le découpage est de 100 Mo. Pour ajuster cette limite, exécutez la commande suivante :
SET ganos.raster.clip_max_buffer_size = <cache size in bytes>;
Exemples
-- Create a permanent result table.
CREATE TABLE rast_clip_result(id integer, rast raster);
-- Create a temporary result table.
CREATE TEMP TABLE rast_clip_result_temp(id integer, rast raster);
-- Clip using default settings and store the result in the temporary table.
INSERT INTO rast_clip_result_temp(id, rast)
SELECT 1, ST_ClipToRast(rast, ST_GeomFromText('Polygon((0 0, 45 45, 90 45, 45 0, 0 0))', 4326), 0)
FROM clip_table
WHERE id = 1;
-- Clip with a white background (NoData = 254) and store the result in the permanent table.
INSERT INTO rast_clip_result(id, rast)
SELECT 2, ST_ClipToRast(rast, ST_GeomFromText('Polygon((0 0, 45 45, 90 45, 45 0, 0 0))', 4326), 0, '', ARRAY[254,254,254], '', '{"chunktable":"clip_rbt"}')
FROM clip_table
WHERE id = 1;
-- Clip using the bounding box (MBR) of the geometry.
INSERT INTO rast_clip_result_temp(id, rast)
SELECT 3, ST_ClipToRast(rast, ST_GeomFromText('Polygon((0 0, 45 45, 90 45, 45 0, 0 0))', 4326), 0, '', NULL, '{"window_clip":true}', '')
FROM clip_table
WHERE id = 1;