Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
Joseph Siddons
GeoSpatialTools
Commits
eb6865fc
Commit
eb6865fc
authored
4 months ago
by
Joseph Siddons
Browse files
Options
Download
Email Patches
Plain Diff
docs: add docstrings for modules
parent
47b055e5
Changes
6
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
34 additions
and
4 deletions
+34
-4
GeoSpatialTools/distance_metrics.py
GeoSpatialTools/distance_metrics.py
+2
-0
GeoSpatialTools/great_circle.py
GeoSpatialTools/great_circle.py
+6
-1
GeoSpatialTools/kdtree.py
GeoSpatialTools/kdtree.py
+7
-1
GeoSpatialTools/neighbours.py
GeoSpatialTools/neighbours.py
+5
-1
GeoSpatialTools/octtree.py
GeoSpatialTools/octtree.py
+9
-0
GeoSpatialTools/quadtree.py
GeoSpatialTools/quadtree.py
+5
-1
No files found.
GeoSpatialTools/distance_metrics.py
View file @
eb6865fc
"""
Distance Metrics
----------------
Functions for computing navigational information. Can be used to add
navigational information to DataFrames.
"""
...
...
This diff is collapsed.
Click to expand it.
GeoSpatialTools/great_circle.py
View file @
eb6865fc
"""Class for a Great Circle object."""
"""
GreatCircle
-----------
Constructors and methods for interacting with GreatCircle objects, including
comparisons between GreatCircle objects.
"""
import
numpy
as
np
...
...
This diff is collapsed.
Click to expand it.
GeoSpatialTools/kdtree.py
View file @
eb6865fc
"""
KDTree
------
An implementation of KDTree using Haversine Distance for GeoSpatial analysis.
Useful tool for quickly searching for nearest neighbours.
Useful tool for quickly searching for nearest neighbours. The implementation is
a K=2 or 2DTree as only 2 dimensions (longitude and latitude) are used.
Haversine distances are used for comparisons, so that the spherical geometry
of the earth is accounted for.
"""
from
.
import
Record
...
...
This diff is collapsed.
Click to expand it.
GeoSpatialTools/neighbours.py
View file @
eb6865fc
"""Functions for finding nearest neighbours using bisection."""
"""
Neighbours
----------
Functions for finding nearest neighbours using bisection.
"""
from
numpy
import
argmin
from
bisect
import
bisect
...
...
This diff is collapsed.
Click to expand it.
GeoSpatialTools/octtree.py
View file @
eb6865fc
"""
OctTree
-------
Constuctors for OctTree classes that can decrease the number of comparisons
for detecting nearby records for example. This is an implementation that uses
Haversine distances for comparisons between records for identification of
neighbours.
"""
from
dataclasses
import
dataclass
from
typing
import
List
,
Optional
import
datetime
...
...
This diff is collapsed.
Click to expand it.
GeoSpatialTools/quadtree.py
View file @
eb6865fc
"""
QuadTree
--------
Constuctors for QuadTree classes that can decrease the number of comparisons
for detecting nearby records for example
for detecting nearby records for example. This is an implementation that uses
Haversine distances for comparisons between records for identification of
neighbours.
"""
from
dataclasses
import
dataclass
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment