mobgap.pipeline.create_aggregate_df#
- mobgap.pipeline.create_aggregate_df(
- fix_gs_offset_cols: Sequence[str] = ('start', 'end'),
- *,
- fix_gs_offset_index: bool = False,
- _potential_index_names: Sequence[str] = ('wb_id', 'gs_id'),
Create an aggregator for the GS iterator that aggregates dataframe results into a single dataframe.
The aggregator will also fix the offset of the given columns by adding the start value of the gait-sequence. This way the final dataframe will have all sample based time-values relative to the start of the recording.
- Parameters:
- fix_gs_offset_cols
The columns that should be adapted to be relative to the start of the recording. By default, this is
("start", "end"). If you don’t want to fix any columns, you can set this to an empty list.- fix_gs_offset_index
If True, the index of the dataframes will be adapted to be relative to the start of the recording. This only makes sense, if the index represents sample values relative to the start of the gs.
- _potential_index_names
The potential names of the index columns. This usually does not need to be changed.