.. _`Filter ADAFs`:

.. _`org.sysess.sympathy.data.adaf.filteradafswithplot`:

Filter ADAFs
~~~~~~~~~~~~

.. image:: filter_adaf.svg
   :width: 48


Filter ADAFs with a specified filter.

Both IIR filters and FIR filters can be selected. The filter
can be a forward or forward-backward filter. The resulting filter
design and an example of filtered data can be inspected
in real-time within the node's GUI.

The FIR filter windows that can be used are:
    - Bartlett-Hann_
    - Bartlett_
    - Blackman_
    - Blackman-Harris_
    - Bohman_
    - Boxcar_
    - Dolph-Chebyshev_
    - `Flat top`_
    - Gaussian_
    - `Generalized Gaussian`_
    - Hamming_
    - Hann_
    - Kaiser_
    - Nuttall_
    - Parzen_
    - Slepian_
    - Triangular_

.. _Bartlett-Hann: http://en.wikipedia.org/wiki/Window_function#Bartlett.E2.80.93Hann_window
.. _Bartlett: http://en.wikipedia.org/wiki/Window_function#Triangular_window
.. _Blackman: http://en.wikipedia.org/wiki/Window_function#Blackman_windows
.. _Blackman-Harris: http://en.wikipedia.org/wiki/Window_function#Blackman.E2.80.93Harris_window
.. _Bohman: http://en.wikipedia.org/wiki/Window_function#Cosine_window
.. _Boxcar: http://en.wikipedia.org/wiki/Window_function#Rectangular_window
.. _Dolph-Chebyshev: http://en.wikipedia.org/wiki/Window_function#Dolph.E2.80.93Chebyshev_window
.. _`Flat top`: http://en.wikipedia.org/wiki/Window_function#Flat_top_window
.. _Gaussian: http://en.wikipedia.org/wiki/Window_function#Gaussian_window
.. _`Generalized Gaussian`: http://en.wikipedia.org/wiki/Window_function#Gaussian_window
.. _Hamming: http://en.wikipedia.org/wiki/Window_function#Hamming_window
.. _Hann: http://en.wikipedia.org/wiki/Window_function#Hann_.28Hanning.29_window
.. _Kaiser: http://en.wikipedia.org/wiki/Kaiser_window
.. _Nuttall: http://en.wikipedia.org/wiki/Window_function#Nuttall_window.2C_continuous_first_derivative
.. _Parzen: http://en.wikipedia.org/wiki/Window_function#Parzen_window
.. _Slepian: http://en.wikipedia.org/wiki/Window_function#DPSS_or_Slepian_window
.. _Triangular: http://en.wikipedia.org/wiki/Window_function#Triangular_window

The IIR filter functions supported are:
    - Butterworth_
    - `Chebyshev 1`_
    - `Chebyshev 2`_
    - Elliptic_

.. _Butterworth: http://en.wikipedia.org/wiki/Butterworth_filter
.. _`Chebyshev 1`: http://en.wikipedia.org/wiki/Chebyshev_filter#Type_I_Chebyshev_filters
.. _`Chebyshev 2`: http://en.wikipedia.org/wiki/Chebyshev_filter#Type_II_Chebyshev_filters
.. _Elliptic: http://en.wikipedia.org/wiki/Elliptic_filter

*Ports*:

    **Inputs**:

        :port1: [adaf]

            Input ADAFs

    **Outputs**:

        :port1: [adaf]

            Output ADAFs with filter applied

*Configuration*:

    **filter_type**
        Combo of filter types
    **freq_type**
        Frequency pass type required for the FIR filter.
    **fir_windows**
        Filter windows for FIR filter
    **fir_len**
        Length of the filter
    **fir_cutoff**
        Cutoff frequency of filter (expressed in the same units as `nyq`) OR an array of cutoff frequencies (that is, band edges). In the latter case, the frequencies in `cutoff` should be positive and monotonically increasing between 0 and `nyq`. The values 0 and `nyq` must not be included in `cutoff`.
    **fir_w1**
        Filter specific parameter. Check the help.
    **fir_w2**
        Filter specific parameter. Check the help.
    **iir_filters**
        IIR filters
    **iir_wp**
        Passband edge frequency
    **iir_ws**
        Stopband edge frequency
    **iir_gpass**
        Max loss in the passband (dB)
    **iir_gstop**
        Min attenuation in the stopband (dB)
    **filtering**
        Filtering types
    **signal_select**
        Select a signal
    **auto_plot**
        Automatically refresh the plot

.. automodule:: node_filter_adafs

.. class:: FilterADAFsWithPlot