Raster Management |
AddRasterConstraints1
Adds raster constraints to a loaded raster table for a specific column that constrains spatial ref, scaling, blocksize, alignment, bands, band type and a flag to denote if raster column is regularly blocked. The table must be loaded with data for the constraints to be inferred. Returns true of the constraint setting was accomplished and if issues a notice.- rasttable, rastcolumn, srid, scale_x, scale_y, blocksize_x, blocksize_y, same_alignment, regular_blocking, num_bands=true, pixel_types=true, nodata_values=true, out_db=true, extent=true
- rasttable, rastcolumn, VARIADIC constraints
- rastschema, rasttable, rastcolumn, VARIADIC constraints
- rastschema, rasttable, rastcolumn, srid=true, scale_x=true, scale_y=true, blocksize_x=true, blocksize_y=true, same_alignment=true, regular_blocking=true, num_bands=true, pixel_types=true, nodata_values=true, out_db=true, extent=true
|
DropRasterConstraints1
Drops PostGIS raster constraints that refer to a raster table column. Useful if you need to reload data or update your raster column data.- rasttable, rastcolumn, srid, scale_x, scale_y, blocksize_x, blocksize_y, same_alignment, regular_blocking, num_bands=true, pixel_types=true, nodata_values=true, out_db=true, extent=true
- rastschema, rasttable, rastcolumn, srid=true, scale_x=true, scale_y=true, blocksize_x=true, blocksize_y=true, same_alignment=true, regular_blocking=true, num_bands=true, pixel_types=true, nodata_values=true, out_db=true, extent=true
- rastschema, rasttable, rastcolumn, constraints
|
PostGIS_Raster_Lib_Build_Date
()
Reports full raster library build date.
|
PostGIS_Raster_Lib_Version
()
Reports full raster version and build configuration
infos.
|
ST_GDALDrivers1
()
Returns a list of raster formats supported by your lib gdal. These are the formats you can output your raster using ST_AsGDALRaster.
|
Raster Constructors |
ST_AddBand
Returns a raster with the new band(s) of given type added with given initial value in the given index location. If no index is specified, the band is added to the end.- rast, pixeltype, initialvalue=0, nodataval=NULL
- rast, index, pixeltype, initialvalue=0, nodataval=NULL
- torast, fromrast, fromband=1, torastindex=at_end
- torast, fromrasts, fromband=1
|
ST_AsRaster1
Converts a PostGIS geometry to a PostGIS raster.- geom, ref, pixeltype, value=1, nodataval=0, touched=false
- geom, ref, pixeltype=ARRAY['8BUI'], value=ARRAY[1], nodataval=ARRAY[0], touched=false
- geom, scalex, scaley, gridx, gridy, pixeltype, value=1, nodataval=0, skewx=0, skewy=0, touched=false
- geom, scalex, scaley, gridx=NULL, gridy=NULL, pixeltype=ARRAY['8BUI'], value=ARRAY[1], nodataval=ARRAY[0], skewx=0, skewy=0, touched=false
- geom, scalex, scaley, pixeltype, value=1, nodataval=0, upperleftx=NULL, upperlefty=NULL, skewx=0, skewy=0, touched=false
- geom, scalex, scaley, pixeltype, value=ARRAY[1], nodataval=ARRAY[0], upperleftx=NULL, upperlefty=NULL, skewx=0, skewy=0, touched=false
- geom, width, height, gridx, gridy, pixeltype, value=1, nodataval=0, skewx=0, skewy=0, touched=false
- geom, width, height, gridx=NULL, gridy=NULL, pixeltype=ARRAY['8BUI'], value=ARRAY[1], nodataval=ARRAY[0], skewx=0, skewy=0, touched=false
- geom, width, height, pixeltype, value=1, nodataval=0, upperleftx=NULL, upperlefty=NULL, skewx=0, skewy=0, touched=false
- geom, width, height, pixeltype, value=ARRAY[1], nodataval=ARRAY[0], upperleftx=NULL, upperlefty=NULL, skewx=0, skewy=0, touched=false
|
ST_Band1
Returns one or more bands of an existing raster as a new raster. Useful for building new rasters from existing rasters.- rast, nbands = ARRAY[1]
- rast, nbands, delimiter=,
- rast, nband
|
ST_MakeEmptyRaster
Returns an empty raster (having no bands) of given dimensions (width & height), upperleft X and Y, pixel size and rotation (scalex, scaley, skewx & skewy) and reference system (srid).
If a raster is passed in, returns a new raster with the same size, alignment and SRID. If srid is left out, the spatial ref is set to unknown (0).- rast
- width, height, upperleftx, upperlefty, scalex, scaley, skewx, skewy, srid=unknown
- width, height, upperleftx, upperlefty, pixelsize
|
Raster Accessors |
ST_GeoReference
(rast, format=GDAL)
Returns the georeference meta data in GDAL or ESRI format as commonly seen in a world file. Default is GDAL.
|
ST_Height
(rast)
Returns the height of the raster in pixels.
|
ST_MetaData
(rast)
Returns basic meta data about a raster object such as pixel size, rotation (skew), upper, lower left, etc.
|
ST_NumBands
(rast)
Returns the number of bands in the raster object.
|
ST_PixelHeight
(rast)
Returns the pixel height in geometric units of the spatial reference system.
|
ST_PixelWidth
(rast)
Returns the pixel width in geometric units of the spatial reference system.
|
ST_ScaleX
(rast)
Returns the X component of the pixel width in units of coordinate reference system.
|
ST_ScaleY
(rast)
Returns the Y component of the pixel height in units of coordinate reference system.
|
ST_Raster2WorldCoordX
Returns the geometric X coordinate upper left of a raster, column and row. Numbering of columns
and rows starts at 1.- rast, xcolumn
- rast, xcolumn, yrow
|
ST_Raster2WorldCoordY
Returns the geometric Y coordinate upper left corner of a raster, column and row. Numbering of columns
and rows starts at 1. - rast, yrow
- rast, xcolumn, yrow
|
ST_Rotation
(rast)
Returns the rotation of the raster in radian.
|
ST_SkewX
(rast)
Returns the georeference X skew (or rotation parameter).
|
ST_SkewY
(rast)
Returns the georeference Y skew (or rotation parameter).
|
ST_SRID
(rast)
Returns the spatial reference identifier of the raster as defined in spatial_ref_sys table.
|
ST_UpperLeftX
(rast)
Returns the upper left X coordinate of raster in projected spatial ref.
|
ST_UpperLeftY
(rast)
Returns the upper left Y coordinate of raster in projected spatial ref.
|
ST_Width
(rast)
Returns the width of the raster in pixels.
|
ST_World2RasterCoordX
Returns the column in the raster of the point geometry (pt) or a X and Y world coordinate (xw, yw) represented
in world spatial reference system of raster.- rast, pt
- rast, xw
- rast, xw, yw
|
ST_World2RasterCoordY
Returns the row in the raster of the point geometry (pt) or a X and Y world coordinate (xw, yw) represented
in world spatial reference system of raster.- rast, pt
- rast, xw
- rast, xw, yw
|
ST_IsEmpty
(rast)
Returns true if the raster is empty (width = 0 and height = 0). Otherwise, returns false.
|
Raster Pixel Accessors and Setters |
ST_PixelAsPolygon
(rast, columnx, rowy)
Returns the geometry that bounds the pixel for a particular row and column.
|
ST_PixelAsPolygons
(rast, band=1)
Returns the geometry that bounds every pixel of a raster band along with the value, the X and the Y raster coordinates of each pixel.
|
ST_Value2
Returns the value of a given band in a given columnx, rowy pixel or at a particular geometric point. Band numbers start at 1 and assumed to be 1 if not specified. If exclude_nodata_value is set to false, then all pixels include nodata pixels are considered to intersect and return value. If exclude_nodata_value is not passed in then reads it from metadata of raster.- rast, pt, exclude_nodata_value=true
- rast, bandnum, pt, exclude_nodata_value=true
- rast, columnx, rowy, exclude_nodata_value=true
- rast, bandnum, columnx, rowy, exclude_nodata_value=true
|
ST_SetValue
Returns modified raster resulting from setting the value of a given band in a given columnx, rowy pixel or at a pixel that intersects a particular geometric point. Band numbers start at 1 and assumed to be 1 if not specified.- rast, pt, newvalue
- rast, bandnum, pt, newvalue
- rast, columnx, rowy, newvalue
- rast, bandnum, columnx, rowy, newvalue
|
Raster Editors |
ST_SetGeoReference
(rast, georefcoords, format=GDAL)
Set Georeference 6 georeference parameters in a single call. Numbers should be separated by white space. Accepts inputs in GDAL or ESRI format. Default is GDAL.
|
ST_SetRotation
(rast, rotation)
Set the rotation of the raster in radian.
|
ST_SetScale
Sets the X and Y size of pixels in units of coordinate reference system. Number units/pixel width/height.- rast, xy
- rast, x, y
|
ST_SetSkew
Sets the georeference X and Y skew (or rotation parameter). If only one is passed in, sets X and Y to the same value.- rast, skewxy
- rast, skewx, skewy
|
ST_SetSRID
(rast, srid)
Sets the SRID of a raster to a particular integer srid defined in the spatial_ref_sys table.
|
ST_SetUpperLeft
(rast, x, y)
Sets the value of the upper left corner of the pixel to projected X and Y coordinates.
|
ST_Resample1
Resample a raster using a specified resampling algorithm, new dimensions, an arbitrary grid corner and a set of raster georeferencing attributes defined or borrowed from another raster. New pixel values are computed using the NearestNeighbor (english or american spelling), Bilinear, Cubic, CubicSpline or Lanczos resampling algorithm. Default is NearestNeighbor.- rast, width, height, srid=same_as_rast, gridx=NULL, gridy=NULL, skewx=0, skewy=0, algorithm=NearestNeighbour, maxerr=0.125
- rast, srid=NULL, scalex=0, scaley=0, gridx=NULL, gridy=NULL, skewx=0, skewy=0, algorithm=NearestNeighbor, maxerr=0.125
- rast, ref, algorithm=NearestNeighbour, maxerr=0.125, usescale=true
- rast, ref, usescale, algorithm=NearestNeighbour, maxerr=0.125
|
ST_Rescale1
Resample a raster by adjusting only its scale (or pixel size). New pixel values are computed using the NearestNeighbor (english or american spelling), Bilinear, Cubic, CubicSpline or Lanczos resampling algorithm. Default is NearestNeighbor.
- rast, scalexy, algorithm=NearestNeighbour, maxerr=0.125
- rast, scalex, scaley, algorithm=NearestNeighbour, maxerr=0.125
|
ST_Reskew1
Resample a raster by adjusting only its skew (or rotation parameters). New pixel values are computed using the NearestNeighbor (english or american spelling), Bilinear, Cubic, CubicSpline or Lanczos resampling algorithm. Default is NearestNeighbor.
- rast, skewxy, algorithm=NearestNeighbour, maxerr=0.125
- rast, skewx, skewy, algorithm=NearestNeighbour, maxerr=0.125
|
ST_SnapToGrid1
Resample a raster by snapping it to a grid. New pixel values are computed using the NearestNeighbor (english or american spelling), Bilinear, Cubic, CubicSpline or Lanczos resampling algorithm. Default is NearestNeighbor.
- rast, gridx, gridy, algorithm=NearestNeighbour, maxerr=0.125, scalex=DEFAULT 0, scaley=DEFAULT 0
- rast, gridx, gridy, scalex, scaley, algorithm=NearestNeighbour, maxerr=0.125
- rast, gridx, gridy, scalexy, algorithm=NearestNeighbour, maxerr=0.125
|
ST_Transform1
Reprojects a raster in a known spatial reference system to another known spatial reference system using specified resampling algorithm. Options are NearestNeighbor, Bilinear, Cubic, CubicSpline, Lanczos defaulting to NearestNeighbor.- rast, srid, scalex, scaley, algorithm=NearestNeighbor, maxerr=0.125
- rast, srid, algorithm=NearestNeighbor, maxerr=0.125, scalex, scaley
|
Raster Band Statistics and Analytics |
ST_Count1
Returns the number of pixels in a given band of a raster or raster coverage. If no band is specified defaults to band 1. If exclude_nodata_value is set to true, will only count pixels that are not equal to the nodata value.- rast, nband=1, exclude_nodata_value=true
- rast, exclude_nodata_value
- rastertable, rastercolumn, nband=1, exclude_nodata_value=true
- rastertable, rastercolumn, exclude_nodata_value
|
ST_Histogram1
Returns a set of histogram summarizing a raster or raster coverage data distribution separate bin ranges. Number of bins are autocomputed if not specified.- rast, nband=1, exclude_nodata_value=true, bins=autocomputed, width=NULL, right=false
- rast, nband, bins, width=NULL, right=false
- rast, nband, exclude_nodata_value, bins, right
- rast, nband, bins, right
- rastertable, rastercolumn, nband, bins, right
- rastertable, rastercolumn, nband, exclude_nodata_value, bins, right
- rastertable, rastercolumn, nband=1, exclude_nodata_value=true, bins=autocomputed, width=NULL, right=false
- rastertable, rastercolumn, nband=1, bins, width=NULL, right=false
|
ST_Quantile1
Compute quantiles for a raster or raster table coverage in the context of the sample or population. Thus, a value could be examined to be at the raster's 25%, 50%, 75% percentile.- rast, nband=1, exclude_nodata_value=true, quantiles=NULL
- rast, quantiles
- rast, nband, quantiles
- rast, quantile
- rast, exclude_nodata_value, quantile=NULL
- rast, nband, quantile
- rast, nband, exclude_nodata_value, quantile
- rast, nband, quantile
- rastertable, rastercolumn, nband=1, exclude_nodata_value=true, quantiles=NULL
- rastertable, rastercolumn, nband, quantiles
|
ST_SummaryStats1
Returns summary stats consisting of count,sum,mean,stddev,min,max for a given raster band of a raster or raster coverage. Band 1 is assumed is no band is specified.- rastertable, rastercolumn, exclude_nodata_value
- rast, exclude_nodata_value
- rastertable, rastercolumn, nband=1, exclude_nodata_value=true
- rast, nband, exclude_nodata_value
|
ST_ValueCount1
Returns a set of records containing a pixel band value and count of the number of pixels in a given band of a raster (or a raster coverage) that have a given set of values. If no band is specified defaults to band 1. By default nodata value pixels are not counted.
and all other values in the pixel are output and pixel band values are rounded to the nearest integer.- rast, nband=1, exclude_nodata_value=true, searchvalues=NULL, roundto=0,
- rast, nband, searchvalues, roundto=0,
- rast, searchvalues, roundto=0,
- rast, searchvalue, roundto=0
- rast, nband, exclude_nodata_value, searchvalue, roundto=0
- rast, nband, searchvalue, roundto=0
- rastertable, rastercolumn, nband=1, exclude_nodata_value=true, searchvalues=NULL, roundto=0,
- rastertable, rastercolumn, searchvalues, roundto=0,
- rastertable, rastercolumn, nband, searchvalues, roundto=0,
- rastertable, rastercolumn, nband, exclude_nodata_value, searchvalue, roundto=0
- rastertable, rastercolumn, searchvalue, roundto=0
- rastertable, rastercolumn, nband, searchvalue, roundto=0
|
Raster Outputs |
ST_AsBinary
(rast)
Return the Well-Known Binary (WKB) representation of the raster without SRID meta data.
|
ST_AsGDALRaster1
(rast, format, options=NULL, srid=sameassource)
Return the raster tile in the designated GDAL Raster format. Raster formats are one of those supported by your compiled library. Use ST_GDALRasters() to get a list of formats supported by your library.
|
ST_AsJPEG1
Return the raster tile selected bands as a single Joint Photographic Exports Group (JPEG) image (byte array). If no band is specified and 1 or more than 3 bands, then only the first band is used. If only 3 bands then all 3 bands are used and mapped to RGB.- rast, options=NULL
- rast, nband, quality
- rast, nband, options=NULL
- rast, nbands, options=NULL
- rast, nbands, quality
|
ST_AsPNG1
Return the raster tile selected bands as a single portable network graphics (PNG) image (byte array). If 1, 3, or 4 bands in raster and no bands are specified, then all bands are used. If more 2 or more than 4 bands and no bands specified, then only band 1 is used. Bands are mapped to RGB or RGBA space.- rast, options=NULL
- rast, nband, compression
- rast, nband, options=NULL
- rast, nbands, compression
- rast, nbands, options=NULL
|
ST_AsTIFF1
Return the raster selected bands as a single TIFF image (byte array). If no band is specified, then will try to use all bands.- rast, options='', srid=sameassource
- rast, compression='', srid=sameassource
- rast, nbands, compression='', srid=sameassource
- rast, nbands, options, srid=sameassource
|
Raster Processing |
Box3D
(rast)
Returns the box 3d representation of the enclosing box of the raster.
|
ST_Clip1
Returns the raster clipped by the input geometry. If no band is specified all bands are returned. If crop is not specified, true is assumed meaning
the output raster is cropped.- rast, geom, nodataval=NULL, crop=true
- rast, geom, crop
- rast, band, geom, crop
|
ST_ConvexHull
(rast)
Return the convex hull geometry of the raster including pixel values equal to BandNoDataValue.
For regular shaped and non-skewed
rasters, this gives the same result as ST_Envelope so only useful for irregularly shaped or skewed rasters.
|
ST_DumpAsPolygons
(rast, band_num=1)
Returns a set of geomval (geom,val) rows, from a given raster band. If no band number is specified, band num defaults to 1.
|
ST_Envelope
(rast)
Returns the polygon representation of the extent of the raster.
|
ST_HillShade1
(rast, band, pixeltype, azimuth, altitude, max_bright=255, elevation_scale=1)
Returns the hypothetical illumination of an elevation raster band using provided azimuth, altitude, brightness and elevation scale inputs. Useful for visualizing terrain.
|
ST_Aspect1
(rast, band, pixeltype)
Returns the surface aspect of an elevation raster band. Useful for analyzing terrain.
|
ST_Slope1
(rast, band, pixeltype)
Returns the surface slope of an elevation raster band. Useful for analyzing terrain.
|
ST_Intersection2
Returns a raster or a set of geometry-pixelvalue pairs representing the shared portion of two rasters or the geometrical intersection of a vectorization of the raster and a geometry.- geom, rast, band_num=1
- rast, geom
- rast, band_num, geom
- rast1, rast2, nodataval
- rast1, rast2, returnband='BOTH', nodataval=NULL
- rast1, band_num1, rast2, band_num2, nodataval
- rast1, band_num1, rast2, band_num2, returnband='BOTH', nodataval=NULL
|
ST_MapAlgebraExpr1
1 raster band version: Creates a new one band raster formed by applying a valid PostgreSQL algebraic operation on the input raster band and of pixeltype provided. Band 1 is assumed if no band is specified.- rast, band, pixeltype, expression, nodataval=NULL
- rast, pixeltype, expression, nodataval=NULL
|
ST_MapAlgebraExpr1
2 raster band version: Creates a new one band raster formed by applying a valid PostgreSQL algebraic operation on the two input raster bands and of pixeltype provided. band 1 of each raster is assumed if no band numbers are specified. The resulting raster will be aligned (scale, skew and pixel corners) on the grid defined by the first raster and have its extent defined by the "extenttype" parameter. Values for "extenttype" can be: INTERSECTION, UNION, FIRST, SECOND.- rast1, rast2, expression, pixeltype=same_as_rast1_band, extenttype=INTERSECTION, nodata1expr=NULL, nodata2expr=NULL, nodatanodataval=NULL
- rast1, band1, rast2, band2, expression, pixeltype=same_as_rast1_band, extenttype=INTERSECTION, nodata1expr=NULL, nodata2expr=NULL, nodatanodataval=NULL
|
ST_MapAlgebraFct1
1 band version - Creates a new one band raster formed by applying a valid PostgreSQL function on the input raster band and of pixeltype prodived. Band 1 is assumed if no band is specified.- rast, onerasteruserfunc
- rast, onerasteruserfunc, VARIADIC args
- rast, pixeltype, onerasteruserfunc
- rast, pixeltype, onerasteruserfunc, VARIADIC args
- rast, band, onerasteruserfunc
- rast, band, onerasteruserfunc, VARIADIC args
- rast, band, pixeltype, onerasteruserfunc
- rast, band, pixeltype, onerasteruserfunc, VARIADIC args
|
ST_MapAlgebraFct1
2 band version - Creates a new one band raster formed by applying a valid PostgreSQL function on the 2 input raster bands and of pixeltype prodived. Band 1 is assumed if no band is specified. Extent type defaults to INTERSECTION if not specified.- rast1, rast2, tworastuserfunc, pixeltype=same_as_rast1, extenttype=INTERSECTION, VARIADIC userargs
- rast1, band1, rast2, band2, tworastuserfunc, pixeltype=same_as_rast1, extenttype=INTERSECTION, VARIADIC userargs
|
ST_MapAlgebraFctNgb1
(rast, band, pixeltype, ngbwidth, ngbheight, onerastngbuserfunc, nodatamode, VARIADIC args)
1-band version: Map Algebra Nearest Neighbor using user-defined PostgreSQL function. Return a raster which values are the result of a PLPGSQL user function involving a neighborhood of values from the input raster band.
|
ST_Polygon
(rast, band_num=1)
Returns a polygon geometry formed by the union of pixels that have a pixel value that is not no data value. If no band number is specified, band num defaults to 1.
|
ST_Reclass1
Creates a new raster composed of band types reclassified from original. The nband is the band to be changed. If nband is not specified assumed to be 1. All other bands are returned unchanged.
Use case: convert a 16BUI band to a 8BUI and so forth for simpler rendering as viewable formats.- rast, nband, reclassexpr, pixeltype, nodataval=NULL
- rast, VARIADIC reclassargset
- rast, reclassexpr, pixeltype
|
ST_Union1
Returns the union of a set of raster tiles into a single raster composed of 1 band. If no band is specified for unioning, band num 1 is assumed. The resulting raster's extent is the extent of the whole set. In the case of intersection, the resulting value is defined by p_expression which is one of the following: LAST - the default when none is specified, MEAN, SUM, FIRST, MAX, MIN.- rast
- rast, band_num
- rast, p_expression
- rast, band_num, p_expression
|