geo.h3
Working with H3.
Working with H3.
compactclj
(compact cells)Given a set of H3 cells, return a compacted set of cells, at possibly coarser resolutions.
Given a set of H3 cells, return a compacted set of cells, at possibly coarser resolutions.
edge-lengthclj
(edge-length res)(edge-length res unit)Average edge length for indices at resolution 'res.' Optional second argument allows returning length in :m or :km. Defaults to m.
Average edge length for indices at resolution 'res.' Optional second argument allows returning length in :m or :km. Defaults to m.
geo-coordsclj
(geo-coords s)Return all coordinates for a given Shapelike as GeoCoords
Return all coordinates for a given Shapelike as GeoCoords
get-faces-longclj
(get-faces-long h)Long helper to return the icosahedron faces intersected by a cell, represented by integers 0-19.
Long helper to return the icosahedron faces intersected by a cell, represented by integers 0-19.
get-faces-stringclj
(get-faces-string h)String helper to return the icosahedron faces intersected by a cell, represented by integers 0-19.
String helper to return the icosahedron faces intersected by a cell, represented by integers 0-19.
get-pentagon-indexesclj
(get-pentagon-indexes res)Return a collection of all topologically pentagonal cells at the given resolution
Return a collection of all topologically pentagonal cells at the given resolution
get-res-0-indexesclj
(get-res-0-indexes)Return a collection of all base cells
Return a collection of all base cells
get-resolution-longclj
(get-resolution-long h)Long helper to return the resolution of a cell.
Long helper to return the resolution of a cell.
H3Indexcljprotocol
edge-originclj
(edge-origin this)Given a unidirectional edge, get its origin.
Given a unidirectional edge, get its origin.
h3-to-center-childclj
(h3-to-center-child this child-res)Returns the center child at the given resolution.
Returns the center child at the given resolution.
edgesclj
(edges this)Get all edges originating from an index.
Get all edges originating from an index.
edge-boundaryclj
(edge-boundary this)Get coordinates representing the edge.
Get coordinates representing the edge.
h3-lineclj
(h3-line this cell)Return the line of indexes between two cells
Return the line of indexes between two cells
to-longclj
(to-long this)Return index as a long.
Return index as a long.
edgeclj
(edge from to)Given both 'from' and 'to' cells, get a unidirectional edge index.
Given both 'from' and 'to' cells, get a unidirectional edge index.
neighbors?clj
(neighbors? this cell)Check if two indexes are neighbors.
Check if two indexes are neighbors.
h3->ptclj
(h3->pt this)Return a GeoCoord of the center point of a cell.
Return a GeoCoord of the center point of a cell.
to-stringclj
(to-string this)Return index as a string.
Return index as a string.
edge-destinationclj
(edge-destination this)Given a unidirectional edge, get its destination.
Given a unidirectional edge, get its destination.
to-jtsclj
(to-jts this)Given an H3 identifier, return a Polygon of that cell.
Given an H3 identifier, return a Polygon of that cell.
pentagon?clj
(pentagon? this)Check if an index is a pentagon.
Check if an index is a pentagon.
k-ringclj
(k-ring this k)Return a list of neighboring indices in all directions for 'k' rings.
Return a list of neighboring indices in all directions for 'k' rings.
get-facesclj
(get-faces this)Return the icosahedron faces intersected by a cell, represented by integers 0-19.
Return the icosahedron faces intersected by a cell, represented by integers 0-19.
get-resolutionclj
(get-resolution this)Return the resolution of a cell.
Return the resolution of a cell.
h3-distanceclj
(h3-distance this cell)Return the grid distance, which is the distance expressed in number of cells.
Return the grid distance, which is the distance expressed in number of cells.
is-valid?clj
(is-valid? this)Check if an index is valid.
Check if an index is valid.
k-ring-distancesclj
(k-ring-distances this k)Return a list of neighboring indices in all directions for 'k' rings, ordered by distance from the origin index.
Return a list of neighboring indices in all directions for 'k' rings, ordered by distance from the origin index.
hex-areaclj
(hex-area res)(hex-area res unit)Average area for indices at resolution 'res.' Optional second argument allows returning area in :m2 or :km2. Defaults to m2.
Average area for indices at resolution 'res.' Optional second argument allows returning area in :m2 or :km2. Defaults to m2.
multi-polygonclj
(multi-polygon cells)Given a contiguous set of H3 cells, return a JTS MultiPolygon.
Given a contiguous set of H3 cells, return a JTS MultiPolygon.
Polygonalcljprotocol
polyfillclj
(polyfill this res)Return all resolution 'res' cells in Long form that cover a given Shapelike, excluding internal holes. If the set of cells is especially large, the set may return partially compacted.
Return all resolution 'res' cells in Long form that cover a given Shapelike, excluding internal holes. If the set of cells is especially large, the set may return partially compacted.
polyfill-addressclj
(polyfill-address this res)Return all resolution 'res' cells in String form that cover a given Shapelike, excluding internal holes. If the set of cells is especially large, the set may return partially compacted.
Return all resolution 'res' cells in String form that cover a given Shapelike, excluding internal holes. If the set of cells is especially large, the set may return partially compacted.
to-polygonclj
(to-polygon this)(to-polygon this srid)Ensure that an object is 2D, with lineal boundaries.
Ensure that an object is 2D, with lineal boundaries.
pt->h3clj
(pt->h3 pt res)(pt->h3 lat lng res)Return the Long index of the resolution 'res' cell that a point or lat/lng pair is contained within.
Return the Long index of the resolution 'res' cell that a point or lat/lng pair is contained within.
pt->h3-addressclj
(pt->h3-address pt res)(pt->h3-address lat lng res)Return the String index of the resolution 'res' cell that a point or lat/lng pair is contained within.
Return the String index of the resolution 'res' cell that a point or lat/lng pair is contained within.
safe-polyfill-hexagon-maximumclj
Lowering this will reduce the likelihood of H3's polyfill crashing, but will cause this library's polyfill to run more slowly due to more frequent subdivision
Lowering this will reduce the likelihood of H3's polyfill crashing, but will cause this library's polyfill to run more slowly due to more frequent subdivision
safe-uncompact-hexagon-maximumclj
Lowering this will reduce the likelihood of this library's internal safe-uncompact throwing a heap error, but will make this library's polyfill more likely to return an uncompacted set
Lowering this will reduce the likelihood of this library's internal safe-uncompact throwing a heap error, but will make this library's polyfill more likely to return an uncompacted set
uncompactclj
(uncompact cells res)Given a set of H3 cells, return an uncompacted set of cells to a certain resolution.
Given a set of H3 cells, return an uncompacted set of cells to a certain resolution.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close