Geolocation structures

Simple structures to store georeferenced locations and attitudes. Geolocation which records lat/lon can be implicitly converted to and from GeolocationUTM which stores utm coordinates.

Example usage

 # import this module# import this module
from themachinethatgoesping.navigation.datastructures import GeolocationLatLon, GeolocationUTM

location = GeolocationUTM(
   5427745.995,  # northing
   314082.699, # easting
   60, #utm zone
   False, #northern_hemisphere
   3, #depth
   10, #yaw
   20, #pitch
   30) #roll

   print(location)

   # GeolocationUTM
   # **************
   # - northing:            5427746.00 [positive northwards, m]
   # - easting:             314082.70  [positive eastwards, m]
   # - zone:                60
   # - northern_hemisphere: false
   # - z:                   3.00       [positive downwards, m]
   # - yaw:                 10.00      [90 ° at east]
   # - pitch:               20.00      [° positive bow up]
   # - roll:                30.00      [° positive port up]

   # conversion to latlon location (works in both directions)
   location_latlon = Geolocation(location)

   print(location_latlon)

   # Geolocation
   # ***********
   #   latitude:  41°16'49.2"S  [ddd°mm',ss.s''N/S]
   # - longitude: 41°16'49.2"W  [ddd°mm',ss.s''E/W]
   # - z:         3.00   [positive downwards, m]
   # - yaw:       10.00  [90 ° at east]
   # - pitch:     20.00  [° positive bow up]
   # - roll:      30.00  [° positive port up]

Data structures

class GeolocationLatLon

A structure to store a georeferenced location and attitude (e.g. of a sensor) Unlike the base Geolocation object, this also stores latitude and longitude coordinates

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationLatLon, location: themachinethatgoesping.navigation.datastructures.Geolocation, latitude: float, longitude: float) -> None

Construct a new Sensor Data Lat Lon object using a base sensor data object

Parameter location:

$Parameter latitude:

in °, positive northwards

Parameter longitude:

in °, positive eastwards

2. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationLatLon, geolocationlatlon_utm: themachinethatgoesping::navigation::datastructures::GeolocationUTM) -> None

Construct an GeolocationLatLon object from an existing GeolocationUTM object (this allows for explicit conversion from GeolocationUTM class)

3. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationLatLon, latitude: float = 0, longitude: float = 0, z: float = 0, yaw: float = 0, pitch: float = 0, roll: float = 0) -> None

Construct a new GeolocationLatLon object

Parameter latitude:

in °, positive northwards

Parameter longitude:

in °, positive eastwards

Parameter z:

in m, positive downwards

Parameter yaw:

in °, 0° is north, 90° is east

Parameter pitch:

in °, positive means bow up

Parameter roll:

in °, positive means port up

copy(self: GeolocationLatLon) → GeolocationLatLon

return a copy using the c++ default copy constructor

static from_binary(buffer: bytes, check_buffer_is_read_completely: bool = True) → GeolocationLatLon

create T_CLASS object from bytearray

hash(self: GeolocationLatLon) → int

hash function implemented using binary_hash

info_string(self: GeolocationLatLon, float_precision: int = 2) → str

Return object information as string

property latitude

< in °, positive northwards

property longitude

< in °, positive eastwards

print(self: GeolocationLatLon, float_precision: int = 2) → None

Print object information

slow_hash(self: GeolocationLatLon) → int

hash function implemented using slow_hash

to_binary(self: GeolocationLatLon, resize_buffer: bool = True) → bytes

convert object to bytearray

class GeolocationUTM

A structure to store a georeferenced location and attitude (e.g. of a sensor) unlike the default Geolocation structure, this object stores utm coordinates

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationUTM, geolocationlocal: themachinethatgoesping.navigation.datastructures.GeolocationLocal, utm_zone: int, northern_hemisphere: bool) -> None

Construct an GeolocationUTM object from an existing GeolocationLocal object (using a known zone and hemisphere)

Parameter location_local:

$Parameter utm_zone:

UTM/UPS zone number

Parameter northern_hemisphere:

if true: northern hemisphere, else: southern hemisphere

2. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationUTM, geolocationlatlon: themachinethatgoesping.navigation.datastructures.GeolocationLatLon, setzone: int = -1) -> None

Construct an GeolocationUTM object from an existing GeolocationLatLon object (this allows for explicit conversion from GeolocationLatLon class)

3. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationUTM, northing: float = 0, easting: float = 0, utm_zone: int = 0, northern_hemisphere: bool = True, z: float = 0, yaw: float = 0, pitch: float = 0, roll: float = 0) -> None

Construct a new GeolocationUTM object

Parameter northing:

in m, positive northwards

Parameter easting:

in m, positive eastwards

Parameter utm_zone:

UTM/UPS zone number

Parameter northern_hemisphere:

