pyrex.DipoleAntenna.apply_response

DipoleAntenna.apply_response(signal, direction=None, polarization=None, force_real=False)

Process the complete antenna response for an incoming signal.

Processes the incoming signal according to the frequency response of the antenna, the efficiency, and the antenna factor. May also apply the directionality and the polarization gain depending on the provided parameters. Subclasses may wish to overwrite this function if the full antenna response cannot be divided nicely into the described pieces.

Parameters

signalSignal

Incoming Signal object to process.

directionarray_like, optional

Vector denoting the direction of travel of the signal as it reaches the antenna (in the global coordinate frame). If None no directional response will be applied.

polarizationarray_like, optional

Vector denoting the signal’s polarization direction (in the global coordinate frame). If None no polarization gain will be applied.

force_realboolean, optional

Whether or not the frequency response should be redefined in the negative-frequency domain to keep the values of the filtered signal real.

Returns

Signal

Processed Signal object after the complete antenna response has been applied. Should have a value_type of voltage.

Raises

ValueError

If the given signal does not have a value_type of voltage or field.

See also

pyrex.Signal

Base class for time-domain signals.