radar.utils.typing.constants

Module Contents

Classes

RadarConstants
DataHeader

API

class radar.utils.typing.constants.RadarConstants

c = 299792458

to_rad = None

to_deg = None

class radar.utils.typing.constants.DataHeader

AZIMUTH_RAD = 'az_rad'

AZIMUTH_DEG = 'az_deg'

ELEVATION_RAD = 'el_rad'

ELEVATION_DEG = 'el_deg'

BEAM_GAIN_DB = 'beam_gain_db'

BEAM_GAIN_LINEAR = 'beam_gain_lin'

X_POS_M = 'x_m'

Y_POS_M = 'y_m'

ANTENNA_FACTOR_DB = 'af_db'

ANTENNA_FACTOR_LINEAR = 'af_lin'

U = 'u'

V = 'v'

UV_MASK = 'uv_mask'

FREQ_GAIN_DB = 'freq_gain_db'

FREQ_GAIN_LINEAR = 'freq_gain_lin'

FREQ_FREQS = 'freq_freqs'

GEOM_AMP_GAIN_DB = 'Element Amplifier Gain (Decibel)'

GEOM_AMP_GAIN_LIN = 'Element Amplifier Gain (Linear)'

GEOM_PHASE_SHIFTER_PHASE_RAD = 'Element Phase Shifter Phase (Radian)'

GEOM_PHASE_SHIFTER_PHASE_DEG = 'Element Phase Shifter Phase (Degree)'

static direction_domain_headers(domain: radar.utils.typing.enums.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit) → tuple[str, str]

Maps domain configurations to their matching DataHeader string column keys.

Args:

domain (DirectionDomain): Target spatial domain (UV or Angular). phase_unit (PhaseUnit): Target configuration unit (Degree or Radian).

Returns:

tuple[str, str]: A pair of string header names corresponding to the horizontal (Azimuth/U) and vertical (Elevation/V) axes.

static _amplitude_domain_headers(domain: radar.utils.typing.enums.AmplitudeDomain, amplitude_unit: radar.utils.typing.enums.AmplitudeUnit) → str

Maps amplitude configurations to their matching DataHeader string column keys.

Args:

domain (AmplitudeDomain): Domain context (AntennaFactor vs Gain). amplitude_unit (AmplitudeUnit): Mathematical scale context (Decibel vs Linear).

Returns:

str: The exact DataFrame column name corresponding to the configured parameters.