touchstone 0.13.3

Touchstone (s2p, etc.) file parser, plotter, and more
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
//! Edge case and error handling integration tests for the touchstone crate.

use touchstone::{Network, TouchstoneError};

// ============================================================
// 1-port file parsing
// ============================================================

#[test]
fn parse_s1p_hfss_oneport() {
    let ntwk = Network::new("files/hfss_oneport.s1p").unwrap();
    assert_eq!(ntwk.rank, 1);
    assert!(!ntwk.f.is_empty());
    assert_eq!(ntwk.frequency_unit, "GHz");
    assert_eq!(ntwk.format, "MA");
}

#[test]
fn parse_s1p_powerwave() {
    let ntwk = Network::new("files/hfss_oneport_powerwave.s1p").unwrap();
    assert_eq!(ntwk.rank, 1);
    assert!(!ntwk.f.is_empty());
}

#[test]
fn s1p_s_parameters_all_formats() {
    let ntwk = Network::new("files/hfss_oneport.s1p").unwrap();

    // Only S11 exists for 1-port
    let s11_db = ntwk.s_db(1, 1);
    let s11_ri = ntwk.s_ri(1, 1);
    let s11_ma = ntwk.s_ma(1, 1);

    assert_eq!(s11_db.len(), ntwk.f.len());
    assert_eq!(s11_ri.len(), ntwk.f.len());
    assert_eq!(s11_ma.len(), ntwk.f.len());

    for i in 0..s11_db.len() {
        assert!(s11_db[i].s_db.decibel().is_finite());
        assert!(s11_ri[i].s_ri.real().is_finite());
        assert!(s11_ma[i].s_ma.magnitude().is_finite());
    }
}

// ============================================================
// 4-port file parsing
// ============================================================

#[test]
fn parse_s4p_agilent() {
    let ntwk = Network::new("files/Agilent_E5071B.s4p").unwrap();
    assert_eq!(ntwk.rank, 4);
    assert!(!ntwk.f.is_empty());
    // This file uses Hz and dB format with 75 ohm impedance
    assert_eq!(ntwk.frequency_unit, "Hz");
    assert_eq!(ntwk.format, "DB");
    assert!((ntwk.z0 - 75.0).abs() < 0.01);
}

#[test]
fn parse_s4p_rs_znb8() {
    let ntwk = Network::new("files/RS_ZNB8.s4p").unwrap();
    assert_eq!(ntwk.rank, 4);
    assert!(!ntwk.f.is_empty());
}

#[test]
fn s4p_all_port_combinations() {
    let ntwk = Network::new("files/Agilent_E5071B.s4p").unwrap();

    // Access all 16 S-parameter combinations for a 4-port
    for j in 1..=4 {
        for k in 1..=4 {
            let s = ntwk.s_db(j, k);
            assert_eq!(s.len(), ntwk.f.len(), "S{}{} length mismatch", j, k);
            for point in &s {
                assert!(
                    point.s_db.decibel().is_finite(),
                    "S{}{} has non-finite dB",
                    j,
                    k
                );
                assert!(
                    point.s_db.angle().is_finite(),
                    "S{}{} has non-finite angle",
                    j,
                    k
                );
            }
        }
    }
}

// ============================================================
// Option line variations (different freq units, formats, impedances)
// ============================================================

#[test]
fn option_line_ghz_ma() {
    // hfss_oneport.s1p uses: # GHZ S MA
    let ntwk = Network::new("files/hfss_oneport.s1p").unwrap();
    assert_eq!(ntwk.frequency_unit, "GHz");
    assert_eq!(ntwk.format, "MA");
    assert!((ntwk.z0 - 50.0).abs() < 0.01);
}

#[test]
fn option_line_ghz_db() {
    // hfss_threeport_DB.s3p uses: # GHZ S DB
    let ntwk = Network::new("files/hfss_threeport_DB.s3p").unwrap();
    assert_eq!(ntwk.frequency_unit, "GHz");
    assert_eq!(ntwk.format, "DB");
}

#[test]
fn option_line_hz_db_75ohm() {
    // Agilent_E5071B.s4p uses: # Hz S dB R 75
    let ntwk = Network::new("files/Agilent_E5071B.s4p").unwrap();
    assert_eq!(ntwk.frequency_unit, "Hz");
    assert_eq!(ntwk.format, "DB");
    assert!((ntwk.z0 - 75.0).abs() < 0.01);
}

#[test]
fn option_line_50ohm_threeport_variants() {
    // Files with explicit 50 ohm
    let db50 = Network::new("files/hfss_threeport_DB_50Ohm.s3p").unwrap();
    let ma50 = Network::new("files/hfss_threeport_MA_50Ohm.s3p").unwrap();
    assert!((db50.z0 - 50.0).abs() < 0.01);
    assert!((ma50.z0 - 50.0).abs() < 0.01);
}

