Difference between revisions of "NVGate Filter Builder"

From OROS Wiki
Jump to navigation Jump to search
Line 1: Line 1:
[[category:NVGate]]
[[category:NVGate]]
====Filter builder====
====Filter====
Manage the filters definition and position. These filters operate on the time domain series. They can be applied in various locations in the signal process (Inputs, Plug-in channels, Outputs, Player tracks).
Define various IIR filters and where they are applied to. These filters operate on the time domain series. They can be applied to various signal processing stages (Inputs, Plug-in channels, Outputs, Player tracks).


[[Image:Filter_builder_02.png|framed|none]]
[[Image:Filter_builder_02.png|framed|none]]
Line 7: Line 7:
====Connect filter====
====Connect filter====
[[Image:filter.png|framed|Right]]
[[Image:filter.png|framed|Right]]
On [[NVGate_Ribbons:_Acquisition_Tab|acquisition tab,]] The left button (''Apply to''), on filter group, allows dispatching the filters to the different possible locations in the signal process.
In the [[NVGate_Ribbons:_Acquisition_Tab|acquisition tab,]] The left button (''Apply to'') allows users to choose where to apply the filters. The right button ("Filter builder") allows users to setup the properties of the filters.
The second button allows selecting a filter type and opens the corresponding setup.<br>
 
[[File:image_2020-12-04_131308.png|200px]]
 
 
 


[[Image:Reports_Tools_Ribbons_370.png|Reports_Tools_Ribbons_370.png]]
[[Image:Reports_Tools_Ribbons_370.png|Reports_Tools_Ribbons_370.png]]
''Apply to:'' '' This button opens the filter dispatching dialog:
''Apply to:'' '' This button opens the following dialog. To choose where to apply the filters, drag the selected filter on the left and drop it on the selected module on the right. 
 
[[Image:Filter_connect.png|framed|none]]
[[Image:Filter_connect.png|framed|none]]


All filters are available, and by adding any filters to any channel, the properties of filters and channels selected are displayed and filters are applied in the current measurement:
Then the filters connection properties will be displayed, and the properties of the selected filters and channels can be modified in this window.


[[Image:Reports_Tools_Ribbons_372.png|framed|none]]
[[File:image_2020-12-04_133712.png|framed|none]]


Warning: Due to bandwidth compatibility, the filters use is exclusive of the plug-in. I.e: Once a filter is associated to a location (ex: a plug-in channel) it can be used on only the same plug-in channels. The front-end is considered a plug-in.
Note: Due to the bandwidth compatibility, once a filter is applied to a module (ex: a plug-in channel), it can only be used to the same plug-in channels. The front-end is considered as a plug-in.


====Filters====
====Filter builder====
=====High-Low pass=====
=====High-Low pass=====
[[Image:Reports_Tools_Ribbons_373.png]]: Used to design a high-pass filter or a low-pass filter (Butterworth, elliptic…).
[[Image:Reports_Tools_Ribbons_373.png]]: Used to design a high-pass filter or a low-pass filter (Butterworth, Chebyshev Type I, and Chebyshev Type II).
 
[[File:image_2020-12-04_140721.png|framed|none]]


* '''Label''': the name of the filter (by default High-Low pass n, with 1 <nowiki><</nowiki>= n <nowiki><</nowiki>= 4).
* '''Label''': The name of the filter (by default High-Low pass n, with 1 n 4).
* '''Type''': the type (Low pass or High pass) of the filter.
* '''Type''': The type of the filter - Low pass or High pass.
* '''Filter order''': filter order from 1 to 6. The higher is the order, the steepest is the cut-off slope.
* '''Design Type''': The analog prototype filter - Butterworth, Chebyshev band-pass ripple (Type I), or Chebyshev stop-band ripple (Type II).  
* '''Applied to''': Indicates on which plug-in the filter can be used. Indeed the construction of the filter requires applying it on signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset it.
* '''Filter order''': The filter order can be selected from 1 to 40 in Office mode, and from 1 to 10 in Connected mode. The higher the order is, the steeper the cut-off slope is.
The other modules (front-end, monitor, resources) operate at the front end input sampling (in connected mode on-line) or to the max player bandwidth (in post analysis mode).
* '''Applied to''': Shows which plug-in the filter is applied to. The construction of the filter requires applying it to a signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset.
The other modules (front-end, monitor, resources) operate at the front end input sampling frequency (in connected mode on-line) or at the max player bandwidth (in post analysis mode).


