Skip to content

Latest commit

 

History

History
319 lines (200 loc) · 5.7 KB

Uber-Api-Miscellaneous-H3.md

File metadata and controls

319 lines (200 loc) · 5.7 KB

Miscellaneous H3 Functions

These functions include descriptions of the H3 grid system.

DegsToRads

decimal Api.DegsToRads(decimal degrees)

DegsToRads Summary

Converts degrees to radians.

DegsToRads Parameters

Name Type Description
degrees decimal Degree to change to radians

RadsToDegs

decimal Api.RadsToDegs(decimal radians)

RadsToDegs Summary

Converts radians to degrees.

Parameters

Name Type Description
radians decimal Radians to change to degrees

HexAreaKm2

decimal Api.HexAreaKm2(int r)

HexAreaKm2 Summary

Average hexagon area in square kilometers at the given resolution.

HexAreaKm2 Parameters

Name Type Description
r int Resolution to find average of

HexAreaM2

decimal Api.HexAreaM2(int r)

HexAreaM2 Summary

Average hexagon area in square meters at the given resolution.

HexAreaM2 Parameters

Name Type Description
r int Resolution to find average of

CellAreaKm2

decimal Api.CellAreaKm2(H3Index h)

CellAreaKm2 Summary

Exact area of specific cell in square kilometers.

CellAreaKm2 Parameters

Name Type Description
h H3Lib.H3Index Cell to find area of

CellAreaM2

decimal Api.CellAreaM2(H3Index h)

CellAreaM2 Summary

Exact area of specific cell in square meters.

CellAreaM2 Parameters

Name Type Description
h H3Lib.H3Index Cell to find area of

CellAreaRads2

decimal Api.CellAreaRads2(H3Index h)

CellAreaRads2 Summary

Exact area of specific cell in square radians.

CellAreaRads2 Parameters

Name Type Description
h H3Lib.H3Index Cell to find area of

EdgeLengthKm

decimal Api.EdgeLengthKm(int r)

EdgeLengthKm Summary

Average hexagon edge length in kilometers at the given resolution.

EdgeLengthKm Parameters

Name Type Description
r int Resolution

EdgeLengthM

decimal Api.EdgeLengthM(int r)

EdgeLengthM Summary

Average hexagon edge length in meters at the given resolution.

EdgeLengthM Parameters

Name Type Description
r int Resolution

ExactEdgeLengthKm

decimal Api.ExactEdgeLengthKm(H3Index edge)

ExactEdgeLengthKm Summary

Exact edge length of specific unidirectional edge in kilometers.

ExactEdgeLengthKm Parameters

Name Type Description
edge H3Lib.H3Index Unidirecitonal edge to measure

ExactEdgeLengthM

decimal Api.ExactEdgeLengthM(H3Index edge)

ExactEdgeLengthM Summary

Exact edge length of specific unidirectional edge in meters.

ExactEdgeLengthM Parameters

Name Type Description
edge H3Lib.H3Index Unidirecitonal edge to measure

ExactEdgeLengthRads

decimal Api.ExactEdgeLengthRads(H3Index edge)

ExactEdgeLengthRads Summary

Exact edge length of specific unidirectional edge in radians.

ExactEdgeLengthRads Parameters

Name Type Description
edge H3Lib.H3Index Unidirecitonal edge to measure

NumHexagons

long Api.NumHexagons(int r)

NumHexagons Summary

Number of unique H3 indexes at the given resolution.

NumHexagons Parameters

Name Type Description
r int Resolution to count cells of

GetRes0Indexes

void Api.GetRes0Indexes(out List<H3Index> outCells)

GetRes0Indexes Summary

All the resolution 0 H3 indexes. out must be an array of at least size res0IndexCount().

GetRes0Indexes Parameters

Name Type Description
outCells out List<H3Lib.H3Index> Cells of resolution 0

Res0IndexCount

int Api.Res0IndexCount()

Res0IndexCount Summary

Number of resolution 0 H3 indexes.

GetPentagonIndexes

void Api.GetPentagonIndexes(int r, out List<H3Index> outCells)

GetPentagonIndexes Summary

All the pentagon H3 indexes at the specified resolution.

GetPentagonIndexes Parameters

Name Type Description
r int Resolution of pentagons
outCells out List<H3Lib.H3Index> List of pentagons

PentagonIndexCount

int Api.PentagonIndexCount()

PentagonIndexCount Summary

Number of pentagon H3 indexes per resolution. This is always 12, but provided as a convenience.

PointDistKm

decimal Api.PointDistKm(GeoCoord a, GeoCoord b)

PointDistKm Summary

Gives the "great circle" or "haversine" distance between pairs of GeoCoord points (lat/lng pairs) in kilometers.

PointDistKm Parameters

Name Type Description
a H3Lib.GeoCoord Point A
b H3Lib.GeoCoord Point B

PointDistM

decimal Api.PointDistM(GeoCoord a, GeoCoord b)

PointDistM Summary

Gives the "great circle" or "haversine" distance between pairs of GeoCoord points (lat/lng pairs) in meters.

PointDistM Parameters

Name Type Description
a H3Lib.GeoCoord Point A
b H3Lib.GeoCoord Point B

PointDistRads

decimal Api.PointDistRads(GeoCoord a, GeoCoord b)

PointDistRads Summary

Gives the "great circle" or "haversine" distance between pairs of GeoCoord points (lat/lng pairs) in radians.

PointDistRads Parameters

Name Type Description
a H3Lib.GeoCoord Point A
b H3Lib.GeoCoord Point B

Return to Uber API Table of Contents