-
Notifications
You must be signed in to change notification settings - Fork 0
/
BBGuiHandler.js
696 lines (532 loc) · 19.3 KB
/
BBGuiHandler.js
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
/* Birdcage Builder
*
* GUI Handler
*
* Doug Brantner
* 27 April 2023
* NYU Langone Health
* cai2r.net
*
* Based on Android implementation of BirdcageBuilder by Giuseppe Carluccio & Christopher Collins.
*/
// v0.0.2 - Testing Class based functionality separated from GUI handling (2 files)
// Anything related to HTML/DOM/GUI id's, input/output, or anything else should happen HERE
// All other code should be completely agnostic of GUI
/* Debug & Other Settings */
// these are declared in debug.js w/ defaults but override here:
DEBUG_ENABLE = true; // bool; enable or disable debug printing to DOM
DEBUG_OUTPUT = 'CONSOLE'; // set to CONSOLE only for production; BOTH or DOM for testing is ok
DEBUG_ID = 'debug1'; // DOM ID for debug output (not used in production)
ROUND_OUTPUT = true; // true/false - round displayed output or not
ROUND_N_DIGITS = 4; // number of decimal places to round to (if ROUND_OUTPUT is true)
PLOTLY_ENABLE = false;
/* Internal Globals (do not edit these) */
FIRST_RUN = true; // set to false after first time "calculate" is called.
RESULTS_STALE = false; // set to true if user input changes & reset to false when "Calculate" is called.
/********************
* MAIN FUNCTIONS *
********************/
//debug('BBGuiHandler loaded.');
function calculate() {
reset_output_table("--"); // clear old results (if any)
if (!document.getElementById("main_form").reportValidity()) {
//if (!document.getElementById("main_form").checkValidity()) {
// display error and skip calculations
document.getElementById("input_error_div").innerHTML = "Warning: Invalid input - please check inputs and try again.";
console.log("Input Error; Skipping calculation");
return;
}
else {
// clear error, if any, and proceed
document.getElementById("input_error_div").innerHTML = "";
}
BB = get_gui_args();
cap = BB.calc_capacitor();
debug("n_legs = " + BB.n_legs);
// convert units for final output:
// TODO make unit conversion functions
var disp_leg_self_ind = 1e9 * BB.legs.leg_self_inductance;
var disp_er_self_ind = 1e9 * BB.endrings.er_self_inductance;
var disp_leg_mut_ind = 1e9 * BB.legs.leg_mutual_inductance;
var disp_er_mut_ind = 1e9 * BB.endrings.er_mutual_inductance[BB.n_legs/4];
var disp_calc_cap = 1e12 * cap;
// print full precision to console before rounding
debug('Leg Self Inductance (H?): ' + disp_leg_self_ind );
debug('EndRing Self Inductance (H?): ' + disp_er_self_ind );
debug('Leg Mutual Inductance (H?): ' + disp_leg_mut_ind );
debug('EndRing Mutual Inductance (H?): ' + disp_er_mut_ind );
debug('Calculated Capacitance (F?): ' + disp_calc_cap );
debug(''); // keep a blank line at the end
if (ROUND_OUTPUT) {
// NOTE: this also converts numbers to STRINGS:
disp_leg_self_ind = disp_leg_self_ind.toFixed(ROUND_N_DIGITS);
disp_er_self_ind = disp_er_self_ind.toFixed(ROUND_N_DIGITS);
disp_leg_mut_ind = disp_leg_mut_ind.toFixed(ROUND_N_DIGITS);
disp_er_mut_ind = disp_er_mut_ind.toFixed(ROUND_N_DIGITS);
disp_calc_cap = disp_calc_cap.toFixed(ROUND_N_DIGITS);
}
// fill in Results table:
// REMOVED IN v0.0.8 - Only displaying final capacitor results for now
// KEEP THIS FOR DEBUGGING!!!
//document.getElementById("leg_si").innerHTML = disp_leg_self_ind;
//document.getElementById("er_si").innerHTML = disp_er_self_ind;
//document.getElementById("leg_mi").innerHTML = disp_leg_mut_ind;
//document.getElementById("er_mi").innerHTML = disp_er_mut_ind;
document.getElementById("calc_cap").innerHTML = disp_calc_cap;
clear_results_stale();
FIRST_RUN = false;
//document.getElementById("leg_si").innerHTML = 1e9 * BB.legs.leg_self_inductance;
//document.getElementById("er_si").innerHTML = 1e9 * BB.endrings.er_self_inductance;
//document.getElementById("leg_mi").innerHTML = 1e9 * BB.legs.leg_mutual_inductance;
//document.getElementById("er_mi").innerHTML = 1e9 * BB.endrings.er_mutual_inductance[BB.n_legs/4];
//document.getElementById("calc_cap").innerHTML = 1e12 * cap;
// Plots
if (PLOTLY_ENABLE) {
try {
plotly_leg_currents(BB.legs, 'plotly_ILegs');
plotly_cross_section(BB.legs, 'plotly_crossSection');
plotly_endring_currents(BB.legs, BB.endrings, 'plotly_Iendrings');
plotly_leg_inductance(BB.legs, 'plotly_leg_inductance');
}
catch ({name, message}) {
console.warn('Exception in BBGuihandler plotting');
console.log('(probably plotly is not available)');
console.log(name);
console.log(message);
}
}
}
function get_gui_args() {
/* Parse DOM and populate BirdcageBuilder object (including Leg and Endring child objects)
*
* Returns populated BB object.
*/
// TODO var or let?
var n_legs = Number(document.getElementById('num_legs').value);
var freq = Number(document.getElementById('center_freq').value);
var r_coil = Number(document.getElementById('coil_radius').value);
var r_shield = Number(document.getElementById('shield_radius').value);
var leg_length = Number(document.getElementById('leg_len').value);
var leg_width = Number(document.getElementById('leg_width').value);
var leg_r_inner = Number(document.getElementById('leg_ID').value);
var leg_r_outer = Number(document.getElementById('leg_OD').value);
var endring_width = Number(document.getElementById('er_width').value);
var endring_r_inner = Number(document.getElementById('er_ID').value);
var endring_r_outer = Number(document.getElementById('er_OD').value);
var predcap = Number(document.getElementById('bp_predcap').value);
var coil_config = get_coil_config();
var leg_geom = get_leg_geom();
var endring_geom = get_endring_geom();
debug('coil_config: ' + coil_config);
debug('leg_geom: ' + leg_geom);
debug('endring_geom: ' + endring_geom);
// convert units (BCJ.MA)
freq = mhz2hz(freq);
r_coil = cm2meters(r_coil);
r_shield = cm2meters(r_shield);
leg_length = cm2meters(leg_length);
leg_width = cm2meters(leg_width);
leg_r_inner = cm2meters(leg_r_inner); // inner radius of tubular leg
leg_r_outer = cm2meters(leg_r_outer); // outer radius of tubular leg
endring_width = cm2meters(endring_width);
endring_r_inner = cm2meters(endring_r_inner);
endring_r_outer = cm2meters(endring_r_outer);
predcap *= 1e-12; // TODO make this a function
bb = new BirdcageBuilder(n_legs, freq, r_coil, r_shield, coil_config);
debug(bb.to_string());
// TODO change to ===?
if (leg_geom == 'rect') {
bb.legs.set_legs_rect(leg_length, leg_width);
//console.log("leg_length: " + leg_length);
//console.log("leg_width: " + leg_width);
}
else if (leg_geom == 'tube') {
bb.legs.set_legs_tube(leg_length, leg_r_inner, leg_r_outer);
//console.log("leg_length: " + leg_length);
//console.log("leg_r_inner: " + leg_r_inner);
//console.log("leg_r_outer: " + leg_r_outer);
}
else {
console.warning('BBGuiHandler: invalid leg_geom');
}
if (endring_geom == 'rect') {
bb.endrings.set_endrings_rect(endring_width);
}
else if (endring_geom == 'tube') {
bb.endrings.set_endrings_tube(endring_r_inner, endring_r_outer);
}
else {
console.warning('BBGuiHandler: invalid endring_geom');
}
// TODO make another 'finish_setup' function in BB that does this (abstract from user?)
bb.endrings.calc_er_mutual_inductance(bb.legs);
if (coil_config == 'bandpass_leg' || coil_config == 'bandpass_er') {
bb.predcap = predcap;
}
return bb;
}
/* Input Validation (Client Side in HTML form only)
* All "simple" input validation should be done in pure HTML (ie. min value for field)
* These are for the more complex/interdependent input checks only.
*/
function validate_shield_radius() {
/* this should be called onChange for shield_radius and probably also coil_radius (TODO)
*
* Make sure that the constraints are satisfied:
* - The coil radius must be positive and nonzero (currently done in pure HTML, not here)
* - The shield radius can EITHER be zero OR it must be greater than the coil radius otherwise.
*
* This is very similar to the inner/outer diamter constraint for the Tube legs/endrings
* BUT the logic is slightly different.
*
* Sets the shield_radius status to invalid if false;
* TODO currently not changing the coil_radius valid status because that's handled by pure HTML; but the popup error message should be clear.
*/
var sr_field = document.getElementById("shield_radius");
var sr = Number(sr_field.value);
var cr = Number(document.getElementById("coil_radius").value);
// TODO == or ===?
// TODO relies on coil radius to enforce positive value... revisit logic
// there may be a Firefox but with setCustomValidity - see:
// https://stackoverflow.com/questions/7357192/how-to-clear-remove-or-reset-html5-form-validation-state-after-setcustomvalid
// https://stackoverflow.com/questions/24191482/setcustomvalidity-will-not-reset-after-triggering
if (sr === 0 || sr > cr) {
sr_field.setCustomValidity(''); // empty string -> valid
}
else {
// non-empty string sets field as invalid
sr_field.setCustomValidity("Shield Radius must be greater than Coil Radius (or 0 for no shield).");
}
//sr_field.reportValidity(); // TODO not sure if this is needed; see https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/setCustomValidity
mark_results_stale();
}
function validate_tube_outer_diam(id_field, od_field) {
/* Generic function to make sure outer diamter is > inner diameter
* Inner Diamter should be verified as >= 0 in pure HTML; this assumes that's already done & valid.
* Called by the HTML form onChange function for the tube ID & OD inputs (leg/endring)
* Only the outer diamter field is checked here & its validity status is manipulated here.
*
*
* id_field = the HTML ID of the inner diameter field (string)
* Not checked or manipulated, only used to validate outer diamter.
*
* od_field = the HTML ID of the outer diameter field (string)
* of the OD field, so you can just pass "this" for convenience.
*
*
* Sets the validity status of the outer diamter field that's passed in.
*/
id = Number(document.getElementById(id_field).value);
od_dom = document.getElementById(od_field);
od = Number(od_dom.value);
if (od > id) {
od_dom.setCustomValidity(''); // everything ok
}
else {
od_dom.setCustomValidity('Outer Diameter must be greater than Inner Diameter');
}
mark_results_stale();
}
/* Input Parsing/Getting User Inputs from GUI */
function get_coil_config() {
/* Return the value (str) of the Coil Config Radio Buttons
* (Hi/Low/Bandpass)
*/
if (document.getElementById('config_lp').checked) {
return 'lowpass';
}
else if (document.getElementById('config_hp').checked) {
return 'highpass';
}
else if (document.getElementById('config_bp_leg').checked) {
return 'bandpass_leg';
}
else if (document.getElementById('config_bp_er').checked) {
return 'bandpass_er';
}
else {
return 'INVALID';
}
}
function get_leg_geom() {
/* Get Leg Geometry Type
*
* Returns string.
*/
if (document.getElementById('leg_rect').checked) {
return 'rect';
}
else if (document.getElementById('leg_tube').checked) {
return 'tube';
}
else {
return 'INVALID';
}
}
function get_endring_geom() {
/* Get Endring Geometry Type
*
* Returns string.
*/
if (document.getElementById('er_rect').checked) {
return 'rect';
}
else if (document.getElementById('er_tube').checked) {
return 'tube';
}
else {
return 'INVALID';
}
}
/* Input Handling/GUI Updates */
function mark_results_stale() {
/* Call this any time an input is changed.
* Sets a global flag to show that the displayed results, if any, are possibly expired
* due to new user input/changing an input value.
*
* This flag should be cleared when "Calculate" is called as the results should now
* correctly reflect the new inputs
*/
RESULTS_STALE = true;
if (!FIRST_RUN) {
// update GUI w/ literal red flag that output is stale (but not on the first run)
document.getElementById("stale_div").innerHTML = "Warning: Inputs changed from last run - click 'Calculate' again to update.";
}
}
function clear_results_stale() {
/* Call this when "Calculate" is called & results are properly updated.
* see mark_results_stale() for details
*/
RESULTS_STALE = false;
document.getElementById("stale_div").innerHTML = "";
}
/* update form inputs for rectangular/tube legs & endrings
* Just gray out/disable & enable the appropriate input fields
*/
function update_leg_geom_inputs(radiobtn) {
// Enable/disable leg width/inner/outer diameter inputs based on radio button state
if (radiobtn.value === "leg_rect") {
document.getElementById("leg_ID").disabled = true;
document.getElementById("leg_OD").disabled = true;
document.getElementById("leg_width").disabled = false;
}
else if (radiobtn.value === "leg_tube") {
document.getElementById("leg_ID").disabled = false;
document.getElementById("leg_OD").disabled = false;
document.getElementById("leg_width").disabled = true;
}
else {
debug("BBGuiHandler update_leg_geom_inputs: invalid leg type input");
}
mark_results_stale();
}
function update_er_geom_inputs(radiobtn) {
// Enable/disable endring width/inner/outer diameter inputs based on radio button state
if (radiobtn.value === "er_rect") {
document.getElementById("er_ID").disabled = true;
document.getElementById("er_OD").disabled = true;
document.getElementById("er_width").disabled = false;
}
else if (radiobtn.value === "er_tube") {
document.getElementById("er_ID").disabled = false;
document.getElementById("er_OD").disabled = false;
document.getElementById("er_width").disabled = true;
}
else {
debug("BBGuiHandler update_er_geom_inputs: invalid er type input");
}
mark_results_stale();
}
function update_coil_config(radiobtn) {
// Enable/disable predefined capacitor field based on coil config radio button state
if (radiobtn.value === "lowpass" || radiobtn.value === "highpass") {
document.getElementById("bp_predcap").disabled = true;
}
else if (radiobtn.value === "bandpass_leg" || radiobtn.value === "bandpass_er") {
document.getElementById("bp_predcap").disabled = false;
// TODO - add input validation here? so it only turns red if/after bandpass is selected?
// OR TODO can 'disabled' CSS take precedence over input validation error CSS?
}
mark_results_stale();
}
function append_main_output(s) {
/* Append a string to the output_main DOM paragraph.
* Adds a <br> at the end.
*/
document.getElementById('output_main').innerHTML += s + '<br>';
}
function output_clear() {
/* Clear the (deprecated) output field */
document.getElementById('output_main').innerHTML = '';
}
function reset_output_table(s) {
/* Reset output in new twble format
* (just writes the same string to all output fields in table)
*
* s = string to overwrite table data with
*
* */
// REMOVED IN v0.0.8 - Only displaying final capacitor results for now
// KEEP THIS FOR DEBUGGING!!!
//document.getElementById("leg_si").innerHTML = s;
//document.getElementById("er_si").innerHTML = s;
//document.getElementById("leg_mi").innerHTML = s;
//document.getElementById("er_mi").innerHTML = s;
document.getElementById("calc_cap").innerHTML = s;
}
/*** Plotly Plots ***/
function circle(r) {
/* Return an x, y array of a circle of points with radius r.
*
* TODO - input # of points etc.
*
*/
var n = 100; // # of points
const x = new Array(n);
const y = new Array(n);
var i, theta;
for (i = 0; i < n; i++) {
theta = i*2*Math.PI/n;
x[i] = r*Math.cos(theta);
y[i] = r*Math.sin(theta);
}
return [x, y];
}
function plotly_cross_section(legs, div) {
/* Plot leg & shield cross section (leg x,y positions)
*
*/
legs_gt = circle(legs.r_coil);
shield_gt = circle(legs.r_shield);
var data = [{x: legs.leg_x,
y: legs.leg_y,
mode: "lines+markers",
name: "Leg Positions"
},
{x: legs.shield_x,
y: legs.shield_y,
mode: "lines+markers",
name: "Shield Image Positions"
},
{x: legs_gt[0],
y: legs_gt[1],
mode: "lines",
//marker: {color: 'black'},
line: {color: 'gray',
dash: "dot"
},
name: "Expected Coil Radius"
},
{x: shield_gt[0],
y: shield_gt[1],
mode: "lines",
//marker: {color: 'black'},
line: {color: 'gray',
dash: "dash"
},
name: "Shield Radius (E-field should be 0 here)"
},
// TODO label rungs w/ index
//{x: [0, legs.leg_x[0]], // draw a line to first rung (k=0)
// y: [0, legs.leg_y[0]],
// mode: "lines",
// name: "Leg 0"
//}
];
var layout = {xaxis: {title: "X Position (m?)"},
yaxis: {title: "Y Position (m?)", scaleanchor: "x", scaleratio: 1.0},
title: "Leg & Shield Positions (n=" + legs.n_legs + ")"
};
Plotly.newPlot(div, data, layout);
}
function plotly_leg_currents(legs, div) {
/* Plot Leg Currents vs. leg angle
*
* legs = fully populated BCLegs object
* div = string, name of the HTML div to plot in
*
* See https://www.w3schools.com/js/tryit.asp?filename=tryai_plotly_scatter
*/
var data = [{x: legs.theta,
y: legs.leg_currents,
mode: "lines+markers",
name: "Leg Currents"
},
{x: legs.theta,
y: legs.shield_currents,
mode: "lines+markers",
name: "Shield Currents"
}
];
var layout = {xaxis: {title: "Angle (rad)"},
yaxis: {title: "Current (A?)"},
title: "Leg & Shield Currents (n=" + legs.n_legs + ")"
};
Plotly.newPlot(div, data, layout);
}
function plotly_endring_currents(legs, er, div) {
/* Plot endring currents & mutual inductance
*
* legs = BCLegs object, fully populated (for angles)
* er = BCEndrings object, fully populated
* div = string div id for the plot
*
*/
// TODO - do we need to offset the endring segments by 1/2 arclen (1/2 theta step) for correct visualizatin?
var data = [{x: legs.theta,
y: er.er_currents,
mode: "lines+markers",
name: "EndRing Currents"
},
{x: legs.theta,
y: er.er_mutual_inductance,
yaxis:"y2",
mode: "lines+markers",
name: "EndRing Mutual Inductance"
}
];
var layout = {xaxis: {title: "Angle (rad)"},
yaxis: {title: "Current (A?)"}, // TODO inductance
yaxis2: {title: "Inductance (H?)",
titlefont: {color: 'rgb(148, 103, 189)'},
tickfont: {color: 'rgb(148, 103, 189)'},
overlaying: 'y',
side: 'right'
},
title: "EndRing Currents TBD (n=" + legs.n_legs + ")"
};
// TODO adjust overlapping legend & 2nd yaxis
Plotly.newPlot(div, data, layout);
}
function plotly_leg_inductance(legs, div) {
/* Plot each component of the leg & shield mutual inductance
* (using specially stored arrays, of each part of the summation)
*
* legs = fully populated BCLegs with extra inductance arrays
* div = HTML div name
*
*/
var data = [{x: legs.theta,
y: legs._leg_mutual_inductances,
mode: "lines+markers",
name: "Leg Mutual Inductance"
},
{x: legs.theta,
y: legs._shield_mutual_inductances,
//yaxis:"y2",
mode: "lines+markers",
name: "Shield Mutual Inductance"
}
];
var layout = {xaxis: {title: "Angle (rad)"},
yaxis: {title: "Inductance (H?)"}, // TODO inductance
// yaxis2: {title: "Inductance (H?)",
// titlefont: {color: 'rgb(148, 103, 189)'},
// tickfont: {color: 'rgb(148, 103, 189)'},
// overlaying: 'y',
// side: 'right'
// },
title: "Leg Mutual Inductance Components (n=" + legs.n_legs + ")"
};
Plotly.newPlot(div, data, layout);
}