DiscreteEMGFilter#
- class pyCGM2.EMG.emgFilters.DiscreteEMGFilter(discreteEMGProcedure: DiscreteEmgProcedure, analysis: Analysis, emgLabels: List, emgMuscles: List, emgContexts: List, subjInfo: Dict | None = None, condExpInfo: Dict | None = None)#
Filter for handling discrete EMG procedures.
This filter is designed to apply a specified discrete EMG procedure to an analysis instance. It generates a Pandas DataFrame as output, containing the results of the discrete EMG analysis.
- Parameters:
discreteEMGProcedure (DiscreteEmgProcedure) – An instance of a discrete EMG procedure.
analysis (Analysis) – A pyCGM2 analysis instance containing EMG data.
emgLabels (List[str]) – List of EMG labels.
emgMuscles (List[str]) – Corresponding muscle names for EMG labels.
emgContexts (List[str]) – Context side (‘Left’, ‘Right’) for each EMG label.
subjInfo (Optional[Dict]) – Optional dictionary describing subject information.
condExpInfo (Optional[Dict]) – Optional dictionary describing experimental conditions.
- __init__(discreteEMGProcedure: DiscreteEmgProcedure, analysis: Analysis, emgLabels: List, emgMuscles: List, emgContexts: List, subjInfo: Dict | None = None, condExpInfo: Dict | None = None)#
Initializes the DiscreteEMGFilter with a procedure, analysis instance, EMG labels, muscles, contexts, and optional subject/experiment information.
Methods
__init__
(discreteEMGProcedure, analysis, ...)Initializes the DiscreteEMGFilter with a procedure, analysis instance, EMG labels, muscles, contexts, and optional subject/experiment information.
Run the discrete EMG procedure and get the output DataFrame.
setCondExpInf
(condExpInfo)Set experimental condition information for inclusion in the output DataFrame.
setSubjInfo
(subjInfo)Set subject information for inclusion in the output DataFrame.
- getOutput() DataFrame #
Run the discrete EMG procedure and get the output DataFrame.
Processes the specified EMG data using the discrete EMG procedure and generates a Pandas DataFrame containing the results.
- Returns:
pd.DataFrame – A DataFrame containing the results of the discrete EMG analysis.
- setCondExpInf(condExpInfo: Dict)#
Set experimental condition information for inclusion in the output DataFrame.
- Parameters:
condExpInfo (Dict) – Dictionary describing experimental conditions. Items from this dictionary will be added to the generated DataFrame.
- setSubjInfo(subjInfo: Dict)#
Set subject information for inclusion in the output DataFrame.
- Parameters:
subjInfo (Dict) – Dictionary describing subject information. Items from this dictionary will be added to the generated DataFrame.