Home       Trees       Indices       Help   
PyGeodesy
Package pygeodesy :: Module frechet :: Class FrechetDistanceTo
[frames] | no frames]

Class FrechetDistanceTo

  object --+        
           |        
named._Named --+    
               |    
         Frechet --+
                   |
                  FrechetDistanceTo

Compute the Frechet distance based on the distance from the point1s' LatLon.distanceTo method, conventionally in meter.

Instance Methods
 
__init__(self, point1s, fraction=None, name='', **distanceTo_kwds)
New FrechetDistanceTo calculator/interpolator.
 
discrete(self, point2s, fraction=None)
Compute the forward, discrete Fréchet distance.
 
distance(self, p1, p2)
Return the distance in meter.

Inherited from Frechet: point, points_, points_fraction

Inherited from named._Named: __imatmul__, __matmul__, __repr__, __rmatmul__, __str__, attrs, classof, copy, dup, methodname, rename, toRepr, toStr, toStr2

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties

Inherited from Frechet: adjust, datum, fraction, kwds, units, wrap

Inherited from named._Named: classname, classnaming, iteration, name, named, named2, named3, named4, sizeof

Inherited from object: __class__

Method Details

__init__ (self, point1s, fraction=None, name='', **distanceTo_kwds)
(Constructor)

 

New FrechetDistanceTo calculator/interpolator.

Arguments:
  • distanceTo_kwds - Optional keyword arguments for each point1s' LatLon.distanceTo method.
Raises:
  • FrechetError - Insufficient number of point1s or an invalid point1, fraction or units.
Overrides: object.__init__

See Also: Frechet.__init__ for details about point1s, fraction, name and other exceptions.

Note: All point1s must be instances of the same ellipsoidal or spherical LatLon class.

discrete (self, point2s, fraction=None)

 

Compute the forward, discrete Fréchet distance.

Arguments:
  • point2s - Second set of points (LatLon[], Numpy2LatLon[], Tuple2LatLon[] or other[]).
  • fraction - Index fraction (float in EPS..EPS1) to interpolate intermediate point2s or use None, 0 or 1 for no intermediate point2s and no fractional indices.
Returns:
A Frechet6Tuple(fd, fi1, fi2, r, n, units).
Raises:
Overrides: Frechet.discrete

distance (self, p1, p2)

 

Return the distance in meter.

Overrides: Frechet.distance

   Home       Trees       Indices       Help   
PyGeodesy
Generated by Epydoc 3.0.1 on Sun May 5 14:46:25 2024 http://epydoc.sourceforge.net