SphericalEarth

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def distanceCalculator(radius: Double): DistanceCalculator

Creates an instance of the DistanceCalculator type class which use the haversine formula to determine the great-circle distance between a point and a rounding box of R-tree on a sphere with specified radius given their longitudes and latitudes.
Creates an instance of the DistanceCalculator type class which use the haversine formula to determine the great-circle distance between a point and a rounding box of R-tree on a sphere with specified radius given their longitudes and latitudes.
To simplify creation of entries and queries X-axis is used for latitudes an and Y-axis for longitudes.
Calculations was borrowed from the geoflatbush project of Vladimir Agafonkin: https://github.com/mourner/geoflatbush/blob/master/index.mjs

Definition Classes
Spherical
implicit val distanceCalculator: DistanceCalculator

An instance of the DistanceCalculator type class which use a spherical model of the Earth to calculate distances that are represented in kilometers.
An instance of the DistanceCalculator type class which use a spherical model of the Earth to calculate distances that are represented in kilometers.
It is use 6371.0088 as a value of the mean radius in kilometers, see: https://en.wikipedia.org/wiki/Earth_radius#Mean_radius It allows to get +0.2% accuracy on poles, -0.1% on the equator, and less than ±0.05% on medium latitudes.
If your indexed entries and requests are located in some area that is less than half-sphere than you can use mean radius between min and max radiuses in used range of latitudes to get much better accuracy.
Use the EllipsoidalEarth.radius function to calculate it for different latitudes.
Precision of 32-bit float number allows to locate points and calculate distances with an error ±0.5 meters.
def entries[A](lat: Float, lon: Float, distance: Float, value: A): IndexedSeq[RTreeEntry[A]]

Create an indexed sequence of entries that are specified by a circular area on the Earth and a value.
Create an indexed sequence of entries that are specified by a circular area on the Earth and a value.
Sequence of entries required for case when the circle is crossed by the anti-meridian because the RTree which use bounding box form longitudes and latitudes for indexing doesn't support wrapping of longitudes over the Earth, so we split that entries on two by the date change meridian.
A
a type of the value being put in the r-tree
lat
a latitude coordinate of the given center point
lon
a latitude coordinate of the given center point
distance
a distance, from the center point to borders of the circular area on the Earth surface, if the value of distance is greater than a half of the circumference then the whole Earth will be bounded
value
a value to store in the r-tree
returns
a newly created entry
def entries[A](lat: Float, lon: Float, distance: Float, value: A, radius: Double): IndexedSeq[RTreeEntry[A]]

Create an indexed sequence of entries that are specified by a circular area on the sphere and a value.
Create an indexed sequence of entries that are specified by a circular area on the sphere and a value.
Sequence of entries required for case when the circle is crossed by the anti-meridian because the RTree which use bounding box form longitudes and latitudes for indexing doesn't support wrapping of longitudes over the sphere, so we split that entries on two by the date change meridian.
Used formula with description is here: http://janmatuschek.de/LatitudeLongitudeBoundingCoordinates#Longitude
A
a type of the value being put in the r-tree
lat
a latitude coordinate of the given center point
lon
a latitude coordinate of the given center point
distance
a distance, from the center point to borders of the circular area on the sphere surface, if the value of distance is greater than a half of the circumference then a whole sphere will be bounded
value
a value to store in the r-tree
radius
a value of radius to calculate
returns
a newly created entry

Definition Classes
Spherical
def entry[A](minLat: Float, minLon: Float, maxLat: Float, maxLon: Float, value: A): RTreeEntry[A]

Create an entry specified by a rectangle with spherical coordinates and a value.
Create an entry specified by a rectangle with spherical coordinates and a value.
A
a type of the value being put in the r-tree
minLat
a latitude coordinate of the left bottom corner
minLon
a latitude coordinate of the left bottom corner
maxLat
a latitude coordinate of the right top corner
maxLon
a latitude coordinate of the right top corner
value
a value to store in the r-tree
returns
a newly created entry

Definition Classes
Spherical
def entry[A](lat: Float, lon: Float, value: A): RTreeEntry[A]

Create an entry specified by a point with spherical coordinates and a value.
Create an entry specified by a point with spherical coordinates and a value.
A
a type of the value being put in the r-tree
lat
a latitude coordinate of the given point
lon
a latitude coordinate of the given point
value
a value to store in the r-tree
returns
a newly created entry

Definition Classes
Spherical
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package core

object SphericalEarth extends Spherical

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def distanceCalculator(radius: Double): DistanceCalculator

implicit val distanceCalculator: DistanceCalculator

def entries[A](lat: Float, lon: Float, distance: Float, value: A): IndexedSeq[RTreeEntry[A]]

def entries[A](lat: Float, lon: Float, distance: Float, value: A, radius: Double): IndexedSeq[RTreeEntry[A]]

def entry[A](minLat: Float, minLon: Float, maxLat: Float, maxLon: Float, value: A): RTreeEntry[A]

def entry[A](lat: Float, lon: Float, value: A): RTreeEntry[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Spherical

Inherited from AnyRef

Inherited from Any

Ungrouped