yagi 0.1.3

Batteries-included DSP library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
use crate::error::{Error, Result};
use crate::dotprod::DotProd;
use crate::filter::{self, FirPfbFilter, FirFilterShape};
use crate::filter::iir::IirFilterSos;
use num_complex::ComplexFloat;


#[derive(Clone, Debug)]
pub struct Symsync<T> {
    k: usize,           // samples/symbol (input)
    k_out: usize,       // samples/symbol (output)

    npfb: usize,        // number of filters in symsync
    mf: FirPfbFilter<T, f32>, // matched filter
    dmf: FirPfbFilter<T, f32>,// derivative matched filter
    b: usize,           // filterbank index
    bf: f32,            // filterbank index (fractional)
    tau: f32,           // fractional sample offset
    tau_decim: f32,     // fractional sample offset (decimated)

    rate: f32,          // internal resampling rate
    del: f32,           // fractional delay step

    q: f32,             // timing error
    q_hat: f32,         // filtered timing error
    decim_counter: usize, // decimation counter
    pll: IirFilterSos<f32>, // loop filter
    rate_adjustment: f32, // rate adjustment factor
    is_locked: bool,    // synchronizer locked flag
}

impl<T> Symsync<T>
where
    T: Clone + Copy + ComplexFloat<Real = f32> + From<f32> + std::ops::Mul<f32, Output = T> + Default,
    [f32]: DotProd<T, Output = T>,
{
    pub fn new(k: usize, m: usize, h: &[f32], h_len: usize) -> Result<Self> {
        if k < 2 {
            return Err(Error::Config("samples/symbol must be at least 2".into()));
        }
        if m == 0 {
            return Err(Error::Config("number of filters must be greater than 0".into()));
        }
        if h_len == 0 {
            return Err(Error::Config("filter length must be greater than 0".into()));
        }
        if (h_len - 1) % m != 0 {
            return Err(Error::Config("filter length must be of the form: h_len = m*k + 1".into()));
        }

        // same as set_output_rate(1)
        let k_out = 1;
        let rate = k as f32 / k_out as f32;
        let del = rate;

        let npfb = m;

        let mut dh = vec![0.0f32; h_len];
        let mut hdh_max = 0.0;
        for i in 0..h_len {
            if i == 0 {
                dh[i] = h[i + 1] - h[h_len - 1];
            } else if i == h_len - 1 {
                dh[i] = h[0] - h[i - 1];
            } else {
                dh[i] = h[i + 1] - h[i - 1];
            }

            if (h[i] * dh[i]).abs() > hdh_max || i == 0 {
                hdh_max = (h[i] * dh[i]).abs();
            }
        }

        for i in 0..h_len {
            dh[i] *= 0.06f32 / hdh_max;
        }

        let mf = FirPfbFilter::new(npfb, h, h_len)?;
        let dmf = FirPfbFilter::new(npfb, &dh, h_len)?;

        let a_coeff = [1.0, 0.0, 0.0];
        let b_coeff = [0.0, 0.0, 0.0];
        let pll = IirFilterSos::new(&b_coeff, &a_coeff)?;

        let mut q = Self {
            k,
            k_out,
            npfb,
            mf,
            dmf,
            b: 0,
            bf: 0.0,
            tau: 0.0,
            tau_decim: 0.0,
            rate,
            del,
            q: 0.0,
            q_hat: 0.0,
            decim_counter: 0,
            pll,
            rate_adjustment: 0.0f32,
            is_locked: false,
        };

        q.reset();
        q.set_lf_bw(0.01f32)?;
        q.unlock();

        Ok(q)
    }

    pub fn new_rnyquist(ftype: FirFilterShape, k: usize, m: usize, beta: f32, num_filters: usize) -> Result<Self> {
        if k < 2 {
            return Err(Error::Config("samples/symbol must be at least 2".into()));
        }
        if m == 0 {
            return Err(Error::Config("filter delay must be greater than 0".into()));
        }
        if beta < 0.0 || beta > 1.0 {
            return Err(Error::Config("excess bandwidth factor must be in [0,1]".into()));
        }
        if num_filters == 0 {
            return Err(Error::Config("number of filters must be greater than 0".into()));
        }

        let h_len = 2 * num_filters * k * m + 1;

        let h = filter::fir_design_prototype(ftype, k * num_filters, m, beta, 0.0)?;

        Self::new(k, num_filters, &h, h_len)
    }

    pub fn new_kaiser(k: usize, m: usize, beta: f32, num_filters: usize) -> Result<Self> {
        if k < 2 {
            return Err(Error::Config("samples/symbol must be at least 2".into()));
        }
        if m == 0 {
            return Err(Error::Config("filter delay must be greater than 0".into()));
        }
        if beta <= 0.0 || beta > 1.0 {
            return Err(Error::Config("excess bandwidth factor must be in [0,1]".into()));
        }
        if num_filters == 0 {
            return Err(Error::Config("number of filters must be greater than 0".into()));
        }

        let h_len = 2 * num_filters * k * m + 1;

        let fc = 0.75f32;
        let as_ = 40.0f32;
        let mut h = filter::fir_design_kaiser(h_len, fc / (k as f32 * num_filters as f32), as_, 0.0)?;

        for c in h.iter_mut() {
            *c *= 2.0 * fc;
        }

        Self::new(k, num_filters, &h, h_len)
    }

    pub fn reset(&mut self) {
        self.mf.reset();
        self.rate = self.k as f32 / self.k_out as f32;
        self.del = self.rate;
        self.b = 0;
        self.bf = 0.0;
        self.tau = 0.0;
        self.tau_decim = 0.0;
        self.q = 0.0;
        self.q_hat = 0.0;
        self.decim_counter = 0;
        self.pll.reset();
    }

    pub fn lock(&mut self) {
        self.is_locked = true;
    }

    pub fn unlock(&mut self) {
        self.is_locked = false;
    }

    pub fn is_locked(&self) -> bool {
        self.is_locked
    }

    pub fn set_output_rate(&mut self, k_out: usize) -> Result<()> {
        if k_out == 0 {
            return Err(Error::Config("output rate must be greater than 0".into()));
        }
        self.k_out = k_out;
        self.rate = self.k as f32 / self.k_out as f32;
        self.del = self.rate;
        Ok(())
    }

    pub fn set_fractional_rate(&mut self, rate: f32) -> Result<()> {
        if rate <= 0.0 {
            return Err(Error::Config("rate must be greater than 0".into()));
        }
        self.rate = rate;
        self.del = self.rate;
        Ok(())
    }

    pub fn set_lf_bw(&mut self, _bandwidth: f32) -> Result<()> {
        if _bandwidth < 0.0 || _bandwidth > 1.0 {
            return Err(Error::Config("bandwidth must be in [0,1]".into()));
        }

        let alpha = 1.0 - _bandwidth;
        let beta = 0.22 * _bandwidth;
        let a = 0.5;
        let b = 0.495;

        let b_coeff = [beta, 0.0, 0.0];
        let a_coeff = [1.0 - a * alpha, -b * alpha, 0.0];

        self.pll.set_coefficients(&b_coeff, &a_coeff)?;

        self.rate_adjustment = 0.5 * _bandwidth;
        Ok(())
    }

    pub fn get_tau(&self) -> f32 {
        self.tau_decim
    }

    pub fn get_rate(&self) -> f32 {
        self.rate
    }

    pub fn get_del(&self) -> f32 {
        self.del
    }

    pub fn get_q(&self) -> f32 {
        self.q
    }

    pub fn get_q_hat(&self) -> f32 {
        self.q_hat
    }

    pub fn execute(&mut self, x: &[T], y: &mut [T]) -> Result<usize> {
        let mut ny = 0;

        for &xi in x.iter() {
            let k = self.step(xi, &mut y[ny..])?;
            ny += k;
        }

        Ok(ny)
    }

    fn step(&mut self, x: T, y: &mut [T]) -> Result<usize> {
        self.mf.push(x);
        self.dmf.push(x);

        let mut mf: T;
        let mut dmf: T;
        let mut ny = 0;

        while self.b < self.npfb {
            mf = self.mf.execute(self.b)?;
            y[ny] = mf / (self.k as f32).into();

            if self.decim_counter == self.k_out {
                self.decim_counter = 0;

                if self.is_locked {
                    continue;
                }

                dmf = self.dmf.execute(self.b)?;
                self.advance_internal_loop(mf, dmf);
                self.tau_decim = self.tau;
            }

            self.decim_counter += 1;
            self.tau += self.del;
            self.bf = self.tau * self.npfb as f32;
            self.b = self.bf.round() as usize;
            ny += 1;
        }

        self.tau -= 1.0;
        self.bf -= self.npfb as f32;
        self.b -= self.npfb;

        Ok(ny)
    }

    fn advance_internal_loop(&mut self, mf: T, dmf: T) {
        self.q = (mf.conj() * dmf).re();
        self.q = self.q.clamp(-1.0, 1.0);

        self.q_hat = self.pll.execute(self.q);

        self.rate += self.rate_adjustment * self.q_hat;
        self.del = self.rate + self.q_hat;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use test_macro::autotest_annotate;
    use num_complex::Complex32;
    use crate::sequence::MSequence;
    use crate::filter::FirInterpolationFilter;
    use crate::filter::resampler::resamp::Resamp;
    use crate::random::randnf;

    #[test]
    #[autotest_annotate(autotest_symsync_copy)]
    fn test_symsync_copy() {
        // create base object
        let mut q0 = Symsync::<Complex32>::new_rnyquist(
            FirFilterShape::Arkaiser,
            5,
            7,
            0.25,
            64
        ).unwrap();
        q0.set_lf_bw(0.02).unwrap();

        // run samples through filter
        // NOTE: we don't care that the input is noise; just that both objects
        //       produce the same output
        let buf_len = 640;
        let mut buf = vec![Complex32::new(0.0, 0.0); buf_len];
        let mut buf_0 = vec![Complex32::new(0.0, 0.0); buf_len];
        let mut buf_1 = vec![Complex32::new(0.0, 0.0); buf_len];

        for i in 0..buf_len {
            buf[i] = Complex32::new(randnf(), randnf());
        }

        let _nw_0 = q0.execute(&buf, &mut buf_0).unwrap();

        // copy object
        let mut q1 = q0.clone();

        // run samples through both filters and check equality
        for i in 0..buf_len {
            buf[i] = Complex32::new(randnf(), randnf());
        }

        let nw_0 = q0.execute(&buf, &mut buf_0).unwrap();
        let nw_1 = q1.execute(&buf, &mut buf_1).unwrap();

        // check that the same number of samples were written
        assert_eq!(nw_0, nw_1);

        // check output sample values
        assert_eq!(buf_0[..nw_0], buf_1[..nw_1]);

        // check other internal properties
        assert_eq!(q0.get_tau(), q1.get_tau());
    }

    // test errors and invalid configuration
    #[test]
    #[autotest_annotate(autotest_symsync_config)]
    fn test_symsync_config() {
        // test copying/creating invalid objects
        // assert!(Symsync::<Complex32>::copy(&None).is_err());

        assert!(Symsync::<Complex32>::new(0, 12, &[], 48).is_err()); // k is too small
        assert!(Symsync::<Complex32>::new(2, 0, &[], 48).is_err()); // M is too small
        assert!(Symsync::<Complex32>::new(2, 12, &[], 0).is_err()); // h_len is too small
        assert!(Symsync::<Complex32>::new(2, 12, &[], 47).is_err()); // h_len is not divisible by M

        assert!(Symsync::<Complex32>::new_rnyquist(FirFilterShape::Rrcos, 0, 12, 0.2, 48).is_err()); // k is too small
        assert!(Symsync::<Complex32>::new_rnyquist(FirFilterShape::Rrcos, 2, 0, 0.2, 48).is_err()); // m is too small
        assert!(Symsync::<Complex32>::new_rnyquist(FirFilterShape::Rrcos, 2, 12, 7.2, 48).is_err()); // beta is too large
        assert!(Symsync::<Complex32>::new_rnyquist(FirFilterShape::Rrcos, 2, 12, 0.2, 0).is_err()); // M is too small

        assert!(Symsync::<Complex32>::new_kaiser(0, 12, 0.2, 48).is_err()); // k is too small
        assert!(Symsync::<Complex32>::new_kaiser(2, 0, 0.2, 48).is_err()); // m is too small
        assert!(Symsync::<Complex32>::new_kaiser(2, 12, 7.2, 48).is_err()); // beta is too large
        assert!(Symsync::<Complex32>::new_kaiser(2, 12, 0.2, 0).is_err()); // M is too small

        // create valid object
        let mut q = Symsync::<Complex32>::new_kaiser(2, 12, 0.2, 48).unwrap();
        // assert!(q.print().is_ok());

        // check lock state
        q.lock();
        assert!(q.is_locked());
        q.unlock();
        assert!(!q.is_locked());

        // check invalid properties
        assert!(q.set_output_rate(0).is_err());
        assert!(q.set_lf_bw(-1.0).is_err());
    }

    fn symsync_crcf_test(method: &str, _k: usize, _m: usize, _beta: f32, _tau: f32, _rate: f32) {
        // options
        let tol: f32 = 0.2;    // error tolerance
        let k: usize = _k;      // samples/symbol (input)
        let m: usize = _m;      // filter delay (symbols)
        let beta: f32 = _beta;   // filter excess bandwidth factor
        let num_filters: usize = 32;       // number of filters in the bank

        let num_symbols_init: usize = 200;  // number of initial symbols
        let num_symbols_test: usize = 100;  // number of testing symbols

        // transmit filter type
        let ftype_tx = if method == "rnyquist" {
            FirFilterShape::Arkaiser
        } else {
            FirFilterShape::Kaiser
        };

        let bt: f32 = 0.02;               // loop filter bandwidth
        let mut tau: f32 = _tau;                // fractional symbol offset
        let rate: f32 = _rate;               // resampled rate

        // derived values
        let num_symbols = num_symbols_init + num_symbols_test;
        let num_samples = k * num_symbols;
        let num_samples_resamp = (num_samples as f32 * rate * 1.1).ceil() as u32 + 4;
        
        // compute delay
        while tau < 0.0 { tau += 1.0; }    // ensure positive tau
        let g = k as f32 * tau;                // number of samples offset
        let ds = g.floor() as i32;               // additional symbol delay
        let mut dt = g - ds as f32;     // fractional sample offset
        if dt > 0.5 {                // force dt to be in [0.5,0.5]
            dt -= 1.0;
        }

        // allocate arrays
        let mut s = vec![Complex32::new(0.0, 0.0); num_symbols as usize];       // data symbols
        let mut x = vec![Complex32::new(0.0, 0.0); num_samples as usize];       // interpolated samples
        let mut y = vec![Complex32::new(0.0, 0.0); num_samples_resamp as usize];// resampled data (resamp_crcf)
        let mut z = vec![Complex32::new(0.0, 0.0); num_symbols as usize + 64];  // synchronized symbols

        // generate pseudo-random QPSK symbols
        // NOTE: by using an m-sequence generator this sequence will be identical
        //       each time this test is run
        let mut ms = MSequence::create_default(10).unwrap();
        for i in 0..num_symbols as usize {
            let si = ms.generate_symbol(1);
            let sq = ms.generate_symbol(1);
            s[i] = Complex32::new(
                if si == 0 { 1.0 } else { -1.0 } * std::f32::consts::FRAC_1_SQRT_2,
                if sq == 0 { 1.0 } else { -1.0 } * std::f32::consts::FRAC_1_SQRT_2
            );
        }

        // 
        // create and run interpolator
        //

        // design interpolating filter
        let mut interp = FirInterpolationFilter::<Complex32>::new_prototype(ftype_tx, k as usize, m, beta, dt).unwrap();

        // interpolate block of samples
        interp.execute_block(&s[..num_symbols as usize], &mut x[..num_samples as usize]).unwrap();

        // 
        // run resampler
        //

        // create resampler
        let resamp_len = 10 * k; // resampling filter semi-length (filter delay)
        let resamp_bw = 0.45;        // resampling filter bandwidth
        let resamp_as = 60.0;        // resampling filter stop-band attenuation
        let resamp_npfb = 64;  // number of filters in bank
        let mut resamp = Resamp::<Complex32>::new(rate, resamp_len, resamp_bw, resamp_as, resamp_npfb).unwrap();

        // run resampler on block
        let ny = resamp.execute_block(&x[..num_samples as usize], &mut y[..]).unwrap();

        // 
        // create and run symbol synchronizer
        //

        // create symbol synchronizer
        let mut sync = if method == "rnyquist" {
            Symsync::<Complex32>::new_rnyquist(ftype_tx, k, m, beta, num_filters).unwrap()
        } else {
            Symsync::<Complex32>::new_kaiser(k, m, beta, num_filters).unwrap()
        };

        // set loop filter bandwidth
        sync.set_lf_bw(bt).unwrap();

        // execute on entire block of samples
        let nz = sync.execute(&y[..ny], &mut z).unwrap();

        // compute total delay through system
        // (initial filter + resampler + matched filter)
        let delay = m + 10 + m;

        // compare (and print) results
        for i in (nz - num_symbols_test as usize)..nz {
            // compute error
            let err = (z[i] - s[i - delay as usize]).norm();
            
            // assert that error is below tolerance
            assert!(err < tol, "Error {} exceeds tolerance {} at index {}", err, tol, i);
        }
    }

    // autotest scenarios (root-Nyquist)
    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_0)]
    fn symsync_crcf_scenario_0() { symsync_crcf_test("rnyquist", 2, 7, 0.35,  0.00, 1.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_1)]
    fn symsync_crcf_scenario_1() { symsync_crcf_test("rnyquist", 2, 7, 0.35, -0.25, 1.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_2)]
    fn symsync_crcf_scenario_2() { symsync_crcf_test("rnyquist", 2, 7, 0.35, -0.25, 1.0001 ); }

    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_3)]
    fn symsync_crcf_scenario_3() { symsync_crcf_test("rnyquist", 2, 7, 0.35, -0.25, 0.9999 ); }

    // autotest scenarios (Nyquist)
    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_4)]
    fn symsync_crcf_scenario_4() { symsync_crcf_test("nyquist", 2, 7, 0.35,  0.00, 1.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_5)]
    fn symsync_crcf_scenario_5() { symsync_crcf_test("nyquist", 2, 7, 0.35, -0.25, 1.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_6)]
    fn symsync_crcf_scenario_6() { symsync_crcf_test("nyquist", 2, 7, 0.35, -0.25, 1.0001 ); }

    #[test]
    #[autotest_annotate(autotest_symsync_crcf_scenario_7)]
    fn symsync_crcf_scenario_7() { symsync_crcf_test("nyquist", 2, 7, 0.35, -0.25, 0.9999 ); }

    fn symsync_rrrf_test(method: &str,
                         k: usize,
                         m: usize,
                         beta: f32,
                         tau: f32,
                         rate: f32,
                         expected_rate: f32)
    {
        // options
        let tol        = 0.20f32;   // error tolerance
        let num_filters= 32;       // number of filters in the bank

        let num_symbols_init = 400;  // number of initial symbols
        let num_symbols_test = 100;  // number of testing symbols

        // transmit filter type
        let ftype_tx = if method == "rnyquist" {
            FirFilterShape::Arkaiser
        } else {
            FirFilterShape::Kaiser
        };

        let bt    = 0.01f32;               // loop filter bandwidth
        let mut tau   = tau;                // fractional symbol offset
        let rate  = rate;               // resampled rate

        // derived values
        let num_symbols = num_symbols_init + num_symbols_test;
        let num_samples = k * num_symbols;
        let num_samples_resamp = (num_samples as f32 * rate * 1.1f32).ceil() as usize + 4;
        
        // compute delay
        while tau < 0.0 { tau += 1.0; }    // ensure positive tau
        let g = k as f32 * tau;                // number of samples offset
        let ds = g.floor() as i32;               // additional symbol delay
        let mut dt = g - ds as f32;     // fractional sample offset
        if dt > 0.5 {                // force dt to be in [0.5,0.5]
            dt -= 1.0;
        }

        // allocate arrays
        let mut s = vec![0.0f32; num_symbols];           // data symbols
        let mut x = vec![0.0f32; num_samples];           // interpolated samples
        let mut y = vec![0.0f32; num_samples_resamp];    // resampled data (resamp_rrrf)
        let mut z = vec![0.0f32; num_symbols + 64];      // synchronized symbols

        // generate pseudo-random BPSK symbols
        // NOTE: by using an m-sequence generator this sequence will be identical
        //       each time this test is run
        let mut ms = MSequence::create_default(10).unwrap();
        for i in 0..num_symbols {
            s[i] = if ms.generate_symbol(1) == 0 { 1.0 } else { -1.0 };
        }

        // 
        // create and run interpolator
        //

        // design interpolating filter
        let mut interp = FirInterpolationFilter::<f32>::new_prototype(ftype_tx, k as usize, m, beta, dt).unwrap();

        // interpolate block of samples
        interp.execute_block(&s[..num_symbols], &mut x).unwrap();

        // 
        // run resampler
        //

        // create resampler
        let resamp_len = 10 * k; // resampling filter semi-length (filter delay)
        let resamp_bw = 0.45f32;        // resampling filter bandwidth
        let resamp_as = 60.0f32;        // resampling filter stop-band attenuation
        let resamp_npfb = 64;  // number of filters in bank
        let mut resamp = Resamp::<f32>::new(rate, resamp_len, resamp_bw, resamp_as, resamp_npfb).unwrap();

        // run resampler on block
        let ny = resamp.execute_block(&x[..num_samples], &mut y).unwrap();

        // 
        // create and run symbol synchronizer
        //

        // create symbol synchronizer
        let mut sync = if method == "rnyquist" {
            Symsync::<f32>::new_rnyquist(ftype_tx, k, m, beta, num_filters).unwrap()
        } else {
            Symsync::<f32>::new_kaiser(k, m, beta, num_filters).unwrap()
        };

        // set loop filter bandwidth
        sync.set_lf_bw(bt).unwrap();

        // set fractional rate
        sync.set_fractional_rate(expected_rate).unwrap();

        // execute on entire block of samples
        let nz = sync.execute(&y[..ny], &mut z).unwrap();

        // compute total delay through system
        // (initial filter + resampler + matched filter)
        let delay = m + 10 + m;

        // compare (and print) results
        for i in (nz - num_symbols_test)..nz {
            // compute error
            let err = (z[i] - s[i - delay]).abs();
            
            // assert that error is below tolerance
            assert!(err < tol, "Error {} exceeds tolerance {}", err, tol);
        }
    }

    // autotest scenarios (root-Nyquist)
    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_0)]
    fn symsync_rrrf_scenario_0() { symsync_rrrf_test("rnyquist", 2, 7, 0.35,  0.00, 1.0, 2.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_1)]
    fn symsync_rrrf_scenario_1() { symsync_rrrf_test("rnyquist", 2, 7, 0.35, -0.25, 1.0, 2.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_2)]
    fn symsync_rrrf_scenario_2() { symsync_rrrf_test("rnyquist", 2, 7, 0.35, -0.25, 1.0001, 2.0 ); }

    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_3)]
    fn symsync_rrrf_scenario_3() { symsync_rrrf_test("rnyquist", 2, 7, 0.35, -0.25, 0.9999, 2.0 ); }

    // autotest scenarios (Nyquist)
    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_4)]
    fn symsync_rrrf_scenario_4() { symsync_rrrf_test("nyquist", 2, 7, 0.35,  0.00, 1.0, 2.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_5)]
    fn symsync_rrrf_scenario_5() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 1.0, 2.0    ); }

    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_6)]
    fn symsync_rrrf_scenario_6() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 1.0001, 2.0 ); }

    #[test]
    #[autotest_annotate(autotest_symsync_rrrf_scenario_7)]
    fn symsync_rrrf_scenario_7() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.9999, 2.0 ); }

    #[test]
    fn symsync_rrrf_scenario_8() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.998, 1.996 ); }

    #[test]
    fn symsync_rrrf_scenario_9() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.998, 1.994 ); }

    #[test]
    fn symsync_rrrf_scenario_10() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.998, 1.998 ); }

    #[test]
    fn symsync_rrrf_scenario_11() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.99, 1.98 ); }

    #[test]
    fn symsync_rrrf_scenario_12() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.99, 1.981 ); }

    #[test]
    fn symsync_rrrf_scenario_13() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.99, 1.979 ); }

    #[test]
    fn symsync_rrrf_scenario_14() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.98, 1.96 ); }

    #[test]
    fn symsync_rrrf_scenario_15() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.98, 1.962 ); }

    #[test]
    fn symsync_rrrf_scenario_16() { symsync_rrrf_test("nyquist", 2, 7, 0.35, -0.25, 0.98, 1.958 ); }
}