Objective¶

class fird.objective.FunctionLinearObjective(bounds: Sequence[float], function: Callable[[float], tuple[float, float]] | Callable[[float], float], points: Sequence[int] | int | None = None)¶

Bases: LinearObjective

plot(ax: Axes, frequency_scale: float = 3.141592653589793, zero_phase: bool = False, desired_line: str | None = 'g', plot_db: bool = False, plot_range: bool = False, **kwargs) → None¶

Plot desired values and objective frequency ranges in Matplotlib Axes.

Parameters:

axAxes: The Axes to plot in.
frequency_scalefloat, default: pi: Multiply the frequency values (normalized 0 to 1) when plotting.
zero_phasebool, default: False: If plotting the zero-phase magnitude response, i.e., the magnitude can take on negative values, set this to True.
desired_linestr or None, default: ‘g’: Matplotlib line definition string for the desired values. Set to None to not plot desired line.
plot_dbbool, default: False: If True, plot \(20\log_{10}\) of the desired values.
plot_rangebool, default: False: Mark where the objective is active.
**kwargsdict: Additional keyword arguments passed to Matplotlib plot().

Bases: Objective

Base class for any linear objective.

A linear objective is based on constraints of the form

\[\begin{split}\begin{array}{ll} \mathrm{minimize} & \delta \\ \mathrm{subject\ to} & W(\omega)\left|H_R(\omega) - D(\omega)\right| \leq \delta \end{array}\end{split}\]

where \(H_R(\omega)\) is the zero-phase magnitude response.

The values are represented as arrays with frequencies \(= \omega\), desired_values \(= D(\omega)\), and weights \(= W(\omega)\).

Parameters:

frequencies1D array-like: Array of frequencies to form constraints for.
desired_values1D array-like: Array of desired values at frequencies.
weights1D array-like: Array of weights at frequencies.