Struct pm_remez::PMParameters

pub struct PMParameters<T, D, W> { /* private fields */ }

Parks-McClellan design parameters struct.

This struct is one of the two ways (together with the pm_parameters function used with a list of BandSetting objects) in which the parameters to execute the Parks-McClellan algorithm can be designed. This struct specifies custom closures for the desired response and weight function, represented by the type parameters D and W. The type parameter T is the scalar type used for computation. Typically it should implement the Float and FloatConst traits.

Implementations

impl<T: Float, D, W> PMParameters<T, D, W>

pub fn new( num_taps: usize, bands: Vec<Band<T>>, desired_response: D, weights: W ) -> Result<Self>

Creates new design parameters for the Parks-McClellan algorithm.

The num_taps argument indicates the number of taps of the FIR filter. The bands argument is the list of sub-bands of the interval [0.0, 0.5] on which the maximum weighted error is minimized. The desired_response and weight arguments indicate the desired response and weight function of the filter. Typically these should be closures Fn(T) -> T.

Other parameters required for the Parks-McClellan algorithm are given default values and can be changed using the methods defined by the ParametersBuilder trait. By default, the symmetry of the FIR filter taps is set to even, and the other parameters that can be changed by this trait are given reasonable default values.

Trait Implementations

impl<T, D, W> DesignParameters<T> for PMParameters<T, D, W>

where T: Copy, D: Fn(T) -> T, W: Fn(T) -> T,

fn num_taps(&self) -> usize

Returns the number of taps.

fn bands(&self) -> &[Band<T>]

Returns the list of bands.

fn symmetry(&self) -> Symmetry

Returns the symmetry of the FIR filter taps.

fn desired_response(&self) -> impl Fn(T) -> T

Returns the desired response.

fn weights(&self) -> impl Fn(T) -> T

Returns the weight function.

fn chebyshev_proxy_degree(&self) -> usize

Returns the degree of the Chebyshev proxy that is used for Chebyshev proxy root finding.

fn max_iterations(&self) -> usize

Returns the maximum number of Remez exchange iterations to be performed by pm_remez.

fn flatness_threshold(&self) -> T

Returns the flatness threshold to be used to stop the Remez exchange before the maximum number of iterations is reached.

impl<T, D, W> ParametersBuilder<T> for PMParameters<T, D, W>

where T: Copy, D: Fn(T) -> T, W: Fn(T) -> T,

fn set_symmetry(&mut self, symmetry: Symmetry) -> &mut Self

Sets the symmetry of the FIR filter taps.

fn set_chebyshev_proxy_degree(&mut self, degree: usize) -> &mut Self

Returns the degree of the Chebyshev proxy that is used for Chebyshev proxy root finding.

fn set_max_iterations(&mut self, max_iterations: usize) -> &mut Self

Sets the maximum number of Remez exchange iterations to be performed by pm_remez.

fn set_flatness_threshold(&mut self, flatness_threshold: T) -> &mut Self

Returns the flatness threshold to be used to stop the Remez exchange before the maximum number of iterations is reached.