1# -*- coding: utf-8 -*- 2# flake8: noqa 3from . import types 4 5 6_FUNCTIONS = [ 7 ('AddGeometryColumn', None, 8 '''Adds a geometry column to an existing table.'''), 9 ('DropGeometryColumn', None, 10 '''Removes a geometry column from a spatial table.'''), 11 ('DropGeometryTable', None, 12 '''Drops a table and all its references in geometry_columns.'''), 13 ('Find_SRID', None, 14 '''Returns the SRID defined for a geometry column.'''), 15 ('Populate_Geometry_Columns', None, 16 '''Ensures geometry columns are defined with type modifiers or have appropriate spatial constraints.'''), 17 ('UpdateGeometrySRID', None, 18 '''Updates the SRID of all features in a geometry column, and the table metadata.'''), 19 ('ST_Collect', types.Geometry, 20 '''Creates a GeometryCollection or Multi* geometry from a set of geometries.'''), 21 ('ST_LineFromMultiPoint', types.Geometry, 22 '''Creates a LineString from a MultiPoint geometry.'''), 23 ('ST_MakeEnvelope', types.Geometry, 24 '''Creates a rectangular Polygon from minimum and maximum coordinates.'''), 25 ('ST_MakeLine', types.Geometry, 26 '''Creates a Linestring from Point, MultiPoint, or LineString geometries.'''), 27 ('ST_MakePoint', types.Geometry, 28 '''Creates a 2D, 3DZ or 4D Point.'''), 29 ('ST_MakePointM', types.Geometry, 30 '''Creates a Point from X, Y and M values.'''), 31 ('ST_MakePolygon', types.Geometry, 32 '''Creates a Polygon from a shell and optional list of holes.'''), 33 ('ST_Point', types.Geometry, 34 '''Creates a Point with the given coordinate values. Alias for ST_MakePoint.'''), 35 ('ST_Polygon', types.Geometry, 36 '''[geometry] Creates a Polygon from a LineString with a specified SRID.\nOR\n[raster] Returns a multipolygon 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.'''), 37 ('ST_TileEnvelope', types.Geometry, 38 '''Creates a rectangular Polygon in Web Mercator (SRID:3857) using the XYZ tile system.'''), 39 ('GeometryType', None, 40 '''Returns the type of a geometry as text.'''), 41 ('ST_Boundary', types.Geometry, 42 '''Returns the boundary of a geometry.'''), 43 ('ST_CoordDim', None, 44 '''Return the coordinate dimension of a geometry.'''), 45 ('ST_Dimension', None, 46 '''Returns the topological dimension of a geometry.'''), 47 ('ST_Dump', types.GeometryDump, 48 '''Returns a set of geometry_dump rows for the components of a geometry.'''), 49 ('ST_DumpPoints', types.GeometryDump, 50 '''Returns a set of geometry_dump rows for the points in a geometry.'''), 51 ('ST_DumpRings', types.GeometryDump, 52 '''Returns a set of geometry_dump rows for the exterior and interior rings of a Polygon.'''), 53 ('ST_EndPoint', types.Geometry, 54 '''Returns the last point of a LineString or CircularLineString.'''), 55 ('ST_Envelope', types.Geometry, 56 '''[geometry] Returns a geometry representing the bounding box of a geometry.\nOR\n[raster] Returns the polygon representation of the extent of the raster.'''), 57 ('ST_BoundingDiagonal', types.Geometry, 58 '''Returns the diagonal of a geometry's bounding box.'''), 59 ('ST_ExteriorRing', types.Geometry, 60 '''Returns a LineString representing the exterior ring of a Polygon.'''), 61 ('ST_GeometryN', types.Geometry, 62 '''Return the Nth geometry element of a geometry collection.'''), 63 ('ST_GeometryType', None, 64 '''Returns the SQL-MM type of a geometry as text.'''), 65 ('ST_HasArc', None, 66 '''Tests if a geometry contains a circular arc'''), 67 ('ST_InteriorRingN', types.Geometry, 68 '''Returns the Nth interior ring (hole) of a Polygon.'''), 69 ('ST_IsPolygonCCW', None, 70 '''Tests if Polygons have exterior rings oriented counter-clockwise and interior rings oriented clockwise.'''), 71 ('ST_IsPolygonCW', None, 72 '''Tests if Polygons have exterior rings oriented clockwise and interior rings oriented counter-clockwise.'''), 73 ('ST_IsClosed', None, 74 '''Tests if a LineStrings's start and end points are coincident. For a PolyhedralSurface tests if it is closed (volumetric).'''), 75 ('ST_IsCollection', None, 76 '''Tests if a geometry is a geometry collection type.'''), 77 ('ST_IsEmpty', None, 78 '''[geometry] Tests if a geometry is empty.\nOR\n[raster] Returns true if the raster is empty (width = 0 and height = 0). Otherwise, returns false.'''), 79 ('ST_IsRing', None, 80 '''Tests if a LineString is closed and simple.'''), 81 ('ST_IsSimple', None, 82 '''Tests if a geometry has no points of self-intersection or self-tangency.'''), 83 ('ST_M', None, 84 '''Returns the M coordinate of a Point.'''), 85 ('ST_MemSize', None, 86 '''[geometry] Returns the amount of memory space a geometry takes.\nOR\n[raster] Returns the amount of space (in bytes) the raster takes.'''), 87 ('ST_NDims', None, 88 '''Returns the coordinate dimension of a geometry.'''), 89 ('ST_NPoints', None, 90 '''Returns the number of points (vertices) in a geometry.'''), 91 ('ST_NRings', None, 92 '''Returns the number of rings in a polygonal geometry.'''), 93 ('ST_NumGeometries', None, 94 '''Returns the number of elements in a geometry collection.'''), 95 ('ST_NumInteriorRings', None, 96 '''Returns the number of interior rings (holes) of a Polygon.'''), 97 ('ST_NumInteriorRing', None, 98 '''Returns the number of interior rings (holes) of a Polygon. Aias for ST_NumInteriorRings'''), 99 ('ST_NumPatches', None, 100 '''Return the number of faces on a Polyhedral Surface. Will return null for non-polyhedral geometries.'''), 101 ('ST_NumPoints', None, 102 '''Returns the number of points in a LineString or CircularString.'''), 103 ('ST_PatchN', types.Geometry, 104 '''Returns the Nth geometry (face) of a PolyhedralSurface.'''), 105 ('ST_PointN', types.Geometry, 106 '''Returns the Nth point in the first LineString or circular LineString in a geometry.'''), 107 ('ST_Points', types.Geometry, 108 '''Returns a MultiPoint containing all the coordinates of a geometry.'''), 109 ('ST_StartPoint', types.Geometry, 110 '''Returns the first point of a LineString.'''), 111 ('ST_Summary', None, 112 '''[geometry] Returns a text summary of the contents of a geometry.\nOR\n[raster] Returns a text summary of the contents of the raster.'''), 113 ('ST_X', None, 114 '''Returns the X coordinate of a Point.'''), 115 ('ST_Y', None, 116 '''Returns the Y coordinate of a Point.'''), 117 ('ST_Z', None, 118 '''Returns the Z coordinate of a Point.'''), 119 ('ST_Zmflag', None, 120 '''Returns a code indicating the ZM coordinate dimension of a geometry.'''), 121 ('ST_AddPoint', types.Geometry, 122 '''Add a point to a LineString.'''), 123 ('ST_CollectionExtract', types.Geometry, 124 '''Given a (multi)geometry, return a (multi)geometry consisting only of elements of the specified type.'''), 125 ('ST_CollectionHomogenize', types.Geometry, 126 '''Given a geometry collection, return the \"simplest\" representation of the contents.'''), 127 ('ST_Force2D', types.Geometry, 128 '''Force the geometries into a \"2-dimensional mode\".'''), 129 ('ST_Force3D', types.Geometry, 130 ('''Force the geometries into XYZ mode. This is an alias for ST_Force3DZ.''', 'ST_Force_3D')), 131 ('ST_Force3DZ', types.Geometry, 132 ('''Force the geometries into XYZ mode.''', 'ST_Force_3DZ')), 133 ('ST_Force3DM', types.Geometry, 134 ('''Force the geometries into XYM mode.''', 'ST_Force_3DZ')), 135 ('ST_Force4D', types.Geometry, 136 ('''Force the geometries into XYZM mode.''', 'ST_Force_4D')), 137 ('ST_ForcePolygonCCW', types.Geometry, 138 '''Orients all exterior rings counter-clockwise and all interior rings clockwise.'''), 139 ('ST_ForceCollection', types.Geometry, 140 ('''Convert the geometry into a GEOMETRYCOLLECTION.''', 'ST_Force_Collection')), 141 ('ST_ForcePolygonCW', types.Geometry, 142 '''Orients all exterior rings clockwise and all interior rings counter-clockwise.'''), 143 ('ST_ForceSFS', types.Geometry, 144 '''Force the geometries to use SFS 1.1 geometry types only.'''), 145 ('ST_ForceRHR', types.Geometry, 146 '''Force the orientation of the vertices in a polygon to follow the Right-Hand-Rule.'''), 147 ('ST_ForceCurve', types.Geometry, 148 '''Upcast a geometry into its curved type, if applicable.'''), 149 ('ST_LineMerge', types.Geometry, 150 '''Return a (set of) LineString(s) formed by sewing together a MULTILINESTRING.'''), 151 ('ST_Multi', types.Geometry, 152 '''Return the geometry as a MULTI* geometry.'''), 153 ('ST_Normalize', types.Geometry, 154 '''Return the geometry in its canonical form.'''), 155 ('ST_QuantizeCoordinates', types.Geometry, 156 '''Sets least significant bits of coordinates to zero'''), 157 ('ST_RemovePoint', types.Geometry, 158 '''Remove point from a linestring.'''), 159 ('ST_Reverse', types.Geometry, 160 '''Return the geometry with vertex order reversed.'''), 161 ('ST_Segmentize', types.Geometry, 162 '''Return a modified geometry/geography having no segment longer than the given distance.'''), 163 ('ST_SetPoint', types.Geometry, 164 '''Replace point of a linestring with a given point.'''), 165 ('ST_SnapToGrid', types.Geometry, 166 '''[geometry] Snap all points of the input geometry to a regular grid.\nOR\n[raster] 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.'''), 167 ('ST_Snap', types.Geometry, 168 '''Snap segments and vertices of input geometry to vertices of a reference geometry.'''), 169 ('ST_SwapOrdinates', types.Geometry, 170 '''Returns a version of the given geometry with given ordinate values swapped.'''), 171 ('ST_IsValid', None, 172 '''Tests if a geometry is well-formed in 2D.'''), 173 ('ST_IsValidDetail', None, 174 '''Returns a valid_detail row stating if a geometry is valid, and if not a reason why and a location.'''), 175 ('ST_IsValidReason', None, 176 '''Returns text stating if a geometry is valid, or a reason for invalidity.'''), 177 ('ST_SetSRID', types.Geometry, 178 '''[geometry] Set the SRID on a geometry to a particular integer value.\nOR\n[raster] Sets the SRID of a raster to a particular integer srid defined in the spatial_ref_sys table.'''), 179 ('ST_SRID', None, 180 '''[geometry] Returns the spatial reference identifier for the ST_Geometry as defined in spatial_ref_sys table.\nOR\n[raster] Returns the spatial reference identifier of the raster as defined in spatial_ref_sys table.'''), 181 ('ST_Transform', types.Geometry, 182 '''[geometry] Return a new geometry with its coordinates transformed to a different spatial reference system.\nOR\n[raster] 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.'''), 183 ('ST_BdPolyFromText', types.Geometry, 184 '''Construct a Polygon given an arbitrary collection of closed linestrings as a MultiLineString Well-Known text representation.'''), 185 ('ST_BdMPolyFromText', types.Geometry, 186 '''Construct a MultiPolygon given an arbitrary collection of closed linestrings as a MultiLineString text representation Well-Known text representation.'''), 187 ('ST_GeogFromText', types.Geography, 188 '''Return a specified geography value from Well-Known Text representation or extended (WKT).'''), 189 ('ST_GeographyFromText', types.Geography, 190 '''Return a specified geography value from Well-Known Text representation or extended (WKT).'''), 191 ('ST_GeomCollFromText', types.Geometry, 192 '''Makes a collection Geometry from collection WKT with the given SRID. If SRID is not given, it defaults to 0.'''), 193 ('ST_GeomFromEWKT', types.Geometry, 194 '''Return a specified ST_Geometry value from Extended Well-Known Text representation (EWKT).'''), 195 ('ST_GeometryFromText', types.Geometry, 196 '''Return a specified ST_Geometry value from Well-Known Text representation (WKT). This is an alias name for ST_GeomFromText'''), 197 ('ST_GeomFromText', types.Geometry, 198 '''Return a specified ST_Geometry value from Well-Known Text representation (WKT).'''), 199 ('ST_LineFromText', types.Geometry, 200 '''Makes a Geometry from WKT representation with the given SRID. If SRID is not given, it defaults to 0.'''), 201 ('ST_MLineFromText', types.Geometry, 202 '''Return a specified ST_MultiLineString value from WKT representation.'''), 203 ('ST_MPointFromText', types.Geometry, 204 '''Makes a Geometry from WKT with the given SRID. If SRID is not given, it defaults to 0.'''), 205 ('ST_MPolyFromText', types.Geometry, 206 '''Makes a MultiPolygon Geometry from WKT with the given SRID. If SRID is not given, it defaults to 0.'''), 207 ('ST_PointFromText', types.Geometry, 208 '''Makes a point Geometry from WKT with the given SRID. If SRID is not given, it defaults to unknown.'''), 209 ('ST_PolygonFromText', types.Geometry, 210 '''Makes a Geometry from WKT with the given SRID. If SRID is not given, it defaults to 0.'''), 211 ('ST_WKTToSQL', types.Geometry, 212 '''Return a specified ST_Geometry value from Well-Known Text representation (WKT). This is an alias name for ST_GeomFromText'''), 213 ('ST_GeogFromWKB', types.Geography, 214 '''Creates a geography instance from a Well-Known Binary geometry representation (WKB) or extended Well Known Binary (EWKB).'''), 215 ('ST_GeomFromEWKB', types.Geometry, 216 '''Return a specified ST_Geometry value from Extended Well-Known Binary representation (EWKB).'''), 217 ('ST_GeomFromWKB', types.Geometry, 218 '''Creates a geometry instance from a Well-Known Binary geometry representation (WKB) and optional SRID.'''), 219 ('ST_LineFromWKB', types.Geometry, 220 '''Makes a LINESTRING from WKB with the given SRID'''), 221 ('ST_LinestringFromWKB', types.Geometry, 222 '''Makes a geometry from WKB with the given SRID.'''), 223 ('ST_PointFromWKB', types.Geometry, 224 '''Makes a geometry from WKB with the given SRID'''), 225 ('ST_WKBToSQL', types.Geometry, 226 '''Return a specified ST_Geometry value from Well-Known Binary representation (WKB). This is an alias name for ST_GeomFromWKB that takes no srid'''), 227 ('ST_Box2dFromGeoHash', types.Geometry, 228 '''Return a BOX2D from a GeoHash string.'''), 229 ('ST_GeomFromGeoHash', types.Geometry, 230 '''Return a geometry from a GeoHash string.'''), 231 ('ST_GeomFromGML', types.Geometry, 232 '''Takes as input GML representation of geometry and outputs a PostGIS geometry object'''), 233 ('ST_GeomFromGeoJSON', types.Geometry, 234 '''Takes as input a geojson representation of a geometry and outputs a PostGIS geometry object'''), 235 ('ST_GeomFromKML', types.Geometry, 236 '''Takes as input KML representation of geometry and outputs a PostGIS geometry object'''), 237 ('ST_GeomFromTWKB', types.Geometry, 238 '''Creates a geometry instance from a TWKB (\"Tiny Well-Known Binary\") geometry representation.'''), 239 ('ST_GMLToSQL', types.Geometry, 240 '''Return a specified ST_Geometry value from GML representation. This is an alias name for ST_GeomFromGML'''), 241 ('ST_LineFromEncodedPolyline', types.Geometry, 242 '''Creates a LineString from an Encoded Polyline.'''), 243 ('ST_PointFromGeoHash', types.Geometry, 244 '''Return a point from a GeoHash string.'''), 245 ('ST_AsEWKT', None, 246 '''Return the Well-Known Text (WKT) representation of the geometry with SRID meta data.'''), 247 ('ST_AsText', None, 248 '''Return the Well-Known Text (WKT) representation of the geometry/geography without SRID metadata.'''), 249 ('ST_AsBinary', None, 250 '''Return the Well-Known Binary (WKB) representation of the geometry/geography without SRID meta data.'''), 251 ('ST_AsEWKB', None, 252 '''Return the Well-Known Binary (WKB) representation of the geometry with SRID meta data.'''), 253 ('ST_AsHEXEWKB', None, 254 '''Returns a Geometry in HEXEWKB format (as text) using either little-endian (NDR) or big-endian (XDR) encoding.'''), 255 ('ST_AsEncodedPolyline', None, 256 '''Returns an Encoded Polyline from a LineString geometry.'''), 257 ('ST_AsGeobuf', None, 258 '''Return a Geobuf representation of a set of rows.'''), 259 ('ST_AsGML', None, 260 '''Return the geometry as a GML version 2 or 3 element.'''), 261 ('ST_AsKML', None, 262 '''Return the geometry as a KML element. Several variants. Default version=2, default maxdecimaldigits=15'''), 263 ('ST_AsLatLonText', None, 264 '''Return the Degrees, Minutes, Seconds representation of the given point.'''), 265 ('ST_AsMVTGeom', types.Geometry, 266 '''Transform a geometry into the coordinate space of a Mapbox Vector Tile.'''), 267 ('ST_AsMVT', None, 268 '''Aggregate function returning a Mapbox Vector Tile representation of a set of rows.'''), 269 ('ST_AsSVG', None, 270 '''Returns SVG path data for a geometry.'''), 271 ('ST_AsTWKB', None, 272 '''Returns the geometry as TWKB, aka \"Tiny Well-Known Binary\"'''), 273 ('ST_AsX3D', None, 274 '''Returns a Geometry in X3D xml node element format: ISO-IEC-19776-1.2-X3DEncodings-XML'''), 275 ('ST_GeoHash', None, 276 '''Return a GeoHash representation of the geometry.'''), 277 ('ST_3DIntersects', None, 278 '''Returns TRUE if the Geometries \"spatially intersect\" in 3D - only for points, linestrings, polygons, polyhedral surface (area).'''), 279 ('ST_Contains', None, 280 '''[geometry] Returns true if and only if no points of B lie in the exterior of A, and at least one point of the interior of B lies in the interior of A.\nOR\n[raster] Return true if no points of raster rastB lie in the exterior of raster rastA and at least one point of the interior of rastB lies in the interior of rastA.'''), 281 ('ST_ContainsProperly', None, 282 '''[geometry] Returns true if B intersects the interior of A but not the boundary (or exterior). A does not contain properly itself, but does contain itself.\nOR\n[raster] Return true if rastB intersects the interior of rastA but not the boundary or exterior of rastA.'''), 283 ('ST_Covers', None, 284 '''[geometry] Returns 1 (TRUE) if no point in Geometry B is outside Geometry A\nOR\n[raster] Return true if no points of raster rastB lie outside raster rastA.'''), 285 ('ST_CoveredBy', None, 286 '''[geometry] Returns 1 (TRUE) if no point in Geometry/Geography A is outside Geometry/Geography B\nOR\n[raster] Return true if no points of raster rastA lie outside raster rastB.'''), 287 ('ST_Crosses', None, 288 '''Returns TRUE if the supplied geometries have some, but not all, interior points in common.'''), 289 ('ST_LineCrossingDirection', None, 290 '''Given 2 linestrings, returns a number between -3 and 3 denoting what kind of crossing behavior. 0 is no crossing.'''), 291 ('ST_Disjoint', None, 292 '''[geometry] Returns TRUE if the Geometries do not \"spatially intersect\" - if they do not share any space together.\nOR\n[raster] Return true if raster rastA does not spatially intersect rastB.'''), 293 ('ST_Equals', None, 294 '''Returns true if the given geometries represent the same geometry. Directionality is ignored.'''), 295 ('ST_Intersects', None, 296 '''[geometry] Returns TRUE if the Geometries/Geography \"spatially intersect in 2D\" - (share any portion of space) and FALSE if they don't (they are Disjoint). For geography tolerance is 0.00001 meters (so any points that close are considered to intersect)\nOR\n[raster] Return true if raster rastA spatially intersects raster rastB.'''), 297 ('ST_OrderingEquals', None, 298 '''Returns true if the given geometries represent the same geometry and points are in the same directional order.'''), 299 ('ST_Overlaps', None, 300 '''[geometry] Returns TRUE if the Geometries share space, are of the same dimension, but are not completely contained by each other.\nOR\n[raster] Return true if raster rastA and rastB intersect but one does not completely contain the other.'''), 301 ('ST_PointInsideCircle', None, 302 '''Is the point geometry inside the circle defined by center_x, center_y, radius'''), 303 ('ST_Relate', None, 304 '''Returns true if this Geometry is spatially related to anotherGeometry, by testing for intersections between the Interior, Boundary and Exterior of the two geometries as specified by the values in the intersectionMatrixPattern. If no intersectionMatrixPattern is passed in, then returns the maximum intersectionMatrixPattern that relates the 2 geometries.'''), 305 ('ST_RelateMatch', None, 306 '''Returns true if intersectionMattrixPattern1 implies intersectionMatrixPattern2'''), 307 ('ST_Touches', None, 308 '''[geometry] Returns TRUE if the geometries have at least one point in common, but their interiors do not intersect.\nOR\n[raster] Return true if raster rastA and rastB have at least one point in common but their interiors do not intersect.'''), 309 ('ST_Within', None, 310 '''[geometry] Returns true if the geometry A is completely inside geometry B\nOR\n[raster] Return true if no points of raster rastA lie in the exterior of raster rastB and at least one point of the interior of rastA lies in the interior of rastB.'''), 311 ('ST_3DDWithin', None, 312 '''For 3d (z) geometry type Returns true if two geometries 3d distance is within number of units.'''), 313 ('ST_3DDFullyWithin', None, 314 '''Returns true if all of the 3D geometries are within the specified distance of one another.'''), 315 ('ST_DFullyWithin', None, 316 '''[geometry] Returns true if all of the geometries are within the specified distance of one another\nOR\n[raster] Return true if rasters rastA and rastB are fully within the specified distance of each other.'''), 317 ('ST_DWithin', None, 318 '''[geometry] Returns true if the geometries are within the specified distance of one another. For geometry units are in those of spatial reference and for geography units are in meters and measurement is defaulted to use_spheroid=true (measure around spheroid), for faster check, use_spheroid=false to measure along sphere.\nOR\n[raster] Return true if rasters rastA and rastB are within the specified distance of each other.'''), 319 ('ST_Area', None, 320 '''Returns the area of a polygonal geometry.'''), 321 ('ST_Azimuth', None, 322 '''Returns the north-based azimuth as the angle in radians measured clockwise from the vertical on pointA to pointB.'''), 323 ('ST_Angle', None, 324 '''Returns the angle between 3 points, or between 2 vectors (4 points or 2 lines).'''), 325 ('ST_ClosestPoint', types.Geometry, 326 '''Returns the 2D point on g1 that is closest to g2. This is the first point of the shortest line.'''), 327 ('ST_3DClosestPoint', types.Geometry, 328 '''Returns the 3D point on g1 that is closest to g2. This is the first point of the 3D shortest line.'''), 329 ('ST_Distance', None, 330 '''Returns the distance between two geometry or geography values.'''), 331 ('ST_3DDistance', None, 332 '''Returns the 3D cartesian minimum distance (based on spatial ref) between two geometries in projected units.'''), 333 ('ST_DistanceSphere', None, 334 '''Returns minimum distance in meters between two lon/lat geometries using a spherical earth model.'''), 335 ('ST_DistanceSpheroid', None, 336 '''Returns the minimum distance between two lon/lat geometries using a spheroidal earth model.'''), 337 ('ST_FrechetDistance', None, 338 '''Returns the Fréchet distance between two geometries.'''), 339 ('ST_HausdorffDistance', None, 340 '''Returns the Hausdorff distance between two geometries.'''), 341 ('ST_Length', None, 342 '''Returns the 2D length of a linear geometry.'''), 343 ('ST_Length2D', None, 344 '''Returns the 2D length of a linear geometry. Alias for ST_Length'''), 345 ('ST_3DLength', None, 346 '''Returns the 3D length of a linear geometry.'''), 347 ('ST_LengthSpheroid', None, 348 '''Returns the 2D or 3D length/perimeter of a lon/lat geometry on a spheroid.'''), 349 ('ST_LongestLine', types.Geometry, 350 '''Returns the 2D longest line between two geometries.'''), 351 ('ST_3DLongestLine', types.Geometry, 352 '''Returns the 3D longest line between two geometries'''), 353 ('ST_MaxDistance', None, 354 '''Returns the 2D largest distance between two geometries in projected units.'''), 355 ('ST_3DMaxDistance', None, 356 '''Returns the 3D cartesian maximum distance (based on spatial ref) between two geometries in projected units.'''), 357 ('ST_MinimumClearance', None, 358 '''Returns the minimum clearance of a geometry, a measure of a geometry's robustness.'''), 359 ('ST_MinimumClearanceLine', types.Geometry, 360 '''Returns the two-point LineString spanning a geometry's minimum clearance.'''), 361 ('ST_Perimeter', None, 362 '''Returns the length of the boundary of a polygonal geometry or geography.'''), 363 ('ST_Perimeter2D', None, 364 '''Returns the 2D perimeter of a polygonal geometry. Alias for ST_Perimeter.'''), 365 ('ST_3DPerimeter', None, 366 '''Returns the 3D perimeter of a polygonal geometry.'''), 367 ('ST_Project', types.Geography, 368 '''Returns a point projected from a start point by a distance and bearing (azimuth).'''), 369 ('ST_ShortestLine', types.Geometry, 370 '''Returns the 2D shortest line between two geometries'''), 371 ('ST_3DShortestLine', types.Geometry, 372 '''Returns the 3D shortest line between two geometries'''), 373 ('ST_Buffer', types.Geometry, 374 '''(T) Returns a geometry covering all points within a given distance from the input geometry.'''), 375 ('ST_BuildArea', types.Geometry, 376 '''Creates an areal geometry formed by the constituent linework of given geometry'''), 377 ('ST_Centroid', types.Geometry, 378 '''Returns the geometric center of a geometry.'''), 379 ('ST_ClipByBox2D', types.Geometry, 380 '''Returns the portion of a geometry falling within a rectangle.'''), 381 ('ST_ConcaveHull', types.Geometry, 382 '''The concave hull of a geometry represents a possibly concave geometry that encloses all geometries within the set. You can think of it as shrink wrapping.'''), 383 ('ST_ConvexHull', types.Geometry, 384 '''[geometry] Computes the convex hull of a geometry.\nOR\n[raster] 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.'''), 385 ('ST_CurveToLine', types.Geometry, 386 '''Converts a CIRCULARSTRING/CURVEPOLYGON/MULTISURFACE to a LINESTRING/POLYGON/MULTIPOLYGON'''), 387 ('ST_DelaunayTriangles', types.Geometry, 388 '''Return a Delaunay triangulation around the given input points.'''), 389 ('ST_Difference', types.Geometry, 390 '''Returns a geometry that represents that part of geometry A that does not intersect with geometry B.'''), 391 ('ST_FlipCoordinates', types.Geometry, 392 '''Returns a version of the given geometry with X and Y axis flipped. Useful for people who have built latitude/longitude features and need to fix them.'''), 393 ('ST_GeneratePoints', types.Geometry, 394 '''Converts a polygon or multi-polygon into a multi-point composed of randomly location points within the original areas.'''), 395 ('ST_GeometricMedian', types.Geometry, 396 '''Returns the geometric median of a MultiPoint.'''), 397 ('ST_Intersection', types.Geometry, 398 '''[geometry] (T) Returns a geometry that represents the shared portion of geomA and geomB.\nOR\n[raster] 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.'''), 399 ('ST_LineToCurve', types.Geometry, 400 '''Converts a LINESTRING/POLYGON to a CIRCULARSTRING, CURVEPOLYGON'''), 401 ('ST_MakeValid', types.Geometry, 402 '''Attempts to make an invalid geometry valid without losing vertices.'''), 403 ('ST_MemUnion', types.Geometry, 404 '''Same as ST_Union, only memory-friendly (uses less memory and more processor time).'''), 405 ('ST_MinimumBoundingCircle', types.Geometry, 406 '''Returns the smallest circle polygon that can fully contain a geometry. Default uses 48 segments per quarter circle.'''), 407 ('ST_MinimumBoundingRadius', None, 408 '''Returns the center point and radius of the smallest circle that can fully contain a geometry.'''), 409 ('ST_OrientedEnvelope', types.Geometry, 410 '''Returns a minimum rotated rectangle enclosing a geometry.'''), 411 ('ST_Polygonize', types.Geometry, 412 '''Aggregate. Creates a GeometryCollection containing possible polygons formed from the constituent linework of a set of geometries.'''), 413 ('ST_Node', types.Geometry, 414 '''Node a set of linestrings.'''), 415 ('ST_OffsetCurve', types.Geometry, 416 '''Return an offset line at a given distance and side from an input line. Useful for computing parallel lines about a center line'''), 417 ('ST_PointOnSurface', types.Geometry, 418 '''Returns a POINT guaranteed to lie on the surface.'''), 419 ('ST_RemoveRepeatedPoints', types.Geometry, 420 '''Returns a version of the given geometry with duplicated points removed.'''), 421 ('ST_SharedPaths', types.Geometry, 422 '''Returns a collection containing paths shared by the two input linestrings/multilinestrings.'''), 423 ('ST_ShiftLongitude', types.Geometry, 424 ('''Toggle geometry coordinates between -180..180 and 0..360 ranges.''', 'ST_Shift_Longitude')), 425 ('ST_WrapX', types.Geometry, 426 '''Wrap a geometry around an X value.'''), 427 ('ST_Simplify', types.Geometry, 428 '''Returns a \"simplified\" version of the given geometry using the Douglas-Peucker algorithm.'''), 429 ('ST_SimplifyPreserveTopology', types.Geometry, 430 '''Returns a \"simplified\" version of the given geometry using the Douglas-Peucker algorithm. Will avoid creating derived geometries (polygons in particular) that are invalid.'''), 431 ('ST_SimplifyVW', types.Geometry, 432 '''Returns a \"simplified\" version of the given geometry using the Visvalingam-Whyatt algorithm'''), 433 ('ST_ChaikinSmoothing', types.Geometry, 434 '''Returns a \"smoothed\" version of the given geometry using the Chaikin algorithm'''), 435 ('ST_FilterByM', types.Geometry, 436 '''Filters vertex points based on their m-value'''), 437 ('ST_SetEffectiveArea', types.Geometry, 438 '''Sets the effective area for each vertex, storing the value in the M ordinate. A simplified geometry can then be generated by filtering on the M ordinate.'''), 439 ('ST_Split', types.Geometry, 440 '''Returns a collection of geometries resulting by splitting a geometry.'''), 441 ('ST_SymDifference', types.Geometry, 442 '''Returns a geometry that represents the portions of A and B that do not intersect. It is called a symmetric difference because ST_SymDifference(A,B) = ST_SymDifference(B,A).'''), 443 ('ST_Subdivide', types.Geometry, 444 '''Returns a set of geometry where no geometry in the set has more than the specified number of vertices.'''), 445 ('ST_Union', types.Geometry, 446 '''[geometry] Returns a geometry that represents the point set union of the Geometries.\nOR\n[raster] Returns the union of a set of raster tiles into a single raster composed of 1 or more bands.'''), 447 ('ST_UnaryUnion', types.Geometry, 448 '''Like ST_Union, but working at the geometry component level.'''), 449 ('ST_VoronoiLines', types.Geometry, 450 '''Returns the boundaries between the cells of the Voronoi diagram constructed from the vertices of a geometry.'''), 451 ('ST_VoronoiPolygons', types.Geometry, 452 '''Returns the cells of the Voronoi diagram constructed from the vertices of a geometry.'''), 453 ('ST_Affine', types.Geometry, 454 '''Apply a 3D affine transformation to a geometry.'''), 455 ('ST_Rotate', types.Geometry, 456 '''Rotates a geometry about an origin point.'''), 457 ('ST_RotateX', types.Geometry, 458 '''Rotates a geometry about the X axis.'''), 459 ('ST_RotateY', types.Geometry, 460 '''Rotates a geometry about the Y axis.'''), 461 ('ST_RotateZ', types.Geometry, 462 '''Rotates a geometry about the Z axis.'''), 463 ('ST_Scale', types.Geometry, 464 '''Scales a geometry by given factors.'''), 465 ('ST_Translate', types.Geometry, 466 '''Translates a geometry by given offsets.'''), 467 ('ST_TransScale', types.Geometry, 468 '''Translates and scales a geometry by given offsets and factors.'''), 469 ('ST_ClusterDBSCAN', None, 470 '''Window function that returns a cluster id for each input geometry using the DBSCAN algorithm.'''), 471 ('ST_ClusterIntersecting', types.Geometry, 472 '''Aggregate function that clusters the input geometries into connected sets.'''), 473 ('ST_ClusterKMeans', None, 474 '''Window function that returns a cluster id for each input geometry using the K-means algorithm.'''), 475 ('ST_ClusterWithin', types.Geometry, 476 '''Aggregate function that clusters the input geometries by separation distance.'''), 477 ('Box2D', types.Geometry, 478 ('''Returns a BOX2D representing the 2D extent of the geometry.''', 'Box2D_type')), 479 ('Box3D', types.Geometry, 480 ('''[geometry] Returns a BOX3D representing the 3D extent of the geometry.\nOR\n[raster] Returns the box 3d representation of the enclosing box of the raster.''', 'Box3D_type')), 481 ('ST_EstimatedExtent', types.Geometry, 482 '''Return the 'estimated' extent of a spatial table.'''), 483 ('ST_Expand', types.Geometry, 484 '''Returns a bounding box expanded from another bounding box or a geometry.'''), 485 ('ST_Extent', types.Geometry, 486 '''an aggregate function that returns the bounding box that bounds rows of geometries.'''), 487 ('ST_3DExtent', types.Geometry, 488 '''an aggregate function that returns the 3D bounding box that bounds rows of geometries.'''), 489 ('ST_MakeBox2D', types.Geometry, 490 '''Creates a BOX2D defined by two 2D point geometries.'''), 491 ('ST_3DMakeBox', types.Geometry, 492 '''Creates a BOX3D defined by two 3D point geometries.'''), 493 ('ST_XMax', None, 494 '''Returns the X maxima of a 2D or 3D bounding box or a geometry.'''), 495 ('ST_XMin', None, 496 '''Returns the X minima of a 2D or 3D bounding box or a geometry.'''), 497 ('ST_YMax', None, 498 '''Returns the Y maxima of a 2D or 3D bounding box or a geometry.'''), 499 ('ST_YMin', None, 500 '''Returns the Y minima of a 2D or 3D bounding box or a geometry.'''), 501 ('ST_ZMax', None, 502 '''Returns the Z maxima of a 2D or 3D bounding box or a geometry.'''), 503 ('ST_ZMin', None, 504 '''Returns the Z minima of a 2D or 3D bounding box or a geometry.'''), 505 ('ST_LineInterpolatePoint', types.Geometry, 506 '''Returns a point interpolated along a line. Second argument is a float8 between 0 and 1 representing fraction of total length of linestring the point has to be located.'''), 507 ('ST_3DLineInterpolatePoint', types.Geometry, 508 '''Returns a point interpolated along a line in 3D. Second argument is a float8 between 0 and 1 representing fraction of total length of linestring the point has to be located.'''), 509 ('ST_LineInterpolatePoints', types.Geometry, 510 '''Returns one or more points interpolated along a line.'''), 511 ('ST_LineLocatePoint', None, 512 '''Returns a float between 0 and 1 representing the location of the closest point on LineString to the given Point, as a fraction of total 2d line length.'''), 513 ('ST_LineSubstring', types.Geometry, 514 '''Return a linestring being a substring of the input one starting and ending at the given fractions of total 2d length. Second and third arguments are float8 values between 0 and 1.'''), 515 ('ST_LocateAlong', types.Geometry, 516 '''Return a derived geometry collection value with elements that match the specified measure. Polygonal elements are not supported.'''), 517 ('ST_LocateBetween', types.Geometry, 518 '''Return a derived geometry collection value with elements that match the specified range of measures inclusively.'''), 519 ('ST_LocateBetweenElevations', types.Geometry, 520 '''Return a derived geometry (collection) value with elements that intersect the specified range of elevations inclusively.'''), 521 ('ST_InterpolatePoint', None, 522 '''Return the value of the measure dimension of a geometry at the point closed to the provided point.'''), 523 ('ST_AddMeasure', types.Geometry, 524 '''Return a derived geometry with measure elements linearly interpolated between the start and end points.'''), 525 ('ST_IsValidTrajectory', None, 526 '''Returns true if the geometry is a valid trajectory.'''), 527 ('ST_ClosestPointOfApproach', None, 528 '''Returns the measure at which points interpolated along two trajectories are closest.'''), 529 ('ST_DistanceCPA', None, 530 '''Returns the distance between the closest point of approach of two trajectories.'''), 531 ('ST_CPAWithin', None, 532 '''Returns true if the closest point of approach of two trajectories is within the specified distance.'''), 533 ('postgis_sfcgal_version', None, 534 '''Returns the version of SFCGAL in use'''), 535 ('ST_Extrude', types.Geometry, 536 '''Extrude a surface to a related volume'''), 537 ('ST_StraightSkeleton', types.Geometry, 538 '''Compute a straight skeleton from a geometry'''), 539 ('ST_ApproximateMedialAxis', types.Geometry, 540 '''Compute the approximate medial axis of an areal geometry.'''), 541 ('ST_IsPlanar', None, 542 '''Check if a surface is or not planar'''), 543 ('ST_Orientation', None, 544 '''Determine surface orientation'''), 545 ('ST_ForceLHR', types.Geometry, 546 '''Force LHR orientation'''), 547 ('ST_MinkowskiSum', types.Geometry, 548 '''Performs Minkowski sum'''), 549 ('ST_ConstrainedDelaunayTriangles', types.Geometry, 550 '''Return a constrained Delaunay triangulation around the given input geometry.'''), 551 ('ST_3DIntersection', types.Geometry, 552 '''Perform 3D intersection'''), 553 ('ST_3DDifference', types.Geometry, 554 '''Perform 3D difference'''), 555 ('ST_3DUnion', types.Geometry, 556 '''Perform 3D union'''), 557 ('ST_3DArea', None, 558 '''Computes area of 3D surface geometries. Will return 0 for solids.'''), 559 ('ST_Tesselate', types.Geometry, 560 '''Perform surface Tesselation of a polygon or polyhedralsurface and returns as a TIN or collection of TINS'''), 561 ('ST_Volume', None, 562 '''Computes the volume of a 3D solid. If applied to surface (even closed) geometries will return 0.'''), 563 ('ST_MakeSolid', types.Geometry, 564 '''Cast the geometry into a solid. No check is performed. To obtain a valid solid, the input geometry must be a closed Polyhedral Surface or a closed TIN.'''), 565 ('ST_IsSolid', None, 566 '''Test if the geometry is a solid. No validity check is performed.'''), 567 ('AddAuth', None, 568 '''Adds an authorization token to be used in the current transaction.'''), 569 ('CheckAuth', None, 570 '''Creates a trigger on a table to prevent/allow updates and deletes of rows based on authorization token.'''), 571 ('DisableLongTransactions', None, 572 '''Disables long transaction support.'''), 573 ('EnableLongTransactions', None, 574 '''Enables long transaction support.'''), 575 ('LockRow', None, 576 '''Sets lock/authorization for a row in a table.'''), 577 ('UnlockRows', None, 578 '''Removes all locks held by an authorization token.'''), 579 ('PostGIS_Extensions_Upgrade', None, 580 '''Packages and upgrades postgis extensions (e.g. postgis_raster, postgis_topology, postgis_sfcgal) to latest available version.'''), 581 ('PostGIS_Full_Version', None, 582 '''Reports full postgis version and build configuration infos.'''), 583 ('PostGIS_GEOS_Version', None, 584 '''Returns the version number of the GEOS library.'''), 585 ('PostGIS_Liblwgeom_Version', None, 586 '''Returns the version number of the liblwgeom library. This should match the version of PostGIS.'''), 587 ('PostGIS_LibXML_Version', None, 588 '''Returns the version number of the libxml2 library.'''), 589 ('PostGIS_Lib_Build_Date', None, 590 '''Returns build date of the PostGIS library.'''), 591 ('PostGIS_Lib_Version', None, 592 '''Returns the version number of the PostGIS library.'''), 593 ('PostGIS_PROJ_Version', None, 594 '''Returns the version number of the PROJ4 library.'''), 595 ('PostGIS_Wagyu_Version', None, 596 '''Returns the version number of the internal Wagyu library.'''), 597 ('PostGIS_Scripts_Build_Date', None, 598 '''Returns build date of the PostGIS scripts.'''), 599 ('PostGIS_Scripts_Installed', None, 600 '''Returns version of the postgis scripts installed in this database.'''), 601 ('PostGIS_Scripts_Released', None, 602 '''Returns the version number of the postgis.sql script released with the installed postgis lib.'''), 603 ('PostGIS_Version', None, 604 '''Returns PostGIS version number and compile-time options.'''), 605 ('postgis.backend', None, 606 ('''The backend to service a function where GEOS and SFCGAL overlap. Options: geos or sfcgal. Defaults to geos.''', 'postgis_backend')), 607 ('postgis.gdal_datapath', None, 608 ('''A configuration option to assign the value of GDAL's GDAL_DATA option. If not set, the environmentally set GDAL_DATA variable is used.''', 'postgis_gdal_datapath')), 609 ('postgis.gdal_enabled_drivers', None, 610 ('''A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP.''', 'postgis_gdal_enabled_drivers')), 611 ('postgis.enable_outdb_rasters', None, 612 ('''A boolean configuration option to enable access to out-db raster bands.''', 'postgis_enable_outdb_rasters')), 613 ('PostGIS_AddBBox', types.Geometry, 614 '''Add bounding box to the geometry.'''), 615 ('PostGIS_DropBBox', types.Geometry, 616 '''Drop the bounding box cache from the geometry.'''), 617 ('PostGIS_HasBBox', None, 618 '''Returns TRUE if the bbox of this geometry is cached, FALSE otherwise.'''), 619 ('ST_AddBand', types.Raster, 620 ('''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.''', 'RT_ST_AddBand')), 621 ('ST_AsRaster', types.Raster, 622 ('''Converts a PostGIS geometry to a PostGIS raster.''', 'RT_ST_AsRaster')), 623 ('ST_Band', types.Raster, 624 ('''Returns one or more bands of an existing raster as a new raster. Useful for building new rasters from existing rasters.''', 'RT_ST_Band')), 625 ('ST_MakeEmptyCoverage', types.Raster, 626 ('''Cover georeferenced area with a grid of empty raster tiles.''', 'RT_ST_MakeEmptyCoverage')), 627 ('ST_MakeEmptyRaster', types.Raster, 628 ('''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).''', 'RT_ST_MakeEmptyRaster')), 629 ('ST_Tile', types.Raster, 630 ('''Returns a set of rasters resulting from the split of the input raster based upon the desired dimensions of the output rasters.''', 'RT_ST_Tile')), 631 ('ST_Retile', types.Raster, 632 ('''Return a set of configured tiles from an arbitrarily tiled raster coverage.''', 'RT_ST_Retile')), 633 ('ST_FromGDALRaster', types.Raster, 634 ('''Returns a raster from a supported GDAL raster file.''', 'RT_ST_FromGDALRaster')), 635 ('ST_GeoReference', None, 636 ('''Returns the georeference meta data in GDAL or ESRI format as commonly seen in a world file. Default is GDAL.''', 'RT_ST_GeoReference')), 637 ('ST_Height', None, 638 ('''Returns the height of the raster in pixels.''', 'RT_ST_Height')), 639 ('ST_MetaData', None, 640 ('''Returns basic meta data about a raster object such as pixel size, rotation (skew), upper, lower left, etc.''', 'RT_ST_MetaData')), 641 ('ST_NumBands', None, 642 ('''Returns the number of bands in the raster object.''', 'RT_ST_NumBands')), 643 ('ST_PixelHeight', None, 644 ('''Returns the pixel height in geometric units of the spatial reference system.''', 'RT_ST_PixelHeight')), 645 ('ST_PixelWidth', None, 646 ('''Returns the pixel width in geometric units of the spatial reference system.''', 'RT_ST_PixelWidth')), 647 ('ST_ScaleX', None, 648 ('''Returns the X component of the pixel width in units of coordinate reference system.''', 'RT_ST_ScaleX')), 649 ('ST_ScaleY', None, 650 ('''Returns the Y component of the pixel height in units of coordinate reference system.''', 'RT_ST_ScaleY')), 651 ('ST_RasterToWorldCoord', None, 652 ('''Returns the raster's upper left corner as geometric X and Y (longitude and latitude) given a column and row. Column and row starts at 1.''', 'RT_ST_RasterToWorldCoord')), 653 ('ST_RasterToWorldCoordX', None, 654 ('''Returns the geometric X coordinate upper left of a raster, column and row. Numbering of columns and rows starts at 1.''', 'RT_ST_RasterToWorldCoordX')), 655 ('ST_RasterToWorldCoordY', None, 656 ('''Returns the geometric Y coordinate upper left corner of a raster, column and row. Numbering of columns and rows starts at 1.''', 'RT_ST_RasterToWorldCoordY')), 657 ('ST_Rotation', None, 658 ('''Returns the rotation of the raster in radian.''', 'RT_ST_Rotation')), 659 ('ST_SkewX', None, 660 ('''Returns the georeference X skew (or rotation parameter).''', 'RT_ST_SkewX')), 661 ('ST_SkewY', None, 662 ('''Returns the georeference Y skew (or rotation parameter).''', 'RT_ST_SkewY')), 663 ('ST_UpperLeftX', None, 664 ('''Returns the upper left X coordinate of raster in projected spatial ref.''', 'RT_ST_UpperLeftX')), 665 ('ST_UpperLeftY', None, 666 ('''Returns the upper left Y coordinate of raster in projected spatial ref.''', 'RT_ST_UpperLeftY')), 667 ('ST_Width', None, 668 ('''Returns the width of the raster in pixels.''', 'RT_ST_Width')), 669 ('ST_WorldToRasterCoord', None, 670 ('''Returns the upper left corner as column and row given geometric X and Y (longitude and latitude) or a point geometry expressed in the spatial reference coordinate system of the raster.''', 'RT_ST_WorldToRasterCoord')), 671 ('ST_WorldToRasterCoordX', None, 672 ('''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.''', 'RT_ST_WorldToRasterCoordX')), 673 ('ST_WorldToRasterCoordY', None, 674 ('''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.''', 'RT_ST_WorldToRasterCoordY')), 675 ('ST_BandMetaData', None, 676 ('''Returns basic meta data for a specific raster band. band num 1 is assumed if none-specified.''', 'RT_ST_BandMetaData')), 677 ('ST_BandNoDataValue', None, 678 ('''Returns the value in a given band that represents no data. If no band num 1 is assumed.''', 'RT_ST_BandNoDataValue')), 679 ('ST_BandIsNoData', None, 680 ('''Returns true if the band is filled with only nodata values.''', 'RT_ST_BandIsNoData')), 681 ('ST_BandPath', None, 682 ('''Returns system file path to a band stored in file system. If no bandnum specified, 1 is assumed.''', 'RT_ST_BandPath')), 683 ('ST_BandFileSize', None, 684 ('''Returns the file size of a band stored in file system. If no bandnum specified, 1 is assumed.''', 'RT_ST_BandFileSize')), 685 ('ST_BandFileTimestamp', None, 686 ('''Returns the file timestamp of a band stored in file system. If no bandnum specified, 1 is assumed.''', 'RT_ST_BandFileTimestamp')), 687 ('ST_BandPixelType', None, 688 ('''Returns the type of pixel for given band. If no bandnum specified, 1 is assumed.''', 'RT_ST_BandPixelType')), 689 ('ST_MinPossibleValue', None, 690 '''Returns the minimum value this pixeltype can store.'''), 691 ('ST_HasNoBand', None, 692 ('''Returns true if there is no band with given band number. If no band number is specified, then band number 1 is assumed.''', 'RT_ST_HasNoBand')), 693 ('ST_PixelAsPolygon', types.Geometry, 694 ('''Returns the polygon geometry that bounds the pixel for a particular row and column.''', 'RT_ST_PixelAsPolygon')), 695 ('ST_PixelAsPolygons', None, 696 ('''Returns the polygon geometry that bounds every pixel of a raster band along with the value, the X and the Y raster coordinates of each pixel.''', 'RT_ST_PixelAsPolygons')), 697 ('ST_PixelAsPoint', types.Geometry, 698 ('''Returns a point geometry of the pixel's upper-left corner.''', 'RT_ST_PixelAsPoint')), 699 ('ST_PixelAsPoints', None, 700 ('''Returns a point geometry for each pixel of a raster band along with the value, the X and the Y raster coordinates of each pixel. The coordinates of the point geometry are of the pixel's upper-left corner.''', 'RT_ST_PixelAsPoints')), 701 ('ST_PixelAsCentroid', types.Geometry, 702 ('''Returns the centroid (point geometry) of the area represented by a pixel.''', 'RT_ST_PixelAsCentroid')), 703 ('ST_PixelAsCentroids', None, 704 ('''Returns the centroid (point geometry) for each pixel of a raster band along with the value, the X and the Y raster coordinates of each pixel. The point geometry is the centroid of the area represented by a pixel.''', 'RT_ST_PixelAsCentroids')), 705 ('ST_Value', None, 706 ('''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.''', 'RT_ST_Value')), 707 ('ST_NearestValue', None, 708 ('''Returns the nearest non-NODATA value of a given band's pixel specified by a columnx and rowy or a geometric point expressed in the same spatial reference coordinate system as the raster.''', 'RT_ST_NearestValue')), 709 ('ST_Neighborhood', None, 710 ('''Returns a 2-D double precision array of the non-NODATA values around a given band's pixel specified by either a columnX and rowY or a geometric point expressed in the same spatial reference coordinate system as the raster.''', 'RT_ST_Neighborhood')), 711 ('ST_SetValue', types.Raster, 712 ('''Returns modified raster resulting from setting the value of a given band in a given columnx, rowy pixel or the pixels that intersect a particular geometry. Band numbers start at 1 and assumed to be 1 if not specified.''', 'RT_ST_SetValue')), 713 ('ST_SetValues', types.Raster, 714 ('''Returns modified raster resulting from setting the values of a given band.''', 'RT_ST_SetValues')), 715 ('ST_DumpValues', None, 716 ('''Get the values of the specified band as a 2-dimension array.''', 'RT_ST_DumpValues')), 717 ('ST_PixelOfValue', None, 718 ('''Get the columnx, rowy coordinates of the pixel whose value equals the search value.''', 'RT_ST_PixelOfValue')), 719 ('ST_SetGeoReference', types.Raster, 720 ('''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.''', 'RT_ST_SetGeoReference')), 721 ('ST_SetRotation', types.Raster, 722 ('''Set the rotation of the raster in radian.''', 'RT_ST_SetRotation')), 723 ('ST_SetScale', types.Raster, 724 ('''Sets the X and Y size of pixels in units of coordinate reference system. Number units/pixel width/height.''', 'RT_ST_SetScale')), 725 ('ST_SetSkew', types.Raster, 726 ('''Sets the georeference X and Y skew (or rotation parameter). If only one is passed in, sets X and Y to the same value.''', 'RT_ST_SetSkew')), 727 ('ST_SetUpperLeft', types.Raster, 728 ('''Sets the value of the upper left corner of the pixel of the raster to projected X and Y coordinates.''', 'RT_ST_SetUpperLeft')), 729 ('ST_Resample', types.Raster, 730 ('''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.''', 'RT_ST_Resample')), 731 ('ST_Rescale', types.Raster, 732 ('''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.''', 'RT_ST_Rescale')), 733 ('ST_Reskew', types.Raster, 734 ('''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.''', 'RT_ST_Reskew')), 735 ('ST_Resize', types.Raster, 736 ('''Resize a raster to a new width/height''', 'RT_ST_Resize')), 737 ('ST_SetBandNoDataValue', types.Raster, 738 ('''Sets the value for the given band that represents no data. Band 1 is assumed if no band is specified. To mark a band as having no nodata value, set the nodata value = NULL.''', 'RT_ST_SetBandNoDataValue')), 739 ('ST_SetBandIsNoData', types.Raster, 740 ('''Sets the isnodata flag of the band to TRUE.''', 'RT_ST_SetBandIsNoData')), 741 ('ST_SetBandPath', types.Raster, 742 ('''Update the external path and band number of an out-db band''', 'RT_ST_SetBandPath')), 743 ('ST_SetBandIndex', types.Raster, 744 ('''Update the external band number of an out-db band''', 'RT_ST_SetBandIndex')), 745 ('ST_Count', None, 746 ('''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.''', 'RT_ST_Count')), 747 ('ST_CountAgg', None, 748 ('''Aggregate. Returns the number of pixels in a given band of a set of rasters. 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.''', 'RT_ST_CountAgg')), 749 ('ST_Histogram', None, 750 ('''Returns a set of record summarizing a raster or raster coverage data distribution separate bin ranges. Number of bins are autocomputed if not specified.''', 'RT_ST_Histogram')), 751 ('ST_Quantile', None, 752 ('''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.''', 'RT_ST_Quantile')), 753 ('ST_SummaryStats', None, 754 ('''Returns summarystats 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.''', 'RT_ST_SummaryStats')), 755 ('ST_SummaryStatsAgg', None, 756 ('''Aggregate. Returns summarystats consisting of count, sum, mean, stddev, min, max for a given raster band of a set of raster. Band 1 is assumed is no band is specified.''', 'RT_ST_SummaryStatsAgg')), 757 ('ST_ValueCount', None, 758 ('''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.''', 'RT_ST_ValueCount')), 759 ('ST_RastFromWKB', types.Raster, 760 ('''Return a raster value from a Well-Known Binary (WKB) raster.''', 'RT_ST_RastFromWKB')), 761 ('ST_RastFromHexWKB', types.Raster, 762 ('''Return a raster value from a Hex representation of Well-Known Binary (WKB) raster.''', 'RT_ST_RastFromHexWKB')), 763 ('ST_AsBinary/ST_AsWKB', None, 764 ('''Return the Well-Known Binary (WKB) representation of the raster.''', 'RT_ST_AsBinary')), 765 ('ST_AsHexWKB', None, 766 ('''Return the Well-Known Binary (WKB) in Hex representation of the raster.''', 'RT_ST_AsHexWKB')), 767 ('ST_AsGDALRaster', None, 768 ('''Return the raster tile in the designated GDAL Raster format. Raster formats are one of those supported by your compiled library. Use ST_GDALDrivers() to get a list of formats supported by your library.''', 'RT_ST_AsGDALRaster')), 769 ('ST_AsJPEG', None, 770 ('''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.''', 'RT_ST_AsJPEG')), 771 ('ST_AsPNG', None, 772 ('''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.''', 'RT_ST_AsPNG')), 773 ('ST_AsTIFF', None, 774 ('''Return the raster selected bands as a single TIFF image (byte array). If no band is specified or any of specified bands does not exist in the raster, then will try to use all bands.''', 'RT_ST_AsTIFF')), 775 ('ST_Clip', types.Raster, 776 ('''Returns the raster clipped by the input geometry. If band number not is specified, all bands are processed. If crop is not specified or TRUE, the output raster is cropped.''', 'RT_ST_Clip')), 777 ('ST_ColorMap', types.Raster, 778 ('''Creates a new raster of up to four 8BUI bands (grayscale, RGB, RGBA) from the source raster and a specified band. Band 1 is assumed if not specified.''', 'RT_ST_ColorMap')), 779 ('ST_Grayscale', types.Raster, 780 ('''Creates a new one-8BUI band raster from the source raster and specified bands representing Red, Green and Blue''', 'RT_ST_Grayscale')), 781 ('ST_MapAlgebra', None, 782 ('''[raster] Callback function version - Returns a one-band raster given one or more input rasters, band indexes and one user-specified callback function.\nOR\n[raster] Expression version - Returns a one-band raster given one or two input rasters, band indexes and one or more user-specified SQL expressions.''', 'RT_ST_MapAlgebra')), 783 ('ST_MapAlgebraExpr', types.Raster, 784 ('''[raster] 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.\nOR\n[raster] 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.''', 'RT_ST_MapAlgebraExpr')), 785 ('ST_MapAlgebraFct', types.Raster, 786 ('''[raster] 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.\nOR\n[raster] 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.''', 'RT_ST_MapAlgebraFct')), 787 ('ST_MapAlgebraFctNgb', types.Raster, 788 ('''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.''', 'RT_ST_MapAlgebraFctNgb')), 789 ('ST_Reclass', types.Raster, 790 ('''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.''', 'RT_ST_Reclass')), 791 ('ST_Distinct4ma', None, 792 ('''Raster processing function that calculates the number of unique pixel values in a neighborhood.''', 'RT_ST_Distinct4ma')), 793 ('ST_InvDistWeight4ma', None, 794 ('''Raster processing function that interpolates a pixel's value from the pixel's neighborhood.''', 'RT_ST_InvDistWeight4ma')), 795 ('ST_Max4ma', None, 796 ('''Raster processing function that calculates the maximum pixel value in a neighborhood.''', 'RT_ST_Max4ma')), 797 ('ST_Mean4ma', None, 798 ('''Raster processing function that calculates the mean pixel value in a neighborhood.''', 'RT_ST_Mean4ma')), 799 ('ST_Min4ma', None, 800 ('''Raster processing function that calculates the minimum pixel value in a neighborhood.''', 'RT_ST_Min4ma')), 801 ('ST_MinDist4ma', None, 802 ('''Raster processing function that returns the minimum distance (in number of pixels) between the pixel of interest and a neighboring pixel with value.''', 'RT_ST_MinDist4ma')), 803 ('ST_Range4ma', None, 804 ('''Raster processing function that calculates the range of pixel values in a neighborhood.''', 'RT_ST_Range4ma')), 805 ('ST_StdDev4ma', None, 806 ('''Raster processing function that calculates the standard deviation of pixel values in a neighborhood.''', 'RT_ST_StdDev4ma')), 807 ('ST_Sum4ma', None, 808 ('''Raster processing function that calculates the sum of all pixel values in a neighborhood.''', 'RT_ST_Sum4ma')), 809 ('ST_Aspect', types.Raster, 810 ('''Returns the aspect (in degrees by default) of an elevation raster band. Useful for analyzing terrain.''', 'RT_ST_Aspect')), 811 ('ST_HillShade', types.Raster, 812 ('''Returns the hypothetical illumination of an elevation raster band using provided azimuth, altitude, brightness and scale inputs.''', 'RT_ST_HillShade')), 813 ('ST_Roughness', types.Raster, 814 ('''Returns a raster with the calculated \"roughness\" of a DEM.''', 'RT_ST_Roughness')), 815 ('ST_Slope', types.Raster, 816 ('''Returns the slope (in degrees by default) of an elevation raster band. Useful for analyzing terrain.''', 'RT_ST_Slope')), 817 ('ST_TPI', types.Raster, 818 ('''Returns a raster with the calculated Topographic Position Index.''', 'RT_ST_TPI')), 819 ('ST_TRI', types.Raster, 820 ('''Returns a raster with the calculated Terrain Ruggedness Index.''', 'RT_ST_TRI')), 821 ('ST_DumpAsPolygons', None, 822 ('''Returns a set of geomval (geom,val) rows, from a given raster band. If no band number is specified, band num defaults to 1.''', 'RT_ST_DumpAsPolygons')), 823 ('ST_MinConvexHull', types.Geometry, 824 ('''Return the convex hull geometry of the raster excluding NODATA pixels.''', 'RT_ST_MinConvexHull')), 825 ('ST_SameAlignment', None, 826 ('''Returns true if rasters have same skew, scale, spatial ref, and offset (pixels can be put on same grid without cutting into pixels) and false if they don't with notice detailing issue.''', 'RT_ST_SameAlignment')), 827 ('ST_NotSameAlignmentReason', None, 828 ('''Returns text stating if rasters are aligned and if not aligned, a reason why.''', 'RT_ST_NotSameAlignmentReason')), 829 ('ST_Distance_Sphere', None, 830 '''Returns minimum distance in meters between two lon/lat geometries. Uses a spherical earth and radius of 6370986 meters. Faster than ``ST_Distance_Spheroid``, but less accurate. PostGIS versions prior to 1.5 only implemented for points.'''), 831] 832