PositionalOffsets

Simple structures to store sensor position offsets

Example usage

# import this module# import this module
from themachinethatgoesping.navigation.datastructures import PositionalOffsets

sensor_offsets = PositionalOffsets(
"sensor-name", # name of the sensor
10, # x (in m, positive forward)
-3, # y (in m, positive starboard)
3,  # z (in m, positive downwards)
10, # yaw    (in °, positive is clockwise rotation)
20, # pitch  (in °, positive is bow up)
30) # roll   (in °, positive is port up)

print(sensor_offsets)
# PositionalOffsets
# *****************
# - name:  "sensor-name"
# - x:     10.00 [positive forwards, m]
# - y:     -3.00 [positive starboard, m]
# - z:     3.00  [positive downwards, m]
# - yaw:   10.00 [° positive means clockwise rotation]
# - pitch: 20.00 [° positive means bow up]
# - roll:  30.00 [° positive means port up]

Structure api

class PositionalOffsets(*args, **kwargs)

A structure to store positional offsets (e.g. of a sensor) relative to the vessel coordinate system

__init__(self, name: str = '', x: float = 0.0, y: float = 0.0, z: float = 0.0, yaw: float = 0.0, pitch: float = 0.0, roll: float = 0.0) → None

Construct a new PositionalOffsets object

Parameters:

• name – The name of the sensor

• x – in m, positive forward

• y – in m, positive starboard

• z – in m, positive downwards

• yaw – positive means clockwise rotation

• pitch – in °, positive means bow up

• roll – in °, positive means port up

copy(self) → PositionalOffsets

return a copy using the c++ default copy constructor

from_binary = <nanobind.nb_func object>

from_txrx = <nanobind.nb_func object>

hash(self) → int

hash function implemented using binary_hash

info_string(self, float_precision: int = 3, superscript_exponents: bool = True) → str

Return object information as string

property name

The name of the sensor

property pitch

in °, positive means bow up

print(self, float_precision: int = 3, superscript_exponents: bool = True) → None

Print object information

property roll

in °, positive means port up

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

convert object to bytearray

property x

in m, positive forward

property y

in m, positive starboard

property yaw

in °, positive means clockwise rotation

property z

in m, positive downwards