rf-network
TypeScript icon, indicating that this package has built-in type declarations

0.3.1 • Public • Published

RF-Network

A javascript class for holding data from Touchstone v1 files.

Usage

You will need to parse the Touchstone file into a string before using this class. This can be done in browser Javascript with an input of type file, or in node using fs.readFile().

To load the stringified touchstone file into the Network class, use the following.

The filename is passed to the Network constructor to simplify determining the number of ports as well as in error checking.

import Network from 'rf-network'

const network = new Network(touchStoneFileString: string, fileName: string)

network.data // returns an array of network data

Structure of network.data (Updated for v0.2.0)

network.data returns the following Typescript interface

interface NetworkData {
  freq: number[]
  s: math.Complex[][][]
}

network.data.freq is an array of all the frequency points.

network.data.s is a 3-dimensional array. The first and second indeces are the index of the S-parameters. The final dimension contains an array of complex numbers (from the math.js library). This array has equal length to the Network.data.freq, and contains the S-parameter at each frequency.

By default, the S-parameters will be converted to complex number format (R/I format).

The S-parameters are zero-indexed. As an example, if you load an .s2p (two-port) S-parameter file, you would get S21 by accessing network.data.s[1][0].

Properties and Setters

You can currently access the following properties on the Network class.

network.touchstoneText // string text from the touchstone file

network.label // a label for the plot, can be changed with setLabel

network.fileName // the original file name

data // the array of network data
   
nPorts // the number of ports

freqUnit // frequency unit, ie, GHz

paramType // S, Y, Z - currently only supports S-params

z0 - The characteristic impedance   

setLabel(newLabel: string) // give a new label to the plot
   

Readme

Keywords

none

Package Sidebar

Install

npm i rf-network

Weekly Downloads

1

Version

0.3.1

License

MIT

Unpacked Size

1.07 MB

Total Files

34

Last publish

Collaborators

  • jacob.goodwin