Analytics Toolbox for Postgres

Analytics Toolbox for Postgres

quadbin

You can learn more about Quadbins in the Overview section of the documentation.

QUADBIN_BBOX

Description

Returns an array with the boundary box of a given Quadbin. This boundary box contains the minimum and maximum longitude and latitude. The output format is [West-South, East-North] or [min long, min lat, max long, max lat].

  • quadbin: BIGINT Quadbin to get the bbox from.

Return type

ARRAY<FLOAT64>

Example

1
2
SELECT carto.QUADBIN_BBOX(5209574053332910079);
-- {22.5,-21.943045533438166,45.0,0.0}

QUADBIN_BOUNDARY

Description

Returns the boundary for a given Quadbin as a polygon GEOMETRY with the same coordinates as given by the QUADBIN_BBOX function.

  • quadbin: BIGINT Quadbin to get the boundary geometry from.

Return type

GEOGRAPHY

Example

1
2
SELECT carto.QUADBIN_BOUNDARY(5209574053332910079);
-- POLYGON((22.5 0, 22.5 -21.943045533438166, 45 -21.943045533438166, 45 0, 22.5 0))

QUADBIN_CENTER

Description

Returns the center for a given Quadbin. The center is the intersection point of the four immediate children Quadbin.

  • quadbin: BIGINT Quadbin to get the center from.

Return type

GEOMETRY

Example

1
2
SELECT carto.QUADBIN_CENTER(5209574053332910079);
-- POINT(33.75 -11.178401873711776)

QUADBIN_FROMGEOGPOINT

Description

Returns the Quadbin of a given point at a given level of detail.

  • point: GEOMETRY point to get the Quadbin from.
  • resolution: BIGINT level of detail or zoom.

Return type

BIGINT

Example

1
2
SELECT carto.QUADBIN_FROMGEOGPOINT(ST_MAKEPOINT(40.4168, -3.7038), 4);
-- 5209574053332910079

QUADBIN_FROMLONGLAT

Description

Returns the Quadbin representation of a point for a given level of detail and geographic coordinates.

  • longitude: DOUBLE PRECISION longitude (WGS84) of the point.
  • latitude: DOUBLE PRECISION latitude (WGS84) of the point.
  • resolution: INT level of detail or zoom.

Return type

BIGINT

Example

1
2
SELECT carto.QUADBIN_FROMLONGLAT(40.4168, -3.7038, 4);
-- 5209574053332910079

QUADBIN_FROMZXY

Description

Returns a Quadbin from z, x, y tile coordinates.

  • z: INT zoom level.
  • x: INT horizontal position of a tile.
  • y: INT vertical position of a tile.

Constraints

Tile coordinates x and y depend on the zoom level z. For both coordinates, the minimum value is 0, and the maximum value is two to the power of z, minus one (2^z - 1).

Return type

BIGINT

Example

1
2
SELECT carto.QUADBIN_FROMZXY(4, 9, 8);
-- 5209574053332910079

QUADBIN_ISVALID

Description

Returns true when the given index is valid, false otherwise.

  • quadbin: BIGINT Quadbin index.

Return type

BOOLEAN

Examples

1
2
SELECT carto.QUADBIN_ISVALID(5209574053332910079);
-- true
1
2
SELECT carto.QUADBIN_ISVALID(1234);
-- false

QUADBIN_KRING

Description

Returns all cell indexes in a filled square k-ring centered at the origin in no particular order.

  • origin: BIGINT Quadbin index of the origin.
  • size: INT size of the ring (distance from the origin).

Return type

BIGINT[]

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
SELECT carto.QUADBIN_KRING(5209574053332910079, 1);
-- { 5208043533147045887
--   5208061125333090303,
--   5208113901891223551,
--   5209556461146865663,
--   5209574053332910079,
--   5209591645518954495,
--   5209609237704998911,
--   5209626829891043327,
--   5209662014263132159 }

QUADBIN_KRING_DISTANCES

Description

