Skip to content

tools

module for common rf functions and utilities.

db20(*kwargs)

Return the decibel value of the sum of the given complex number.

Parameters:

Name Type Description Default
kwargs

input complex numbers

 ()

Returns:

Type Description

sum of absolute value of the input complex numbers in decibel examples: db20(1) -> 0 db20(0.5,0.5) -> 0
Source code in hades\models\tools.py 
 8
 9
10
11
12
13
14
15
16
17
18
def db20(*kwargs):
    """
    Return the decibel value of the sum of the given complex number.
    :param kwargs: input complex numbers
    :return: sum of absolute value of the input complex numbers in decibel
    examples:
    db20(1) -> 0
    db20(0.5,0.5) -> 0
    """
    sm = sum(np.abs(k) ** 2 for k in kwargs)
    return 10 * np.log10(sm)

eng(x, precision=3, prefix=True)

Convert a number to engineer notation (notation with an exponent multiple of 3).

Parameters:

Name Type Description Default
x float

number to convert

 required
precision int

after comma digit number.

 3
prefix bool

If True, return number with prefix letters (fe: 1.3 p). If False, return number with exponent (fe: 1.3e3).

 True

Returns:

Type Description
str

string representing the number
Source code in hades\models\tools.py 
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
def eng(x: float, precision: int = 3, prefix: bool = True) -> str:
    """
    Convert a number to engineer notation (notation with an exponent multiple of 3).
    :param x: number to convert
    :param precision: after comma digit number.
    :param prefix: If True, return number with prefix letters (fe: 1.3 p).
        If False, return number with exponent (fe: 1.3e3).
    :return: string representing the number
    """
    pw = int(np.log10(np.abs(x)) // 3)
    if prefix:
        ref = {
            -5: "f",
            -4: "p",
            -3: "n",
            -2: "ยต",
            -1: "m",
            0: "",
            1: "k",
            2: "M",
            3: "G",
            4: "T",
        }
        return f"{x * 10 ** (-3 * pw):.{precision}f} {ref[pw]}"
    else:
        return f"{x * 10 ** (-3 * pw):.{precision}f}e{3 * pw}"

norm_diff(a, b)

return the normalized difference of two numbers a and b.

Source code in hades\models\tools.py 
28
29
30
31
32
def norm_diff(a: float, b: float, /) -> float:
    """
    return the normalized difference of two numbers a and b.
    """
    return abs(a - b) / (abs(a) + abs(b))

quality(z)

Return the quality factor of an impedance.

Source code in hades\models\tools.py 
21
22
23
24
25
def quality(z: complex) -> float:
    """
    Return the quality factor of an impedance.
    """
    return z.imag / z.real