RepresentativeCycleFilter#

class pyCGM2.Processing.Representative.representativeFilters.RepresentativeCycleFilter(analysisInstance: Analysis, representativeProcedure: RepresentativeProcedure)#

A filter for identifying the most representative cycle in gait analysis.

This class applies a specified procedure to an analysis instance to determine the most representative cycle of gait. It is particularly useful in scenarios where a single cycle needs to be chosen as a representative for various analyses such as average kinematics, kinetics, or EMG patterns.

m_procedure#

The procedure used to determine the representative cycle.

Type:

RepresentativeProcedure

m_analysis#

The analysis instance containing the gait cycles.

Type:

Analysis

Parameters:
  • analysisInstance (Analysis) – An Analysis instance containing the gait cycles.

  • representativeProcedure (RepresentativeProcedure) – A procedure instance to determine the representative cycle.

__init__(analysisInstance: Analysis, representativeProcedure: RepresentativeProcedure)#

Methods

__init__(analysisInstance, ...)

run()

Executes the representative cycle selection procedure on the provided analysis data.

run()#

Executes the representative cycle selection procedure on the provided analysis data.

This method runs the specified representative procedure on the analysis instance to identify the most representative cycle for both left and right event contexts.

Returns:

Dict[str, int] – A dictionary containing the indices of the representative cycles for both left and right contexts. Keys are ‘Left’ and ‘Right’.