https://github.com/rowanwins/visibility-graph

Visibility graph implementation to support shortest path calculations such as dijkstra or a-star
https://github.com/rowanwins/visibility-graph

javascript visibility-graph

Last synced: 11 days ago
JSON representation

Visibility graph implementation to support shortest path calculations such as dijkstra or a-star

• Host: GitHub
• URL: https://github.com/rowanwins/visibility-graph
• Owner: rowanwins
• License: mit
• Created: 2018-01-05T05:23:21.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-06-14T14:38:36.000Z (over 1 year ago)
• Last Synced: 2024-10-12T04:17:36.657Z (27 days ago)
• Topics: javascript, visibility-graph
• Language: JavaScript
• Homepage: https://rowanwins.github.io/visibility-graph/debug/dist
• Size: 3.58 MB
• Stars: 51
• Watchers: 7
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# visibility-graph.js

Visibility graph implementation to support shortest path calculations such as [dijkstra](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm) or [a-star](https://en.wikipedia.org/wiki/A*_search_algorithm).

### [Demo](https://rowanwins.github.io/visibility-graph/debug/dist/index.html)

## Documentation

This library exposes a `VisibilityGraph` class

#### API

`new VisibilityGraph(geojson, ?existingGraph)` - creates a new instance using a [Polygon](http://geojson.win/#appendix-A.3) or [MultiPolygon](http://geojson.win/#appendix-A.6) feature or geometry. Optionally, if you have an existing graph that you've previously generated using the `.saveGraphToJson()` you can pass it in as a argument.

`.saveGraphToJson()` - Returns a json representation of the visibility graph which can be saved to disk and then restored by passing a second argument to the class constructor.

`.addStartAndEndPointsToGraph(origin, destination)` - Takes 2 geojson point features, one for the origin, and one for the destination, and returns the newly added nodes in an object `{startNode: ngraphNode, endNode: ngraphNode}`. Each time this is called any previously added start and end points are removed from the graph.

`.getNodeIdByLatLon([lat, lon])` - Returns a graph node ID that matches the lat lon.

## Example

````js

  import VisibilityGraph from 'visibility-graph.js'

  import path from 'ngraph.path'

  // Create the visibility graph from the geojson data

  const vg = new VisibilityGraph(geojson)

  // Use the 'ngraph.path' library to find a way 

  //through the newly created visibility graph

  const pathFinder = path.nba(vg.graph, {

    distance (fromNode, toNode) {

      const dx = fromNode.data.x - toNode.data.x

      const dy = fromNode.data.y - toNode.data.y

      return Math.sqrt(dx * dx + dy * dy)

    }

  })

  // Add the start and endpoints to the graph  

  const startEndNodes = vg.addStartAndEndPointsToGraph(

    {type: 'Feature', geometry: {type: 'Point', coordinates: [0, 0]}},

    {type: 'Feature', geometry: {type: 'Point', coordinates: [10, 10]}}

  )

  

  // And finally retrive the optimal path 

  const optimalPath = pathFinder.find(

    startEndNodes.startNode.nodeId,

    startEndNodes.endNode.nodeId

  )

  ````

**NOTE:** If you get occassional issues with how your edges are being linked try reducing the precision of your coordinates (eg 8 decimal places). 

## Using with other packages

- Path finding can be achieved with the [ngraph.path](https://github.com/anvaka/ngraph.path) package.

## Performance

The process of creating a visibility graph can be slow depending on the number of vertices in your input geometry.

| Scenario  | Nodes/Vertices  | Create Graph  | Time Reload Graph / Graph Size  |

| --------- | --------------- | ------------- | ------------------------------- |

| Australia | 250             | 1 second      | 300kb                           |

| Asia      | 1400            | 4 seconds     | 100ms / 5.2MB                   |

| World     | 4400            | 20 seconds    |                                 |

Depending on your requirements you may also be able to convert your input data if it has concave polygons, to only having convex polygons, this may reduce redundant nodes in the graph.

## References & Credits

* Based on [pyvisgraph](https://github.com/TaipanRex/pyvisgraph) and associated blog posts

  * [Distance Tables Part 1: Defining the Problem](https://taipanrex.github.io/2016/09/17/Distance-Tables-Part-1-Defining-the-Problem.html)

  * [Distance Tables Part 2: Lee's Visibility Graph Algorithm](https://taipanrex.github.io/2016/10/19/Distance-Tables-Part-2-Lees-Visibility-Graph-Algorithm.html)

* [Lee's o(n2 log n) Visibility Graph Algorithm](https://github.com/davetcoleman/visibility_graph/blob/master/Visibility_Graph_Algorithm.pdf) paper by Dave Coleman

* [Intro to path finding](https://www.redblobgames.com/pathfinding/)

  * And specifically a bit about [visibility graphs](https://www.redblobgames.com/pathfinding/visibility-graphs/)