.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/data_transform/_03_resample.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_data_transform__03_resample.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_data_transform__03_resample.py:


Resampling data
===============

Sometimes you may want to resample your data to a different sampling rate.
We provide a utility class to do this.
It wraps :func:`scipy.signal.resample` and provides a standardized transform interface, so that it can be chained
and used with other transforms in mobgap.

Below we show how to apply the method.

.. GENERATED FROM PYTHON SOURCE LINES 12-17

.. code-block:: default


    import matplotlib.pyplot as plt
    from mobgap.data import LabExampleDataset
    from mobgap.data_transform import Resample








.. GENERATED FROM PYTHON SOURCE LINES 18-20

Loading some example data
-------------------------

.. GENERATED FROM PYTHON SOURCE LINES 20-29

.. code-block:: default

    example_data = LabExampleDataset()
    ha_example_data = example_data.get_subset(cohort="HA")
    single_test = ha_example_data.get_subset(
        participant_id="002", test="Test5", trial="Trial2"
    )
    data = single_test.data_ss

    data.head()






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>acc_x</th>
          <th>acc_y</th>
          <th>acc_z</th>
          <th>gyr_x</th>
          <th>gyr_y</th>
          <th>gyr_z</th>
        </tr>
        <tr>
          <th>time</th>
          <th></th>
          <th></th>
          <th></th>
          <th></th>
          <th></th>
          <th></th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>2020-08-21 10:30:50.479000092+00:00</th>
          <td>9.257165</td>
          <td>0.031602</td>
          <td>-2.604847</td>
          <td>-0.1608</td>
          <td>0.2119</td>
          <td>-0.3052</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.489000082+00:00</th>
          <td>9.268460</td>
          <td>0.017997</td>
          <td>-2.594873</td>
          <td>-0.2712</td>
          <td>-0.0757</td>
          <td>-0.4693</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.499000072+00:00</th>
          <td>9.272030</td>
          <td>0.040954</td>
          <td>-2.617060</td>
          <td>0.1157</td>
          <td>-0.0892</td>
          <td>-0.2648</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.509000063+00:00</th>
          <td>9.262215</td>
          <td>0.046100</td>
          <td>-2.615381</td>
          <td>-0.0091</td>
          <td>-0.2005</td>
          <td>-0.3278</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.519000052+00:00</th>
          <td>9.267278</td>
          <td>0.070575</td>
          <td>-2.585830</td>
          <td>0.0524</td>
          <td>-0.2733</td>
          <td>-0.0965</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 30-33

Applying the resampling transform
---------------------------------
For this we need to create an instance of the Resample class with our target sampling rate.

.. GENERATED FROM PYTHON SOURCE LINES 33-36

.. code-block:: default

    target_sampling_rate = 20
    resampler = Resample(target_sampling_rate)








.. GENERATED FROM PYTHON SOURCE LINES 37-38

Then we can perform the resampling operation by calling the transform method

.. GENERATED FROM PYTHON SOURCE LINES 38-42

.. code-block:: default

    resampled = resampler.transform(
        data, sampling_rate_hz=single_test.sampling_rate_hz
    )








.. GENERATED FROM PYTHON SOURCE LINES 43-45

The results can be accessed via the transformed_data_ attribute.
Here we only extract the gyro data.

.. GENERATED FROM PYTHON SOURCE LINES 45-48

.. code-block:: default

    resampled_gyr = resampled.transformed_data_.filter(like="gyr")
    resampled_gyr.head()






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>gyr_x</th>
          <th>gyr_y</th>
          <th>gyr_z</th>
        </tr>
        <tr>
          <th>time</th>
          <th></th>
          <th></th>
          <th></th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>2020-08-21 10:30:50.479000092+00:00</th>
          <td>0.162794</td>
          <td>0.456150</td>
          <td>-0.145296</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.529064144+00:00</th>
          <td>0.211031</td>
          <td>0.092460</td>
          <td>-0.209048</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.579128197+00:00</th>
          <td>0.492423</td>
          <td>0.205673</td>
          <td>-0.293729</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.629192249+00:00</th>
          <td>0.762922</td>
          <td>0.531404</td>
          <td>-0.171300</td>
        </tr>
        <tr>
          <th>2020-08-21 10:30:50.679256302+00:00</th>
          <td>0.630536</td>
          <td>0.585892</td>
          <td>-0.241490</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 49-56

Note, that the resampled data still has a datetime index.
This is, because the resampling operation attempts to resample the index as well, if the index is numeric or datetime.
If you want to disable this behavior, you can set the ``attempt_index_resample`` parameter to False.

We will plot the resampled data together with the original data.
As expected, the resampled data has much fewer samples (as we downsampled from 100 Hz to 20 Hz).
However, you could use the same method to upsample your data.

.. GENERATED FROM PYTHON SOURCE LINES 56-65

.. code-block:: default

    fig, axs = plt.subplots(3, 1, sharex=True)
    for ax, col in zip(axs, resampled_gyr.columns):
        ax.set_title(col)
        data[col].plot(ax=ax, label="Original", style=".")
        resampled_gyr[col].plot(ax=ax, label="Resampled", style=".")

    axs[0].set_xlim(data.index[300], data.index[500])
    axs[0].legend()
    fig.show()



.. image-sg:: /auto_examples/data_transform/images/sphx_glr__03_resample_001.png
   :alt: gyr_x, gyr_y, gyr_z
   :srcset: /auto_examples/data_transform/images/sphx_glr__03_resample_001.png
   :class: sphx-glr-single-img






.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 1.336 seconds)

**Estimated memory usage:**  9 MB


.. _sphx_glr_download_auto_examples_data_transform__03_resample.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example




    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: _03_resample.py <_03_resample.py>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: _03_resample.ipynb <_03_resample.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_