// ============================================================
// Network operations on real data
// ============================================================

#[test]
fn cascade_produces_valid_data() {
    let net1 = Network::new("files/ntwk1.s2p").unwrap();
    let net2 = Network::new("files/ntwk2.s2p").unwrap();
    let cascaded = net1.cascade(&net2);

    assert_eq!(cascaded.rank, 2);
    assert_eq!(cascaded.f.len(), net1.f.len());

    // All S-parameters should be finite
    for (j, k) in [(1, 1), (1, 2), (2, 1), (2, 2)] {
        for point in cascaded.s_db(j, k) {
            assert!(point.s_db.decibel().is_finite());
        }
    }
}

#[test]
fn cascade_matches_reference_file() {
    let net1 = Network::new("files/ntwk1.s2p").unwrap();
    let net2 = Network::new("files/ntwk2.s2p").unwrap();
    let cascaded = net1.cascade(&net2);
    let reference = Network::new("files/cascade_ntwk1_ntwk2.s2p").unwrap();

    assert_eq!(cascaded.f.len(), reference.f.len());

    // Compare S21 dB values within tolerance
    let cas_s21 = cascaded.s_db(2, 1);
    let ref_s21 = reference.s_db(2, 1);
    for i in 0..cas_s21.len() {
        let diff = (cas_s21[i].s_db.decibel() - ref_s21[i].s_db.decibel()).abs();
        assert!(
            diff < 0.5,
            "S21 dB mismatch at index {}: {} vs {} (diff {})",
            i,
            cas_s21[i].s_db.decibel(),
            ref_s21[i].s_db.decibel(),
            diff
        );
    }
}

#[test]
fn mul_trait_cascade() {
    let net1 = Network::new("files/ntwk1.s2p").unwrap();
    let expected_len = net1.f.len();
    let net2 = Network::new("files/ntwk2.s2p").unwrap();

    // Mul trait should also work
    let cascaded = net1 * net2;
    assert_eq!(cascaded.rank, 2);
    assert_eq!(cascaded.f.len(), expected_len);
}

#[test]
fn s_db_ri_ma_consistency() {
    // Verify that DB, RI, and MA representations are consistent for the same data
    let ntwk = Network::new("files/ntwk1.s2p").unwrap();

    let s11_db = ntwk.s_db(1, 1);
    let s11_ri = ntwk.s_ri(1, 1);
    let s11_ma = ntwk.s_ma(1, 1);

    for i in 0..s11_db.len() {
        // MA magnitude and DB magnitude should match
        let mag_from_ma = s11_ma[i].s_ma.magnitude();
        let mag_from_ri = s11_ri[i].s_ri.magnitude();
        let mag_from_db = s11_db[i].s_db.magnitude();

        assert!(
            (mag_from_ma - mag_from_ri).abs() < 1e-6,
            "MA vs RI magnitude mismatch at {}: {} vs {}",
            i,
            mag_from_ma,
            mag_from_ri
        );
        assert!(
            (mag_from_ma - mag_from_db).abs() < 1e-6,
            "MA vs DB magnitude mismatch at {}: {} vs {}",
            i,
            mag_from_ma,
            mag_from_db
        );

        // Angles should match
        let angle_from_ma = s11_ma[i].s_ma.angle();
        let angle_from_ri = s11_ri[i].s_ri.angle();
        let angle_from_db = s11_db[i].s_db.angle();

        assert!(
            (angle_from_ma - angle_from_ri).abs() < 1e-4,
            "MA vs RI angle mismatch at {}: {} vs {}",
            i,
            angle_from_ma,
            angle_from_ri
        );
        assert!(
            (angle_from_ma - angle_from_db).abs() < 1e-4,
            "MA vs DB angle mismatch at {}: {} vs {}",
            i,
            angle_from_ma,
            angle_from_db
        );
    }
}

// ============================================================
// Error cases
// ============================================================

#[test]
fn nonexistent_file_returns_error() {
    let error = Network::new("files/does_not_exist.s2p").unwrap_err();

    assert!(matches!(error, TouchstoneError::Io(_)));
}

#[test]
fn invalid_extension_returns_error() {
    let path = std::env::temp_dir().join("touchstone_invalid_extension.txt");
    std::fs::write(
        &path,
        "# GHz S RI R 50\n1.0 0.1 0.0 4.0 0.0 0.01 0.0 0.2 0.0\n",
    )
    .unwrap();

    let error = Network::new(&path).unwrap_err();
    std::fs::remove_file(path).unwrap();

    assert!(matches!(
        error,
        TouchstoneError::UnsupportedFileType { file_type } if file_type == "txt"
    ));
}

// ============================================================
// Round-trip: parse → save → re-parse
// ============================================================