if true: northern hemisphere, else: southern hemisphere

Parameter z:

in m, positive downwards

Parameter yaw:

in °, 0° is north, 90° is east

Parameter pitch:

in °, positive means bow up

Parameter roll:

in °, positive means port up

copy(self: GeolocationUTM) → GeolocationUTM

return a copy using the c++ default copy constructor

static from_binary(buffer: bytes, check_buffer_is_read_completely: bool = True) → GeolocationUTM

create T_CLASS object from bytearray

hash(self: GeolocationUTM) → int

hash function implemented using binary_hash

info_string(self: GeolocationUTM, float_precision: int = 2) → str

Return object information as string

print(self: GeolocationUTM, float_precision: int = 2) → None

Print object information

slow_hash(self: GeolocationUTM) → int

hash function implemented using slow_hash

to_binary(self: GeolocationUTM, resize_buffer: bool = True) → bytes

convert object to bytearray

property utm_zone

< UTM/UPS zone number

class GeolocationLocal

A structure to store a georeferenced location and attitude (e.g. of a sensor) unlike the default Geolocation structure, this object stores local northing and easting coordinates. These coordinates can be converted to UTM coordinates if the zone and hemisphere are known.

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationLocal, geolocationutm: themachinethatgoesping::navigation::datastructures::GeolocationUTM) -> None

Construct a new Sensor Position object (all offsets set to 0)

2. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationLocal, geolocation: themachinethatgoesping.navigation.datastructures.Geolocation, northing: float, easting: float) -> None

Construct a new GeolocationLocal object

Parameter location:

$Parameter northing:

in m, positive northwards

Parameter easting:

in m, positive eastwards

3. __init__(self: themachinethatgoesping.navigation.datastructures.GeolocationLocal, northing: float = 0, easting: float = 0, z: float = 0, yaw: float = 0, pitch: float = 0, roll: float = 0) -> None

Construct a new GeolocationLocal object

Parameter northing:

in m, positive northwards

Parameter easting:

in m, positive eastwards

Parameter z:

in m, positive downwards

Parameter yaw:

in °, 0° is north, 90° is east

Parameter pitch:

in °, positive means bow up

Parameter roll:

in °, positive means port up

copy(self: GeolocationLocal) → GeolocationLocal

return a copy using the c++ default copy constructor

property easting

< in m, positive eastwards

static from_binary(buffer: bytes, check_buffer_is_read_completely: bool = True) → GeolocationLocal

create T_CLASS object from bytearray

hash(self: GeolocationLocal) → int

hash function implemented using binary_hash

info_string(self: GeolocationLocal, float_precision: int = 2) → str

Return object information as string

property northing

< in m, positive northwards

print(self: GeolocationLocal, float_precision: int = 2) → None

Print object information

slow_hash(self: GeolocationLocal) → int

hash function implemented using slow_hash

to_binary(self: GeolocationLocal, resize_buffer: bool = True) → bytes

convert object to bytearray

class Geolocation

A structure to store a georeferenced location and attitude (e.g. of a sensor) This structure does not store any coordinates except the depth (z)

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: themachinethatgoesping.navigation.datastructures.Geolocation, geolocation_latlon: themachinethatgoesping::navigation::datastructures::GeolocationLatLon) -> None

Construct a new Position object

2. __init__(self: themachinethatgoesping.navigation.datastructures.Geolocation, geolocation_local: themachinethatgoesping::navigation::datastructures::GeolocationLocal) -> None

Construct a new Position object

3. __init__(self: themachinethatgoesping.navigation.datastructures.Geolocation, geolocation_utm: themachinethatgoesping::navigation::datastructures::GeolocationUTM) -> None

Construct a new Position object

4. __init__(self: themachinethatgoesping.navigation.datastructures.Geolocation, z: float = 0, yaw: float = 0, pitch: float = 0, roll: float = 0) -> None

Construct a new Geolocation object

Parameter z:

in m, positive downwards

Parameter yaw:

in °, 0° is north, 90° is east

Parameter pitch:

in °, positive means bow up

Parameter roll:

in °, positive means port up

copy(self: Geolocation) → Geolocation

return a copy using the c++ default copy constructor

static from_binary(buffer: bytes, check_buffer_is_read_completely: bool = True) → Geolocation

create T_CLASS object from bytearray

hash(self: Geolocation) → int

hash function implemented using binary_hash

info_string(self: Geolocation, float_precision: int = 2) → str

Return object information as string

property pitch

< in °, positive means bow up

print(self: Geolocation, float_precision: int = 2) → None

Print object information

property roll

< in °, positive means port up

slow_hash(self: Geolocation) → int

hash function implemented using slow_hash

to_binary(self: Geolocation, resize_buffer: bool = True) → bytes

convert object to bytearray

property yaw

< in °, 0° is north, 90° is east

property z

< in m, positive downwards