RF Touchstone

Appearance

RF Touchstone

RF Touchstone / frequency / Frequency

Class: Frequency ​

Defined in: src/frequency.ts:60

Class representing frequency data in RF and microwave engineering

Remarks ​

The Frequency class manages frequency-related data, including:

  • Frequency unit management
  • Storage of frequency points
  • Unit conversion capabilities

Example ​

typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scale = [1.0, 2.0, 3.0];

Constructors ​

Constructor ​

new Frequency(): Frequency

Returns ​

Frequency

Accessors ​

unit ​

Get Signature ​

get unit(): "Hz" | "kHz" | "MHz" | "GHz"

Defined in: src/frequency.ts:139

Gets the current frequency unit

Example ​
typescript
const freq = new Frequency();
console.log(freq.unit); // Outputs: 'Hz'
Returns ​

"Hz" | "kHz" | "MHz" | "GHz"

The current frequency unit

Set Signature ​

set unit(newUnit): void

Defined in: src/frequency.ts:79

Sets the frequency unit for the instance

Throws ​

If the provided unit is not one of the supported frequency units

Example ​
typescript
const freq = new Frequency();
freq.unit = 'MHz'; // Sets unit to Megahertz
Parameters ​
newUnit ​

The frequency unit to set

"Hz" | "kHz" | "MHz" | "GHz"

Returns ​

void

f_scaled ​

Get Signature ​

get f_scaled(): number[]

Defined in: src/frequency.ts:201

Gets the array of frequency points

Example ​
typescript
const freq = new Frequency();
freq.unit = 'MHz';
freq.f_scaled = [100, 200, 300];
console.log(freq.f_scaled); // Outputs: [100, 200, 300]
Returns ​

number[]

Array of frequency points in the current unit

Set Signature ​

set f_scaled(value): void

Defined in: src/frequency.ts:166

Array of frequency points in the current frequency unit Each element represents a discrete frequency point for measurement or analysis

Throws ​

If the input is not an array

Throws ​

If any element in the array is not a number

Throws ​

If the array contains negative frequencies

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [1.0, 1.5, 2.0]; // Sets frequency points in GHz
Parameters ​
value ​

number[]

Array of frequency points

Returns ​

void

f_Hz ​

Get Signature ​

get f_Hz(): number[]

Defined in: src/frequency.ts:293

Gets frequency points in Hz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [1, 2, 3]; // 1 GHz, 2 GHz, 3 GHz
console.log(freq.f_Hz); // Outputs: [1e9, 2e9, 3e9]
Returns ​

number[]

Array of frequency points in Hz

Set Signature ​

set f_Hz(values): void

Defined in: src/frequency.ts:309

Sets frequency points assuming input is in Hz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'MHz';
freq.f_Hz = [1e9, 2e9, 3e9]; // Sets frequencies as 1 GHz, 2 GHz, 3 GHz
console.log(freq.f_scaled); // Outputs: [1000, 2000, 3000] (in MHz)
Parameters ​
values ​

number[]

Array of frequency points in Hz

Returns ​

void

f_kHz ​

Get Signature ​

get f_kHz(): number[]

Defined in: src/frequency.ts:325

Gets frequency points in kHz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'Hz';
freq.f_scaled = [1000, 2000, 3000]; // 1 kHz, 2 kHz, 3 kHz
console.log(freq.f_kHz); // Outputs: [1, 2, 3]
Returns ​

number[]

Array of frequency points in kHz

Set Signature ​

set f_kHz(values): void

Defined in: src/frequency.ts:341

Sets frequency points assuming input is in kHz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'Hz';
freq.f_kHz = [1, 2, 3]; // Sets frequencies as 1 kHz, 2 kHz, 3 kHz
console.log(freq.f_scaled); // Outputs: [1000, 2000, 3000] (in Hz)
Parameters ​
values ​

number[]

Array of frequency points in kHz

Returns ​

void

f_MHz ​

Get Signature ​

get f_MHz(): number[]

Defined in: src/frequency.ts:357

Gets frequency points in MHz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [0.1, 0.2, 0.3]; // 0.1 GHz, 0.2 GHz, 0.3 GHz
console.log(freq.f_MHz); // Outputs: [100, 200, 300]
Returns ​

number[]

Array of frequency points in MHz

Set Signature ​

set f_MHz(values): void

Defined in: src/frequency.ts:373

Sets frequency points assuming input is in MHz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_MHz = [100, 200, 300]; // Sets frequencies as 100 MHz, 200 MHz, 300 MHz
console.log(freq.f_scaled); // Outputs: [0.1, 0.2, 0.3] (in GHz)
Parameters ​
values ​

number[]

Array of frequency points in MHz

Returns ​

void

f_GHz ​

Get Signature ​

get f_GHz(): number[]

Defined in: src/frequency.ts:389

Gets frequency points in GHz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'MHz';
freq.f_scaled = [1000, 2000, 3000]; // 1000 MHz, 2000 MHz, 3000 MHz
console.log(freq.f_GHz); // Outputs: [1, 2, 3]
Returns ​

number[]

Array of frequency points in GHz

Set Signature ​

set f_GHz(values): void

Defined in: src/frequency.ts:405

