Skip to content

Commit

Permalink
Added note about fs/2 vs max frf freq
Browse files Browse the repository at this point in the history
  • Loading branch information
ansaminard committed Dec 18, 2024
1 parent 9cb3684 commit 91ee55c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/ansys/sound/core/signal_processing/filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ class Filter(SignalProcessingParent):
filter denominator (:attr:`a_coefficients`) is set to 1 as a consequence.
.. note::
Whether they are derived from the provided FRF or specified directly, the filter
coefficients are linked to the sampling frequency value that is given in the argument
``sampling_frequency`` of the ``Filter`` class. As a consequence, the signal to filter
Expand Down Expand Up @@ -185,6 +184,12 @@ def design_FIR_from_FRF_file(self, file: str):
Computes the filter coefficients according to the filter sampling frequency and the FRF
data that is loaded from the specified file.
.. note::
If the maximum frequency specified in the FRF file extends beyond half the filter
sampling frequency, the FRF data is truncated to this frequency. If, on the contrary,
the FRF file's maximum frequency is lower than half the filter sampling frequency, the
FRF is zero-padded between the two.
Parameters
----------
file : str
Expand All @@ -210,6 +215,12 @@ def design_FIR_from_FRF(self, frf: Field):
Computes the filter coefficients according to the filter sampling frequency and the
provided FRF data.
.. note::
If the maximum frequency specified in the FRF extends beyond half the filter sampling
frequency, the FRF data is truncated to this frequency. If, on the contrary, the FRF
maximum frequency is lower than half the filter sampling frequency, the FRF is
zero-padded between the two.
Parameters
----------
frf : Field
Expand Down

0 comments on commit 91ee55c

Please sign in to comment.