radar.utils.typing.units

Module Contents

Classes

Frequency

A class representing a frequency value with automatic unit conversion support.

Phase

A class representing an angular phase measurement.

Distance

A class representing a structural spatial distance or length measurement.

Data

Angle

Length

API

class radar.utils.typing.units.Frequency(frequency: float, unit: radar.utils.typing.FrequencyUnit)[source]

A class representing a frequency value with automatic unit conversion support.

Provides a clean interface for storing frequency data uniformly in Hertz and retrieving it in various scaled SI configurations.

Initialization

Initializes a Frequency instance.

Args:

frequency (float): The numeric frequency value. unit (FrequencyUnit): The unit configuration associated with the value.

property Hz: float

Returns the frequency value in Hertz (Hz).

property KHz: float

Returns the frequency value in Kilohertz (kHz).

property MHz: float

Returns the frequency value in Megahertz (MHz).

property GHz: float

Returns the frequency value in Gigahertz (GHz).

__eq__(other: object) → bool[source]

Evaluates equality based on the absolute value in Hertz.

__lt__(other: object) → bool[source]

Evaluates a less-than comparison based on the absolute value in Hertz.

class radar.utils.typing.units.Phase(phase: float, unit: radar.utils.typing.PhaseUnit)[source]

A class representing an angular phase measurement.

Standardizes tracking internally using Radians while offering intuitive properties for working with Degrees or Radians interchangeably.

Initialization

Initializes a Phase instance.

Args:

phase (float): The numeric magnitude of the phase. unit (PhaseUnit): The unit (Degree/Radian) defining the incoming parameter.

property deg: float

Returns the phase value scaled in Degrees.

property rad: float

Returns the phase value scaled in Radians.

__eq__(other: object) → bool[source]

Evaluates equality based on the absolute value in Radians.

__lt__(other: object) → bool[source]

Evaluates a less-than comparison based on the absolute value in Radians.

__hash__() → int[source]

Generates a unique hash index based on the internal Radian state value.

radar.utils.typing.units.Angle = None
class radar.utils.typing.units.Distance(value: float, unit: radar.utils.typing.DistanceUnit)[source]

A class representing a structural spatial distance or length measurement.

Maintains standard baseline properties in meters while dynamically exposing conversions for Metric and Imperial tracking frames.

Initialization

Initializes a Distance instance.

Args:

value (float): The numeric spatial distance measurement magnitude. unit (DistanceUnit): The measurement dimension framework type.

property m: float

Returns the distance length measured in Meters (m).

property km: float

Returns the distance length measured in Kilometers (km).

property miles: float

Returns the distance length measured in Miles (mi).

property ft: float

Returns the distance length measured in Feet (ft).

__eq__(other: object) → bool[source]

Evaluates distance equality based on absolute meters.

__lt__(other: object) → bool[source]

Evaluates a less-than comparison based on absolute meters.

__repr__() → str[source]

Generates a clean developer string interpretation showing distance in meters.

radar.utils.typing.units.Length = None