convenience (skrf.convenience)¶
Holds pre-initialized objects’s and functions that are general conveniences.
Plotting¶
| save_all_figs([dir, format]) | Save all open Figures to disk. |
| add_markers_to_lines([ax, marker_list, ...]) | adds markers to existing lings on a plot |
| legend_off([ax]) | turn off the legend for a given axes. |
| func_on_all_figs(func, *args, **kwargs) | runs a function after making all open figures current. |
IO¶
| hfss_touchstone_2_media(filename[, f_unit]) | Creates a Media object from a a HFSS-style touchstone file with Gamma and Z0 comments |
| hfss_touchstone_2_gamma_z0(filename) | Extracts Z0 and Gamma comments from touchstone file |
General¶
| now_string() | returns a unique sortable string, representing the current time |
| find_nearest(array, value) | find nearest value in array. |
| find_nearest_index(array, value) | find nearest value in array. |
Pre-initialized Objects¶
Frequency Objects¶
These are predefined Frequency objects that correspond to standard waveguide bands. This information is taken from the VDI Application Note 1002 [1] . The naming convenction is f_wr# where ‘#’ is the band number.
| Object Name | Description |
|---|---|
| f_wr10 | WR-10, 75-110 GHz |
| f_wr3 | WR-3, 220-325 GHz |
| f_wr2p2 | WR-2.2, 330-500 GHz |
| f_wr1p5 | WR-1.5, 500-750 GHz |
| f_wr1 | WR-1, 750-1100 GHz |
Media Objects¶
These are predefined Media objects that represent Standardized transmission line media’s. This information
Rectangular Waveguide Media’s¶
RectangularWaveguide Objects for standard bands.
| Object Name | Description |
|---|---|
| wr10 | WR-10, 75-110 GHz |
| wr3 | WR-3, 220-325 GHz |
| wr2p2 | WR-2.2, 330-500 GHz |
| wr1p5 | WR-1.5, 500-750 GHz |
| wr1 | WR-1, 750-1100 GHz |
Shorthand Names¶
Below is a list of shorthand object names which can be use to save some typing. These names are defined in the main __init__ module. but listing them here makes more sense.
| Shorthand | Full Object Name |
|---|---|
| F | Frequency |
| N | Network |
| NS | NetworkSet |
| M | Media |
| C | Calibration |
The following are shorthand names for commonly used, but unfortunately longwinded functions.
| Shorthand | Full Object Name |
|---|---|
| lat | load_all_touchstones() |
| saf | save_all_figs() |
References¶
| [1] | VDI Application Note: VDI Waveguide Band Designations (VDI-1002) http://vadiodes.com/VDI/pdf/waveguidechart200908.pdf |
