Skip to content

Latest commit

 

History

History
137 lines (90 loc) · 2.96 KB

Uber-Api-Hierarchical-Grid.md

File metadata and controls

137 lines (90 loc) · 2.96 KB

Hierarchical Grid Functions

These functions permit moving between resolutions in the H3 grid system. The functions produce parent (coarser) or children (finer) cells.

H3ToParent

H3Lib.H3Index Api.H3ToParent(H3Index h, int parentRes)

H3ToParent Summary

Returns the parent (coarser) index containing h.

H3ToParent Parameters

Name Type Description
h H3Lib.3Index Cell to find the parent of
parentRes int coarser resolution

H3ToChildren

void Api.H3ToChildren(H3Index h, int childRes, out List<H3Index> outChildren)

H3ToChildren Summary

Populates children with the indexes contained by h at resolution childRes. children must be an array of at least size maxH3ToChildrenSize(h, childRes).

H3ToChildren Parameters

Name Type Description
h H3Lib.H3Index Cell to find children of
childRes int finer resolution
outChildren out List<H3Lib.H3Index> child cells

MaxH3ToChildrenSize

long Api.MaxH3ToChildrenSize(H3Index h, int childRes)

MaxH3ToChildrenSize Summary

Returns the size of the array needed by h3ToChildren for these inputs.

MaxH3ToChildrenSize Parameters

Name Type Description
h H3Lib.H3Index Cell to find children of
childRes int Resolution of children

H3ToCenterChild

H3Lib.H3Index Api.H3ToCenterChild(H3Index h, int childRes)

H3ToCenterChild Summary

Returns the center child (finer) index contained by h at resolution childRes.

H3ToCenterChild Parameters

Name Type Description
h H3Lib.H3Index Cell to find center child of
childRes int finer resolution

Compact

int Api.Compact(List<H3Index> h3Set, out List<H3Index> outCompacted)

Compact Summary

Compacts the set h3Set of indexes as best as possible, into the List outCompacted.

Returns 0 on success.

Compact Parameters

Name Type Description
h3Set List<H3Lib.H3Index> Cells to compact
outCompacted out List<H3Lib.H3Index> Compacted cells

Uncompact

int Api.Uncompact(List<H3Index> compactedSet, out List<H3Index> outCells, int res)

Uncompact Summary

Uncompacts the set compactedSet of indexes to the resolution res.

Returns 0 on success.

Uncompact Parameters

Name Type Description
compactedSet List<H3Lib.H3Index> Compacted cells
outCells out List<H3Lib.H3Index> Uncompacted cells
res int Resolution to uncompact to

MaxUncompactSize

long Api.MaxUncompactSize(H3Index compacted, int r)

MaxUncompactSize Summary

Returns the size of the array needed by uncompact.

MaxUncompactSize Parameters

Name Type Description
compacted H3Lib.H3Index Cell to uncompact
r int Resolution to uncompact to

Return to Uber API Table of Contents