Skip to content

Commit

Permalink
Change docstrings for data types
Browse files Browse the repository at this point in the history
  • Loading branch information
Erikpostt committed Dec 3, 2024
1 parent 2616767 commit 9f8420c
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions src/paradigma/gait/feature_extraction.py
Original file line number Diff line number Diff line change
Expand Up @@ -655,9 +655,9 @@ def compute_range_of_motion(

def compute_peak_angular_velocity(
velocity_window: np.ndarray,
angle_extrema_indices: List[List[int]],
minima_indices: List[List[int]],
maxima_indices: List[List[int]],
angle_extrema_indices: List[np.ndarray],
minima_indices: np.ndarray,
maxima_indices: np.ndarray,
) -> Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray]:
"""
Calculate the forward and backward peak angular velocities for each window.
Expand All @@ -673,17 +673,19 @@ def compute_peak_angular_velocity(
number of velocity values per window. Each row represents a window containing
velocity data.
angle_extrema_indices : list of list of int
angle_extrema_indices : list of np.ndarray
A list of N lists, where each list contains the indices of the extrema
(peaks) in the velocity data for the corresponding window.
minima_indices : list of list of int
A list of N lists, where each list contains the indices of the minimum
extrema for the corresponding window.
minima_indices : np.ndarray
A 1D numpy array of objects, where each element is a numpy array
containing the indices of the minima extrema for the corresponding
window after processing.
maxima_indices : list of list of int
A list of N lists, where each list contains the indices of the maximum
extrema for the corresponding window.
maxima_indices : np.ndarray
A 1D numpy array of objects, where each element is a numpy array
containing the indices of the maxima extrema for the corresponding
window after processing.
Returns
-------
Expand Down

0 comments on commit 9f8420c

Please sign in to comment.