{|border="2" cellspacing="0" cellpadding="4" width="59%" align="center"
{|border="2" cellspacing="0" cellpadding="4" width="59%" align="center"
Line 44: Line 52:
|}<br clear="all">
|}<br clear="all">


Note even if plug-ins run in the same bandwidth, its not possible to share filters between different plug-in.
Note that even if plug-ins run in the same bandwidth, it’s not possible to share filters between different plug-ins.


* '''Cut'''-'''off frequency''': the filter cut-off frequency. Its maximum value is the input frequency range. Its minimum value is: FR / 40 (for a Low pass filter) and FR / 400 (for a High pass filter), where FR is the input frequency range.
* '''Cut'''-'''off frequency''': The cut-off frequency of the filter. The maximum value is the input frequency range '''FR'''. The minimum value is '''FR''' / 50000 in the Office mode, and '''FR''' / 40000 in the Connected mode.  
'''Warning '''for measurements including signal phase (i.e: balancing or Bode plot)''' '''the cut-off frequency must be chosen far (10 times) from the frequency of interest. If not, the phase of the low pass filter will affect the phase of the result.
'''Warning ''': For measurements including the signal phase (i.e: balancing or Bode plot), the cut-off frequency must be chosen far from (at least 10 times) the frequency of interest. If not, the phase of the low pass filter will affect the phase of the result.


* '''By'''-'''pass''': On / Off. The filter is not applied if By-pass is On.
* '''By'''-'''pass''': On / Off. The filter is not applied if By-pass is On.
Line 58: Line 66:
[[Image:Reports_Tools_Ribbons_374.png|Reports_Tools_Ribbons_374.png]]: Used to design a band-pass filter or a band-stop filter.
[[Image:Reports_Tools_Ribbons_374.png|Reports_Tools_Ribbons_374.png]]: Used to design a band-pass filter or a band-stop filter.


* '''Label''': the name of the filter (by default Pass-Stop band n, with 1 <nowiki><</nowiki>= n <nowiki><</nowiki>= 4).
[[File:image_2020-12-04_141352.png|framed|none]]
* '''Type''': the type (Band pass or Band stop) of filter.
 
* '''Filter order''': 2, 4, 6, 8 or 10. The higher is the order, the steepest is the cut-off.
* '''Label''': The name of the filter (by default Pass-Stop band n, with 1 n 4).
* '''Applied to''': Indicates on which plug-in the filter can be used. Indeed the construction of the filter requires applying it on signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset it.
* '''Type''': The type of the filter - Band pass or Band stop.
The other modules (front-end, monitor, resources) operate at the front end input sampling (in connected mode on-line) or to the max player bandwidth (in post analysis mode).
* '''Design type''': The analog prototype filter - Butterworth, Chebyshev band-pass ripple (Type I), or Chebyshev stop-band ripple (Type II).  
* '''Filter order''': The filter order is 2*N, and N can be selected between 1 to 30 in the Office mode, and between 1 to 10 in the Connected mode. The higher the order is, the steeper the cut-off slope is.
* '''Applied to''': Shows which plug-in the filter is applied to. The construction of the filter requires applying it to a signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset.
The other modules (front-end, monitor, resources) operate at the front end input sampling frequency (in connected mode on-line) or at the max player bandwidth (in post analysis mode).


{|border="2" cellspacing="0" cellpadding="4" width="59%" align="center"
{|border="2" cellspacing="0" cellpadding="4" width="59%" align="center"
Line 78: Line 89:
|}<br clear="all">
|}<br clear="all">


Note: even if plug-ins run in the same bandwidth, it not possible to share filters between different plug-in.
Note that even if plug-ins run in the same bandwidth, it’s not possible to share filters between different plug-ins.
 
* '''Low cut-off frequency''' and '''High cut-off frequency''': The low cut-off frequency of the filter ''f''<sub>low</sub> and the high cut-off frequency of the filter ''f''<sub>high</sub>. Their values need to meet the following conditions in the Office mode:
 
''f''<sub>low</sub> ≥ 0.0001 * '''FR'''
''f''<sub>high</sub> ≤ '''FR''' 
 
0.0004 '''FR''' ≤ ''f''<sub>high</sub> - ''f''<sub>low</sub> ≤ 0.9998 * '''FR'''
 
And in the Connected mode, the conditions are as below:
 
