kaira.constraints.utils.create_ofdm_constraints

kaira.constraints.utils.create_ofdm_constraints(total_power: float, max_papr: float = 6.0, is_complex: bool = True, peak_amplitude: float | None = None) → CompositeConstraint[source]

Create constraints commonly used in OFDM systems.

Configures a set of constraints suitable for Orthogonal Frequency Division Multiplexing (OFDM) signals. This includes a power constraint and a Peak-to-Average Power Ratio (PAPR) constraint to handle the high dynamic range typical of OFDM.

Parameters:

  • total_power (float) – Total power constraint value in linear units

  • max_papr (float, optional) – Maximum allowed PAPR in linear units (not dB). Defaults to 6.0 (approximately 7.8 dB).

  • is_complex (bool, optional) – Whether the signal is complex-valued. Defaults to True.

  • peak_amplitude (float, optional) – If provided, adds a peak amplitude constraint. Defaults to None.

Returns:

Combined OFDM constraints ready to be applied to signals

Return type:

CompositeConstraint

Example

>>> ofdm_constraints = create_ofdm_constraints(total_power=1.0, max_papr=4.0)
>>> constrained_signal = ofdm_constraints(input_signal)