diff --git a/GeoSpatialTools/distance_metrics.py b/GeoSpatialTools/distance_metrics.py index 339b0fcd9d32dc7e20fe3c5b9eae0e3f41ce5c91..024360d359d43e14c29b70977cc44940bf2c7e67 100644 --- a/GeoSpatialTools/distance_metrics.py +++ b/GeoSpatialTools/distance_metrics.py @@ -1,4 +1,6 @@ """ +Distance Metrics +---------------- Functions for computing navigational information. Can be used to add navigational information to DataFrames. """ diff --git a/GeoSpatialTools/great_circle.py b/GeoSpatialTools/great_circle.py index b2cb6d9b8fa1430845e6f52bed196d7fd7d0aa7b..b6a2882f10285b2618449b73c0d8412a674144c3 100644 --- a/GeoSpatialTools/great_circle.py +++ b/GeoSpatialTools/great_circle.py @@ -1,4 +1,9 @@ -"""Class for a Great Circle object.""" +""" +GreatCircle +----------- +Constructors and methods for interacting with GreatCircle objects, including +comparisons between GreatCircle objects. +""" import numpy as np diff --git a/GeoSpatialTools/kdtree.py b/GeoSpatialTools/kdtree.py index 7da9df63688f8d7c4f7e4c954e302ac89a6a3acb..7151bc680a818601d53cf09018f3a1a7dc37db0e 100644 --- a/GeoSpatialTools/kdtree.py +++ b/GeoSpatialTools/kdtree.py @@ -1,6 +1,12 @@ """ +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 diff --git a/GeoSpatialTools/neighbours.py b/GeoSpatialTools/neighbours.py index 02143fca57dddaeb8402c0f44984f1825e29f672..0d86e8ac72df2cb92720a11b6b3529deff531d71 100644 --- a/GeoSpatialTools/neighbours.py +++ b/GeoSpatialTools/neighbours.py @@ -1,4 +1,8 @@ -"""Functions for finding nearest neighbours using bisection.""" +""" +Neighbours +---------- +Functions for finding nearest neighbours using bisection. +""" from numpy import argmin from bisect import bisect diff --git a/GeoSpatialTools/octtree.py b/GeoSpatialTools/octtree.py index 029ff9ec82ab446b84869854ea3e4234dd9d6bb2..79542ff0721e331df7398b42d7b67fbff6228016 100644 --- a/GeoSpatialTools/octtree.py +++ b/GeoSpatialTools/octtree.py @@ -1,3 +1,12 @@ +""" +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 diff --git a/GeoSpatialTools/quadtree.py b/GeoSpatialTools/quadtree.py index 214bc38bf9976b0f06d02c59d0cc8880c400a12c..90a22c78d08e711e0edad577a9b2a02fe66a1503 100644 --- a/GeoSpatialTools/quadtree.py +++ b/GeoSpatialTools/quadtree.py @@ -1,6 +1,10 @@ """ +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