''f''<sub>low</sub> ≥ 0.0005 * '''FR'''


* '''Low cut-off frequency''': the low filter cut-off frequency. Its minimum value is 0.055 * FR, where FR is the input frequency range. However, the following conditions must also be fulfilled:
''f''<sub>high</sub> ≤ '''FR'''


'''0.0075 * FR <nowiki><</nowiki>= B <nowiki><</nowiki>= 0.5 FR'''
0.000675 * '''FR''' ≤ ''f''<sub>high</sub> - ''f''<sub>low</sub> 0.99 * '''FR'''


where B is the bandwidth between Low and high cut-off frequency and FR is the input frequency range.
where '''FR''' is the input frequency range.  


* '''High cut-off frequency''': the filter high cut-off frequency. Its maximum value is the input frequency range. However, the following conditions must also be fulfilled: see Low cut-off frequency.
* '''By'''-'''pass''': On / Off. The filter is not applied if By-pass is On.
* '''By'''-'''pass''': On / Off. The filter is not applied if By-pass is On.



Revision as of 14:40, 4 December 2020

Filter

Define various IIR filters and where they are applied to. These filters operate on the time domain series. They can be applied to various signal processing stages (Inputs, Plug-in channels, Outputs, Player tracks).

Filter builder 02.png

Connect filter

In the acquisition tab, The left button (Apply to) allows users to choose where to apply the filters. The right button ("Filter builder") allows users to setup the properties of the filters.

Image 2020-12-04 131308.png



Reports_Tools_Ribbons_370.png Apply to: This button opens the following dialog. To choose where to apply the filters, drag the selected filter on the left and drop it on the selected module on the right.

Filter connect.png

Then the filters connection properties will be displayed, and the properties of the selected filters and channels can be modified in this window.

Image 2020-12-04 133712.png

Note: Due to the bandwidth compatibility, once a filter is applied to a module (ex: a plug-in channel), it can only be used to the same plug-in channels. The front-end is considered as a plug-in.

Filter builder

High-Low pass

Reports Tools Ribbons 373.png: Used to design a high-pass filter or a low-pass filter (Butterworth, Chebyshev Type I, and Chebyshev Type II).

Image 2020-12-04 140721.png
  • Label: The name of the filter (by default High-Low pass n, with 1 ≤ n ≤ 4).
  • Type: The type of the filter - Low pass or High pass.
  • Design Type: The analog prototype filter - Butterworth, Chebyshev band-pass ripple (Type I), or Chebyshev stop-band ripple (Type II).
  • Filter order: The filter order can be selected from 1 to 40 in Office mode, and from 1 to 10 in Connected mode. The higher the order is, the steeper the cut-off slope is.
  • Applied to: Shows which plug-in the filter is applied to. The construction of the filter requires applying it to a signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset.

The other modules (front-end, monitor, resources) operate at the front end input sampling frequency (in connected mode on-line) or at the max player bandwidth (in post analysis mode).

Apply to Description
Front-end (20 kHz) To be used on any resources and monitor
FFTx (10 kHz) To be used on the FFT x analyzer only


Note that even if plug-ins run in the same bandwidth, it’s not possible to share filters between different plug-ins.

  • Cut-off frequency: The cut-off frequency of the filter. The maximum value is the input frequency range FR. The minimum value is FR / 50000 in the Office mode, and FR / 40000 in the Connected mode.

Warning : For measurements including the signal phase (i.e: balancing or Bode plot), the cut-off frequency must be chosen far from (at least 10 times) the frequency of interest. If not, the phase of the low pass filter will affect the phase of the result.

  • By-pass: On / Off. The filter is not applied if By-pass is On.
Filter builder 03.png

By-passing a filter does not request stabilization time.

Pass-Stop band

Reports_Tools_Ribbons_374.png: Used to design a band-pass filter or a band-stop filter.

Image 2020-12-04 141352.png
  • Label: The name of the filter (by default Pass-Stop band n, with 1 ≤ n ≤ 4).
  • Type: The type of the filter - Band pass or Band stop.
  • Design type: The analog prototype filter - Butterworth, Chebyshev band-pass ripple (Type I), or Chebyshev stop-band ripple (Type II).
  • Filter order: The filter order is 2*N, and N can be selected between 1 to 30 in the Office mode, and between 1 to 10 in the Connected mode. The higher the order is, the steeper the cut-off slope is.
  • Applied to: Shows which plug-in the filter is applied to. The construction of the filter requires applying it to a signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset.

