Coverage for pygeodesy/utily.py : 97%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# -*- coding: utf-8 -*-
After I{(C) Chris Veness 2011-2015} published under the same MIT Licence**, see U{Latitude/Longitude<https://www.Movable-Type.co.UK/scripts/latlong.html>} and U{Vector-based geodesy<https://www.Movable-Type.co.UK/scripts/latlong-vectors.html>}.
@newfield example: Example, Examples '''
# all public contants, classes and functions
# <https://Numbers.Computation.Free.FR/Constants/Miscellaneous/digits.html>
'''Convert radians to degrees and wrap M{[-270..+90]}.
@arg rad: Angle (C{radians}).
@return: Angle in degrees, wrapped (C{degrees90}). '''
'''Convert radians to degrees and wrap M{[-180..+180]}.
@arg rad: Angle (C{radians}).
@return: Angle in degrees, wrapped (C{degrees180}). '''
'''Convert radians to degrees and wrap M{[0..+360)}.
@arg rad: Angle (C{radians}).
@return: Angle in degrees, wrapped (C{degrees360}). '''
'''Convert angle to distance along the equator or along a parallel at an other latitude.
@arg deg: Angle (C{degrees}). @kwarg radius: Mean earth radius (C{meter}). @kwarg lat: Parallel latitude (C{degrees90}).
@return: Distance (C{meter}, same units as B{C{radius}}).
@raise RangeError: Latitude B{C{lat}} outside valid range and L{rangerrors} set to C{True}. '''
'''Convert a false east-/northing to non-negative float.
@arg value: Value to convert (C{scalar}). @kwarg name: Optional name of the value (C{str}). @kwarg false: Optionally, value includes false origin (C{bool}). @kwarg Error: Exception to raise (C{ValueError}).
@return: The value (C{float}).
@raise Error: Invalid or negative B{C{value}}. ''' raise ValueError except (TypeError, ValueError): raise Error('%s invalid: %r' % (name, value))
'''Convert I{International} or I{US Survey} feet to meter.
@arg feet: Value in feet (C{scalar}). @kwarg usurvery: Convert I{US Survey} feet (C{bool}), I{International} feet otherwise.
@return: Value in C{meter} (C{float}). ''' # US Survey 1200./3937. == 0.3048006096012192
'''Check for an B{C{Numpy2LatLon}} points wrapper.
@arg obj: The object (any C{type}).
@return: C{True} if B{C{obj}} is an B{C{Numpy2LatLon}} instance, C{False} otherwise. ''' # isinstance(self, (Numpy2LatLon, ...))
'''Check for an B{C{LatLon2psxy}} points wrapper.
@arg obj: The object (any C{type}).
@return: C{True} if B{C{obj}} is an B{C{LatLon2psxy}} instance, C{False} otherwise. ''' # isinstance(self, (LatLon2psxy, ...))
'''Check for an B{C{Tuple2LatLon}} points wrapper.
@arg obj: The object (any).
@return: C{True} if B{C{obj}} is an B{C{Tuple2LatLon}} instance, C{False} otherwise. ''' # isinstance(self, (Tuple2LatLon, ...))
'''Iterate over Numpy2 wrappers or other sequences exceeding the threshold.
@arg obj: Points array, list, sequence, set, etc. (any).
@return: C{True} do, C{False} don't iterate. ''' except TypeError: return False
'''Get or set the L{iterNumpy2} threshold.
@kwarg n: Optional, new threshold (C{int}).
@return: Previous threshold (C{int}).
@raise ValueError: Invalid B{C{n}}. ''' global _iterNumpy2len else: raise ValueError except (TypeError, ValueError): raise ValueError('%s invalid: %r' % ('n', n))
'''Convert distance to angle along equator.
@arg meter: Distance (C{meter}, same units as B{C{radius}}). @kwarg radius: Mean earth radius (C{meter}).
@return: Angle (C{degrees}).
@raise ValueError: Invalid B{C{radius}}. ''' raise ValueError('%s invalid: %r' % ('radius', radius))
'''Convert meter to I{International} or I{US Survey} feet (C{ft}).
@arg meter: Value in meter (C{scalar}). @kwarg usurvery: Convert to I{US Survey} feet (C{bool}), I{International} feet otherwise.
@return: Value in C{feet} (C{float}). ''' # US Survey == 3937./1200. = 3.2808333333333333
'''Convert meter to kilo meter (km).
@arg meter: Value in meter (C{scalar}).
@return: Value in km (C{float}). '''
'''Convert meter to nautical miles (NM).
@arg meter: Value in meter (C{scalar}).
@return: Value in NM (C{float}). '''
'''Convert meter to statute miles (SM).
@arg meter: Value in meter (C{scalar}).
@return: Value in SM (C{float}). '''
'''Convert and wrap degrees to radians M{[-PI..+PI]}.
@arg deg: Angle (C{degrees}).
@return: Radians, wrapped (C{radiansPI}) '''
'''Convert and wrap degrees to radians M{[0..+2PI)}.
@arg deg: Angle (C{degrees}).
@return: Radians, wrapped (C{radiansPI2}) '''
'''Convert and wrap degrees to radians M{[-3PI/2..+PI/2]}.
@arg deg: Angle (C{degrees}).
@return: Radians, wrapped (C{radiansPI_2}) '''
'''(INTERNAL) 2-tuple (C{sin(r), cos(r)}) in quadrant C{q}. ''' else: # XXX sin(-0.0)?
'''Return the C{sine} and C{cosine} of angle(s).
@arg rad: One or more angles (C{radians}).
@return: The C{sin(rad)} and C{cos(rad)} for each angle.
@see: U{GeographicLib<https://GeographicLib.SourceForge.io/html/ classGeographicLib_1_1Math.html#sincosd>} function U{sincosd <https://SourceForge.net/p/geographiclib/code/ci/release/tree/ python/geographiclib/geomath.py#l155>} and C++ U{sincosd <https://SourceForge.net/p/geographiclib/code/ci/release/tree/ include/GeographicLib/Math.hpp#l558>}. '''
'''Return the C{sine} and C{cosine} of angle(s) in C{degrees}.
@arg deg: One or more angles (C{degrees}).
@return: The C{sin(rad)} and C{cos(rad)} for each angle.
@see: U{GeographicLib<https://GeographicLib.SourceForge.io/html/ classGeographicLib_1_1Math.html#sincosd>} function U{sincosd <https://SourceForge.net/p/geographiclib/code/ci/release/tree/ python/geographiclib/geomath.py#l155>} and C++ U{sincosd <https://SourceForge.net/p/geographiclib/code/ci/release/tree/ include/GeographicLib/Math.hpp#l558>}. '''
'''Compute the tangent of half angle.
@arg rad: Angle (C{radians}).
@return: M{tan(rad / 2)} (C{float}). '''
'''Compute the tangent of half angle, 90 degrees rotated.
@arg rad: Angle (C{radians}).
@return: M{tan((rad + PI/2) / 2)} (C{float}). '''
'''Unroll longitudinal delta and wrap longitude in degrees.
@arg lon1: Start longitude (C{degrees}). @arg lon2: End longitude (C{degrees}). @kwarg wrap: Wrap and unroll to the M{(-180..+180]} range (C{bool}).
@return: 2-Tuple (B{C{lon2-lon1}}, B{C{lon2}}) unrolled (C{degrees}, C{degrees}).
@see: Capability C{LONG_UNROLL} in U{GeographicLib <https://GeographicLib.SourceForge.io/html/python/interface.html#outmask>}. '''
'''Unroll longitudinal delta and wrap longitude in radians.
@arg rad1: Start longitude (C{radians}). @arg rad2: End longitude (C{radians}). @kwarg wrap: Wrap and unroll to the M{(-PI..+PI]} range (C{bool}).
@return: 2-Tuple (B{C{rad2 - rad1}}, B{C{rad2}}) unrolled (C{radians}, C{radians}).
@see: Capability C{LONG_UNROLL} in U{GeographicLib <https://GeographicLib.SourceForge.io/html/python/interface.html#outmask>}. '''
'''(INTERNAL) Angle wrapper M{((wrap-modulo)..+wrap]}.
@arg angle: Angle (C{degrees} or C{radians}). @arg wrap: Range (C{degrees} or C{radians}). @arg modulo: Upper limit (360 C{degrees} or PI2 C{radians}).
@return: The B{C{angle}}, wrapped (C{degrees} or C{radians}). ''' # math.fmod(-1.5, 3.14) == -1.5, but -1.5 % 3.14 == 1.64 # math.fmod(-1.5, 360) == -1.5, but -1.5 % 360 == 358.5
'''Wrap degrees to M{[-270..+90]}.
@arg deg: Angle (C{degrees}).
@return: Degrees, wrapped (C{degrees90}). '''
'''Wrap degrees to M{[-180..+180]}.
@arg deg: Angle (C{degrees}).
@return: Degrees, wrapped (C{degrees180}). '''
'''Wrap degrees to M{[0..+360)}.
@arg deg: Angle (C{degrees}).
@return: Degrees, wrapped (C{degrees360}). '''
'''Wrap radians to M{[-PI..+PI]}.
@arg rad: Angle (C{radians}).
@return: Radians, wrapped (C{radiansPI}). '''
'''Wrap radians to M{[0..+2PI)}.
@arg rad: Angle (C{radians}).
@return: Radians, wrapped (C{radiansPI2}). '''
'''Wrap radians to M{[-3PI/2..+PI/2]}.
@arg rad: Angle (C{radians}).
@return: Radians, wrapped (C{radiansPI_2}). '''
# **) MIT License # # Copyright (C) 2016-2020 -- mrJean1 at Gmail -- All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), # to deal in the Software without restriction, including without limitation # the rights to use, copy, modify, merge, publish, distribute, sublicense, # and/or sell copies of the Software, and to permit persons to whom the # Software is furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE. |