Matched Filtering

Inheritance diagram of hermespy.jcas.matched_filtering.MatchedFilterJcas
class MatchedFilterJcas(max_range, waveform=None, selected_transmit_ports=None, selected_receive_ports=None, carrier_frequency=None, seed=None)[source]

Bases: DuplexJCASOperator[CommunicationWaveform], Serializable

Joint Communication and Sensing Operator.

A combination of communication and sensing operations. Senses the enviroment via a correlatiom-based time of flight estimation of transmitted waveforms.

Parameters:
  • max_range (float) – Maximally detectable range in m.

  • selected_transmit_ports (Sequence[int] | None) – Indices of antenna ports selected for transmission from the operated Device's antenna array. If not specified, all available ports will be considered.

  • selected_receive_ports (Sequence[int] | None) – Indices of antenna ports selected for reception from the operated Device's antenna array. If not specified, all available antenna ports will be considered.

  • carrier_frequency (float, optional) – Central frequency of the mixed signal in radio-frequency transmission band. If not specified, the operated device’s default carrier frequency will be assumed during signal processing.

  • seed (int, optional) – Random seed used to initialize the pseudo-random number generator.

property frame_duration: float

Duration of a single sample frame in seconds.

Denoted as \(T_{\mathrm{F}}\) of unit \(\left[ T_{\mathrm{F}} \right] = \mathrm{s}\) in literature.

property max_range: float

Maximally Estimated Range.

Returns:

The maximum range in m.

Raises:

ValueError – If max_range is smaller or equal to zero.

property power: float

Expected power of the transmitted signal in Watts.

Note

Applies only to the signal-carrying parts of the transmission, silent parts shuch as guard intervals should not be considered.

property range_resolution: float

Resolution of the Range Estimation.

Returns:

Resolution in m.

Return type:

float

Raises:

ValueError – If the range resolution is smaller or equal to zero.

property sampling_rate: float

The operator’s preferred sampling rate in Hz.

Denoted as \(f_{\mathrm{S}}\) of unit \(\left[ f_{\mathrm{S}} \right] = \mathrm{Hz} = \tfrac{1}{\mathrm{s}}\) in literature.