Waypoint

Waypoint class for flight planning with position, altitude, heading, and speed.

class Waypoint

Bases: object

__init__(latitude, longitude, heading, altitude_msl=None, name=None, speed=None, delay=None, segment_type=None)

Initialize a Waypoint object.

Parameters:

• latitude (float) – Latitude in decimal degrees.

• longitude (float) – Longitude in decimal degrees.

• heading (float) – Heading in degrees relative to North.

• altitude_msl (Union[Quantity, float, None], optional) – Altitude MSL in meters or as a pint Quantity. Defaults to None.

• name (str, optional) – Name of the waypoint. Defaults to None.

• speed (Union[Quantity, float, None], optional) – Speed override in m/s or as a pint Quantity. Used for the departing leg. Defaults to None.

• delay (Union[Quantity, float, None], optional) – Loiter time at waypoint in seconds or as a pint Quantity. Defaults to None.

• segment_type (str, optional) – Segment type label for the departing leg (e.g. “pattern”, “sampling”). Used by compute_flight_plan. Defaults to None.

offset_north_east(offset_north, offset_east)

Return a new Waypoint translated by geodetic N/E offsets.

Parameters:

• offset_north (Union[Quantity, float]) – Distance north (positive) or south (negative). Float interpreted as meters; or a pint Quantity with length units.

• offset_east (Union[Quantity, float]) – Distance east (positive) or west (negative). Float interpreted as meters; or a pint Quantity with length units.

Return type:

Waypoint

Returns:

A new Waypoint at the translated position, preserving all other attributes.

to_dict()

Convert the waypoint to a dictionary representation.

The returned dict round-trips through Waypoint.from_dict() and includes every field accepted by __init__. Quantity-valued fields (altitude_msl, speed, delay) are returned as pint.Quantity instances; for JSON-friendly output the caller is responsible for serialization.

Returns:

Dictionary with all eight Waypoint fields:

latitude, longitude, heading, altitude_msl, name, speed, delay, segment_type.

Return type:

Dict

classmethod from_dict(data)

Reconstruct a Waypoint from a to_dict() dictionary.

Required keys are latitude, longitude, and heading. Optional keys (altitude_msl, name, speed, delay, segment_type) default to None if absent. This is the inverse of to_dict() and round-trips losslessly when the Quantity fields are preserved as pint.Quantity instances.

Parameters:

data (Dict) – Mapping produced by to_dict(), or a subset thereof.

Return type:

Waypoint

Returns:

A new Waypoint instance.

Helper functions

is_waypoint(obj)

Check if an object is a Waypoint (duck-type safe for notebook reloads).

Return type:

bool