search

pyspace / pyspace

Signal Processing And Classification Environment in Python
http://pyspace.github.io/pyspace/index.html
BSD 3-Clause "New" or "Revised" License
54 stars 21 forks source link

What is the phase_shift in the downsampling node? #25

Open AlexanderFabisch opened 7 years ago

AlexanderFabisch commented 7 years ago

The parameters are not well documented.

documentation

MMKrell commented 7 years ago

I took a look at the code. Turns out that phase_shift does not have any meaning for this node because this parameter isn't used at all. No idea, how and why it occurs in the example. The only relevant parameter is the target frequency. The documentation should read like:

**Parameters**
    :target_frequency:
        The frequency after the decimation.

        (*required*)

**Exemplary Call**

.. code-block:: yaml

    - 
        node : Downsampling
        parameters :
            target_frequency : 2.5
AlexanderFabisch commented 7 years ago

OK, thanks.