uber/h3

Calculate and include more size/area/distortion stats per resolution

Open

#240 opened on May 28, 2019

View on GitHubContributor guide
 (2 comments) (4 reactions) (0 assignees)C (585 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (6,310 stars)
PR merge metrics
 (Avg merge 7d 19h) (17 merged PRs in 30d)

Description

When building algorithms using H3, consumers may need to satisfy specific constraints, e.g. "buffer within X meters of a given point". Our existing edgeLength and hexArea stats are averages, which is insufficient to determine whether a given resolution or buffer size will satisfy the requirement.

I think it would be worthwhile to calculate and publish (either in the library or in the docs) the following stats for each res:

  • min, max, mean, and stddev for
  • edgeLength, area, and possibly minDiameter (perpendicular edge-edge) and maxDiameter (vertex-vertex)
  • both with and without pentagons

It might not be worthwhile to include all of this in the lib, but publishing it would allow others to use it in their code if needed.

Contributor guide

Research direction
Explore the H3 library's existing functions for cell boundary and edge length calculations. Use these to compute the required statistics (min, max, mean, stddev) for each resolution, distinguishing between pentagons and hexagons.
Tech stack
c
Domain
apidata
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CH3 library basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65