Returns all cell indexes and their distances in a filled square k-ring centered at the origin in no particular order.

  • origin: BIGINT Quadbin index of the origin.
  • size: INT size of the ring (distance from the origin).

Return type

JSON[]

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
SELECT carto.QUADBIN_KRING_DISTANCES(5209574053332910079, 1);
-- {{"index": "5208043533147045887", "distance": "1"}
--  {"index": "5209556461146865663", "distance": "1"}
--  {"index": "5209591645518954495", "distance": "1"}
--  {"index": "5208061125333090303", "distance": "1"}
--  {"index": "5209574053332910079", "distance": "0"}
--  {"index": "5209609237704998911", "distance": "1"}
--  {"index": "5208113901891223551", "distance": "1"}
--  {"index": "5209626829891043327", "distance": "1"}
--  {"index": "5209662014263132159", "distance": "1"}}

QUADBIN_POLYFILL

Description

Returns an array of Quadbins that intersect with the given geometry at a given level of detail.

  • geography: GEOMETRY geometry to extract the Quadbins from.
  • resolution: INT level of detail or zoom.

Return type

BIGINT[]

Example

1
2
3
4
5
6
7
8
9
SELECT carto.QUADBIN_POLYFILL(
    ST_GEOMFROMTEXT('POLYGON ((-3.71219873428345 40.413365349070865, -3.7144088745117 40.40965661286395, -3.70659828186035 40.409525904775634, -3.71219873428345 40.413365349070865))'),
    17);
-- { 5265786693153193983,
--   5265786693163941887,
--   5265786693164466175,
--   5265786693164204031,
--   5265786693164728319,
--   5265786693165514751 }

QUADBIN_RESOLUTION

Description

Returns the resolution of the input Quadbin.

  • quadbin: BIGINT Quadbin from which to get the resolution.

Return type

BIGINT

Example

1
2
SELECT carto.QUADBIN_RESOLUTION(5209574053332910079);
-- 4

QUADBIN_SIBLING

Description

Returns the Quadbin directly next to the given Quadbin at the same resolution. The direction must be set in the corresponding argument and currently only horizontal/vertical neigbours are supported. It will return NULL if the sibling does not exist.

  • quadbin: BIGINT Quadbin to get the sibling from.
  • direction: TEXT ‘right’|‘left’|‘up’|‘down’ direction to move in to extract the next sibling.

Return type

BIGINT

Example

1
2
SELECT carto.QUADBIN_SIBLING(5209574053332910079, 'up');
-- 5208061125333090303

QUADBIN_TOCHILDREN

Description

Returns an array with the children Quadbins of a given Quadbin for a specific resolution. A children Quadbin is a Quadbin of higher level of detail that is contained by the current Quadbin. Each Quadbin has four direct children (at the next higher resolution).

  • quadbin: BIGINT Quadbin to get the children from.
  • resolution: INT resolution of the desired children.

Return type

BIGINT[]

Example

1
2
3
4
5
SELECT carto.QUADBIN_TOCHILDREN(5209574053332910079, 5);
-- { 5214064458820747263,
--   5214073254913769471,
--   5214068856867258367,
--   5214077652960280575 }

QUADBIN_TOPARENT

Description

Returns the parent (ancestor) Quadbin of a given Quadbin for a specific resolution. An ancestor of a given Quadbin is a Quadbin of smaller resolution that spatially contains it.

  • quadbin: BIGINT Quadbin to get the parent from.
  • resolution: INT resolution of the desired parent.

Return type

BIGINT

Example

1
2
SELECT carto.QUADBIN_TOPARENT(5209574053332910079, 3);
-- 5205105638077628415

QUADBIN_TOZXY

Description

Returns the zoom level z and coordinates x, y for a given Quadbin.

  • quadbin: BIGINT Quadbin from which to obtain the coordinates.

Return type

JSON

Example

1
2
SELECT carto.QUADBIN_TOZXY(5209574053332910079);
-- {"z" : 4, "x" : 9, "y" : 8}