Package pygeodesy :: Module frechet :: Class FrechetVincentys |
[frames] | no frames]

# Class FrechetVincentys

      object --+
               |
    named._Named --+
                   |
             Frechet --+
                       |
          FrechetRadians --+
                           |
                          FrechetVincentys

Compute the `Frechet` distance based on the angular `Vincenty` distance (in radians) from function vincentys_.

Note: See note under vincentys_.

See Also: FrechetEquirectangular, FrechetEuclidean and FrechetHaversine.

Instance Methods
__init__(self, points, wrap=False, fraction=None, name=`'````'`) New FrechetVincentys calculator/interpolator. |
distance(self, p1, p2) Return the vincentys_ distance in `radians`. |
discrete(self, points, fraction=None) Compute the `forward, discrete Fréchet` distance. |
Inherited from `FrechetRadians`: `point` Inherited from `Frechet`: `points_`, `points_fraction` Inherited from `named._Named`: `__copy__`, `__repr__`, `__str__`, `classof`, `copy`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
Inherited from `Frechet`: `fraction`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, points, wrap=False, fraction=None, name=`'````'`) (Constructor) |
New FrechetVincentys calculator/interpolator. Parameters: `points` - First set of points (`LatLon`[], `Numpy2LatLon`[], `Tuple2LatLon`[] or `other`[]). `wrap` - Wrap and unroll180 longitudes (`bool`). `fraction` - Index fraction (`float` in EPS..EPS1) to interpolate intermediate `points` or `None` or `1` for no intermediate `points` and no fractional indices. `name` - Optional calculator/interpolator name (`str`). Raises: `FrechetError` - Insufficient number of `points` or invalid `fraction`. Overrides: object.__init__

### distance(self, p1, p2) |
Return the vincentys_ distance in `radians`. Raises: `AssertionError` - Not overloaded. Overrides: Frechet.distance

### discrete(self, points, fraction=None) |
Compute the `forward, discrete Fréchet` distance. Parameters: `points` - Second set of points (`LatLon`[], `Numpy2LatLon`[], `Tuple2LatLon`[] or `other`[]). `fraction` - Index fraction (`float` in EPS..EPS1) to interpolate intermediate `points` or `None` or `1` for no intermediate `points` and no fractional indices. Returns: A Frechet6Tuple`(fd, fi1, fi2, r, n, units)`. Raises: `FrechetError` - Insufficient number of `points` or invalid `fraction`. `RecursionError` - Recursion depth exceeded, see sys.getrecursionlimit(). Overrides: Frechet.discrete