#[test]
fn round_trip_s2p() {
    let original = Network::new("files/ntwk1.s2p").unwrap();
    let tmp = "files/test_round_trip_edge.s2p";

    original.save(tmp).unwrap();
    let reloaded = Network::new(tmp).unwrap();

    assert_eq!(original.rank, reloaded.rank);
    assert_eq!(original.f.len(), reloaded.f.len());
    assert!((original.z0 - reloaded.z0).abs() < 0.01);

    // Compare frequencies
    for i in 0..original.f.len() {
        let freq_diff = (original.f[i] - reloaded.f[i]).abs();
        assert!(
            freq_diff < 1e-3,
            "Frequency mismatch at {}: {} vs {}",
            i,
            original.f[i],
            reloaded.f[i]
        );
    }

    // Compare all S-parameters
    for (j, k) in [(1, 1), (1, 2), (2, 1), (2, 2)] {
        let orig_s = original.s_ri(j, k);
        let reload_s = reloaded.s_ri(j, k);
        for i in 0..orig_s.len() {
            let real_diff = (orig_s[i].s_ri.real() - reload_s[i].s_ri.real()).abs();
            let imag_diff = (orig_s[i].s_ri.imaginary() - reload_s[i].s_ri.imaginary()).abs();
            assert!(real_diff < 1e-4, "S{}{} real mismatch at {}", j, k, i);
            assert!(imag_diff < 1e-4, "S{}{} imag mismatch at {}", j, k, i);
        }
    }

    std::fs::remove_file(tmp).unwrap();
}

#[test]
fn round_trip_s3p() {
    let original = Network::new("files/hfss_threeport_DB.s3p").unwrap();
    let tmp = "files/test_round_trip_s3p.s3p";

    original.save(tmp).unwrap();
    let reloaded = Network::new(tmp).unwrap();

    assert_eq!(original.rank, reloaded.rank);
    assert_eq!(original.f.len(), reloaded.f.len());

    // Spot check S11
    let orig_s11 = original.s_db(1, 1);
    let reload_s11 = reloaded.s_db(1, 1);
    for i in 0..orig_s11.len() {
        let db_diff = (orig_s11[i].s_db.decibel() - reload_s11[i].s_db.decibel()).abs();
        assert!(
            db_diff < 0.1,
            "S11 dB round-trip mismatch at {}: {} vs {}",
            i,
            orig_s11[i].s_db.decibel(),
            reload_s11[i].s_db.decibel()
        );
    }

    std::fs::remove_file(tmp).unwrap();
}

#[test]
fn round_trip_preserves_cascade_result() {
    let net1 = Network::new("files/ntwk1.s2p").unwrap();
    let net2 = Network::new("files/ntwk2.s2p").unwrap();
    let cascaded = net1.cascade(&net2);

    let tmp = "files/test_round_trip_cascade.s2p";
    cascaded.save(tmp).unwrap();
    let reloaded = Network::new(tmp).unwrap();

    assert_eq!(cascaded.f.len(), reloaded.f.len());

    let cas_s21 = cascaded.s_ri(2, 1);
    let rel_s21 = reloaded.s_ri(2, 1);
    for i in 0..cas_s21.len() {
        let real_diff = (cas_s21[i].s_ri.real() - rel_s21[i].s_ri.real()).abs();
        assert!(
            real_diff < 1e-4,
            "Cascade round-trip real mismatch at {}",
            i
        );
    }

    std::fs::remove_file(tmp).unwrap();
}

// ============================================================
// Large port count
// ============================================================

#[test]
fn parse_s32p() {
    let ntwk = Network::new("files/ntwk.s32p").unwrap();
    assert_eq!(ntwk.rank, 32);
    assert!(!ntwk.f.is_empty());
}

#[test]
fn parse_s8p() {
    let ntwk = Network::new("files/hfss_19.2.s8p").unwrap();
    assert_eq!(ntwk.rank, 8);
    assert!(!ntwk.f.is_empty());
}

#[test]
fn parse_s10p() {
    let ntwk = Network::new("files/hfss_19.2.s10p").unwrap();
    assert_eq!(ntwk.rank, 10);
    assert!(!ntwk.f.is_empty());
}

// ============================================================
// Various vendor file formats
// ============================================================

#[test]
fn parse_all_threeport_variants() {
    let files = [
        "files/hfss_threeport_DB.s3p",
        "files/hfss_threeport_DB_50Ohm.s3p",
        "files/hfss_threeport_MA.s3p",
        "files/hfss_threeport_MA_50Ohm.s3p",
        "files/hfss_threeport_MA_without_gamma_z0_50Ohm.s3p",
    ];

    for file in files {
        let ntwk = Network::new(file).unwrap();
        assert_eq!(ntwk.rank, 3, "Wrong rank for {}", file);
        assert!(!ntwk.f.is_empty(), "No frequencies for {}", file);
    }
}