v2.2.0 - First Public Release

[2.2.0] - 2023-06-07

Gaitmap is now available as official PyPi package!!!

Added

• New Algorithm: MadgwickRtsKalman.
  This is a slightly modified implementation of the RtsKalman algorithm.
  Instead of naive gyro integration it uses the Madgwick algorithm to estimate the orientation.
  (#15)
• Certain ZUPT detectors now return the min_vel_index_ and min_vel_value_ as additional attributes.
  These values represent the index in the input data with the lowest velocity and the corresponding velocity value
  (according to the internal metric of the repective ZUPT detector).
  (#16)
• New example explaining more advanced usage of the RtsKalman algorithm.
  (#17)
• The find_extrema_in_radius and the snap_to_min utility functions gained the ability to define asymetric search
  windows around the search indices.
  (#21)
• Temporal and Spatial Parameter calculation have new options to work with ic-stride lists and with partial input
  information
• A new method calculate_parameter_errors (old version is renamed to calculate_aggregated_parameter_errors) is
  added that allows to calculate just the errors (i.e. relative error, absolute error, etc.) for a given list of
  parameters. If you want to have the aggregated parameter errors (i.e. mean absolute error, mean relative error, etc.)
  use the calculate_aggregated_parameter_errors method.

Changed

• We now require Pandas >2.0 as we are using the new pandas dtypes.
  It could be that this will require you to perform some explicit type conversion in your code.
• The Zupt Detector example is updated to use newer tpcp features
  (#17)
• The column order of the Spatial Parameter Calculation output has been changed
• The function calculate_parameter_errors is renamed to calculate_aggregated_parameter_errors function is now more
  general and can be used with parameter lists that don't represent strides.
  For this the unique-id column (i.e. original stride index) is can be explicitly set and all wording is changed to
  be more general.
  (#24)
• Fixed a bug that the calculation of the ICC in calculate_parameter_errors/calculate_aggregated_parameter_errors
  was not working correctly, when the stride ids where duplicated across sensors.