Sets frequency points assuming input is in GHz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'MHz';
freq.f_GHz = [1, 2, 3]; // Sets frequencies as 1 GHz, 2 GHz, 3 GHz
console.log(freq.f_scaled); // Outputs: [1000, 2000, 3000] (in MHz)
Parameters ​
values ​

number[]

Array of frequency points in GHz

Returns ​

void

f_THz ​

Get Signature ​

get f_THz(): number[]

Defined in: src/frequency.ts:421

Gets frequency points in THz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [1000, 2000, 3000]; // 1000 GHz, 2000 GHz, 3000 GHz
console.log(freq.f_THz); // Outputs: [1, 2, 3]
Returns ​

number[]

Array of frequency points in THz

Set Signature ​

set f_THz(values): void

Defined in: src/frequency.ts:437

Sets frequency points assuming input is in THz

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_THz = [1, 2, 3]; // Sets frequencies as 1 THz, 2 THz, 3 THz
console.log(freq.f_scaled); // Outputs: [1000, 2000, 3000] (in GHz)
Parameters ​
values ​

number[]

Array of frequency points in THz

Returns ​

void

wavelength_m ​

Get Signature ​

get wavelength_m(): number[]

Defined in: src/frequency.ts:546

Gets wavelength in meters

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [1, 2, 3]; // Frequencies in GHz
console.log(freq.wavelength_m); // Outputs: Wavelengths in meters
Returns ​

number[]

Array of wavelength values in meters

Set Signature ​

set wavelength_m(values): void

Defined in: src/frequency.ts:562

Sets wavelength in meters. Converts to frequency and stores.

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.wavelength_m = [0.3, 0.15, 0.1]; // Wavelengths in meters
console.log(freq.f_scaled); // Outputs: Frequencies in GHz
Parameters ​
values ​

number[]

Array of wavelength values in meters

Returns ​

void

wavelength_cm ​

Get Signature ​

get wavelength_cm(): number[]

Defined in: src/frequency.ts:578

Gets wavelength in centimeters

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [10, 20, 30]; // Frequencies in GHz
console.log(freq.wavelength_cm); // Outputs: Wavelengths in centimeters
Returns ​

number[]

Array of wavelength values in centimeters

Set Signature ​

set wavelength_cm(values): void

Defined in: src/frequency.ts:594

Sets wavelength in centimeters. Converts to frequency and stores.

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.wavelength_cm = [30, 15, 10]; // Wavelengths in centimeters
console.log(freq.f_scaled); // Outputs: Frequencies in GHz
Parameters ​
values ​

number[]

Array of wavelength values in centimeters

Returns ​

void

wavelength_mm ​

Get Signature ​

get wavelength_mm(): number[]

Defined in: src/frequency.ts:610

Gets wavelength in millimeters

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [100, 200, 300]; // Frequencies in GHz
console.log(freq.wavelength_mm); // Outputs: Wavelengths in millimeters
Returns ​

number[]

Array of wavelength values in millimeters

Set Signature ​

set wavelength_mm(values): void

Defined in: src/frequency.ts:626

Sets wavelength in millimeters. Converts to frequency and stores.

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.wavelength_mm = [300, 150, 100]; // Wavelengths in millimeters
console.log(freq.f_scaled); // Outputs: Frequencies in GHz
Parameters ​
values ​

number[]

Array of wavelength values in millimeters

Returns ​

void

wavelength_um ​

Get Signature ​

get wavelength_um(): number[]

Defined in: src/frequency.ts:642

Gets wavelength in micrometers

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.f_scaled = [1000, 2000, 3000]; // Frequencies in GHz
console.log(freq.wavelength_um); // Outputs: Wavelengths in micrometers
Returns ​

number[]

Array of wavelength values in micrometers

Set Signature ​

set wavelength_um(values): void

Defined in: src/frequency.ts:658

Sets wavelength in micrometers. Converts to frequency and stores.

Example ​
typescript
const freq = new Frequency();
freq.unit = 'GHz';
freq.wavelength_um = [300000, 150000, 100000]; // Wavelengths in micrometers
console.log(freq.f_scaled); // Outputs: Frequencies in GHz
Parameters ​
values ​

number[]

Array of wavelength values in micrometers

Returns ​

void

wavelength_nm ​

Get Signature ​

get wavelength_nm(): number[]

Defined in: src/frequency.ts:674

Gets wavelength in nanometers

Example ​
typescript
const freq = new Frequency();
freq.unit = 'THz';
freq.f_scaled = [100, 200, 300]; // Frequencies in THz
console.log(freq.wavelength_nm); // Outputs: Wavelengths in nanometers
Returns ​

number[]

Array of wavelength values in nanometers

Set Signature ​

set wavelength_nm(values): void

Defined in: src/frequency.ts:690

Sets wavelength in nanometers. Converts to frequency and stores.

Example ​
typescript
const freq = new Frequency();
freq.unit = 'THz';
freq.wavelength_nm = [300, 150, 100]; // Wavelengths in nanometers
console.log(freq.f_scaled); // Outputs: Frequencies in THz
Parameters ​
values ​

number[]

Array of wavelength values in nanometers

Returns ​

void