Skip to content

Array Factor

rfsoc_rfdc.dsp.array_factor

Classes

ArrayFactor

Bases: ABC

Abstract base class for Array Factor calculations.

This class defines the interface for beamformers and array factor computations.

Source code in rfsoc_rfdc/dsp/array_factor.py 
 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
class ArrayFactor(ABC):
    """
    Abstract base class for Array Factor calculations.

    This class defines the interface for beamformers and array factor computations.
    """

    @abstractmethod
    def get_spacing(self):
        """
        Get the physical spacing of the array elements.

        Returns:
            numpy.ndarray: An array containing the positions of the antenna elements (in meters).
        """
        pass

    @abstractmethod
    def get_bfw(self):
        """
        Calculate the complex weights for beamforming.

        Returns:
            numpy.ndarray: Complex weights for the array elements.
        """
        pass

    @abstractmethod
    def get_bfw_sim(self):
        """
        Calculate the complex weights for beamforming (Simulation Only).
        This should return ideal weights without any hardware-specific calibration.

        Returns:
            numpy.ndarray: Complex weights for the array elements.
        """
        pass

    @abstractmethod
    def get_bfw_fixpt(self, bits=16):
        """
        Calculate the fixed-point weights for beamforming.

        Args:
            bits (int): The number of bits for fixed-point representation. Defaults to 16.

        Returns:
            tuple: A tuple containing (real_weights, imag_weights) as integer arrays.
        """
        pass
Functions
get_spacing() abstractmethod

Get the physical spacing of the array elements.

Returns:

Type Description

numpy.ndarray: An array containing the positions of the antenna elements (in meters).
Source code in rfsoc_rfdc/dsp/array_factor.py 
12
13
14
15
16
17
18
19
20
@abstractmethod
def get_spacing(self):
    """
    Get the physical spacing of the array elements.

    Returns:
        numpy.ndarray: An array containing the positions of the antenna elements (in meters).
    """
    pass
get_bfw() abstractmethod

Calculate the complex weights for beamforming.

Returns:

Type Description

numpy.ndarray: Complex weights for the array elements.
Source code in rfsoc_rfdc/dsp/array_factor.py 
22
23
24
25
26
27
28
29
30
@abstractmethod
def get_bfw(self):
    """
    Calculate the complex weights for beamforming.

    Returns:
        numpy.ndarray: Complex weights for the array elements.
    """
    pass
get_bfw_sim() abstractmethod

Calculate the complex weights for beamforming (Simulation Only). This should return ideal weights without any hardware-specific calibration.

Returns:

Type Description

numpy.ndarray: Complex weights for the array elements.
Source code in rfsoc_rfdc/dsp/array_factor.py 
32
33
34
35
36
37
38
39
40
41
@abstractmethod
def get_bfw_sim(self):
    """
    Calculate the complex weights for beamforming (Simulation Only).
    This should return ideal weights without any hardware-specific calibration.

    Returns:
        numpy.ndarray: Complex weights for the array elements.
    """
    pass
get_bfw_fixpt(bits=16) abstractmethod

Calculate the fixed-point weights for beamforming.

Parameters:

Name Type Description Default
bits int

The number of bits for fixed-point representation. Defaults to 16.

 16

Returns:

Name Type Description
tuple

A tuple containing (real_weights, imag_weights) as integer arrays.
Source code in rfsoc_rfdc/dsp/array_factor.py 
43
44
45
46
47
48
49
50
51
52
53
54
@abstractmethod
def get_bfw_fixpt(self, bits=16):
    """
    Calculate the fixed-point weights for beamforming.

    Args:
        bits (int): The number of bits for fixed-point representation. Defaults to 16.

    Returns:
        tuple: A tuple containing (real_weights, imag_weights) as integer arrays.
    """
    pass