The other modules (front-end, monitor, resources) operate at the front end input sampling frequency (in connected mode on-line) or at the max player bandwidth (in post analysis mode).

Apply to Description
Front-end (20 kHz) To be used on any resources and monitor
FFTx (10 kHz) To be used on the FFT x analyzer only


Note that even if plug-ins run in the same bandwidth, it’s not possible to share filters between different plug-ins.

  • Low cut-off frequency and High cut-off frequency: The low cut-off frequency of the filter flow and the high cut-off frequency of the filter fhigh. Their values need to meet the following conditions in the Office mode:

flow ≥ 0.0001 * FR

fhighFR

0.0004 FRfhigh - flow ≤ 0.9998 * FR

And in the Connected mode, the conditions are as below:

flow ≥ 0.0005 * FR

fhighFR

0.000675 * FRfhigh - flow ≤ 0.99 * FR

where FR is the input frequency range.

  • By-pass: On / Off. The filter is not applied if By-pass is On.
Filter builder 04.png
Integrator

Reports Tools Ribbons 375.png: Used to design a time integrator filter associated with a high pass filter (to limit gain near DC components).

  • Label: the name of the filter (by default Integrator n, with 1 <= n <= ).
  • Type: the type (High Pass + single integ. / High Pass + double integ.) of the filter.
  • Applied to: Indicates on which plug-in the filter can be used. Indeed the construction of the filter requires applying it on signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset it.

The other modules (front-end, monitor, resources) operate at the front end input sampling (in connected mode on-line) or to the max player bandwidth (in post analysis mode).

Apply to Description
Front-end (20 kHz) To be used on any resources and monitor
FFTx (10 kHz) To be used on the FFT x analyzer only


    • Note : Even if plug-ins run in the same bandwidth, it not possible to share filters between different plug-in.
  • HP cut-off frequency: the cut-off frequency of the High pass filter contained in this integrator filter. Its maximum value is FR / 2000, and its minimum value is FR / 10000, where FR is the input frequency range.

Warning for measurements including signal phase (i.e: balancing or Bode plot) the cut-off frequency must be chosen far (10 times) from the frequency of interest. If not the phase of the low pas filter will affect the phase of the result.

'Integration 'time: the time constant of the integrator filter is equal to 1s. This is fixed value, not a setting.

The frequency response of a first order integrator filter is equal to:

Integrator.png


  • By-pass: On / Off. The filter is not applied if By-pass is On.
Filter builder 06.png
  • Note : In post analyse, you will have a stabilisation time of 2 seconds before having any results or signal :
    • The integrator filter has an integration time of 1s.
    • This integrator filter also include a high pass filter. This filter needs also a stabilization time of 1s.

Therefore, the total stabilisation time of the filter is 2 seconds. Meanning the 2 first seconds of the signal will not be analysed.

Differentiator

Reports Tools Ribbons 376.pngUsed to setup a time differentiator filter associated with an exponential average to avoid that small fluctuations of the input signal become important distortions in the output signal.

  • Label: the name of the filter (by default Differentiator n, with 1 <= n <= 3).
  • Applied to: Indicates on which plug-in the filter can be used. Indeed the construction of the filter requires applying it on signal with the same bandwidth. The determination of the associated plug-in/bandwidth is automatic. Deactivate the filter to reset it.

The other modules (front-end, monitor, resources) operate at the front end input sampling (in connected mode on-line) or to the max player bandwidth (in post analysis mode).

Apply to Description
Front-end (20 kHz) To be used on any resources and monitor
FFTx (10 kHz) To be used on the FFT x analyzer only


Note even if plug-ins run in the same bandwidth, it no possible to share filters between different plug-in.

  • Avg. duration:Filter average duration. By default, the average duration is equal to 0s. This value can be modified by the user. This setting is used to specify the exponential average duration of the differentiator filter

Xmean(n) = λX(n) + (1 – λ)Xmean(n-1) with Xmean(n) the averaged input signal at instant n, X(n) the input signal at instant n and λ the averaging factor.

The following formula is applied to the averaged signal:

Y(n) = (Xmean(n) -Xmean(n-1)) / fs. with, Y(n) the differentiated signal at instant n, Xmean(n) the averaged input signal at instant n and fs the sampling frequency.

  • By-pass: On / Off. The filter is not applied if By-pass is On.
Filter builder 07.png