Settings

Settings are located in the folder ProgramData/pyCGM2. They need to match with your clinical routine

Note

Settings follow the yaml syntax.

if you are facing with a syntax error. You can check online your own settings

CGM 1 Settings.

Warning

By default, the flat foot option is enable on both side and joint moments are expressed into the Distal segment

Global:
    Marker diameter: 14 #[double]
    Point suffix: None #[string]

Translators: # Translators adapt your current marker set
    LASI: None #[string]
    RASI: None
    LPSI: None
    RPSI: None
    RTHI: None
    RKNE: None
    RTIB: None
    RANK: None
    RMED: None
    RHEE: None
    RTOE: None
    LTHI: None
    LKNE: None
    LTIB: None
    LANK: None
    LMED: None
    LHEE: None
    LTOE: None
    C7: None
    T10: None
    CLAV: None
    STRN: None
    LFHD: None
    LBHD: None
    RFHD: None
    RBHD: None
    LSHO: None
    LELB: None
    LWRB: None
    LWRA: None
    LFIN: None
    RSHO: None
    RELB: None
    RWRB: None
    RWRA: None
    RFIN: None

Calibration:
    Left flat foot: 1 #[integer](choice: 0 or 1)
    Right flat foot: 1
    Head flat : 1

Fitting:
    Moment Projection: Distal #[string](choice: Proximal, Global, Distal)


################
# DO NOT TOUCH #
################

ModelVersion: CGM1.0

CGM 1.1 Settings.

Warning

The main difference with the CGM1 is the projection of joint moment into the Joint Coordinate System

Global:
    Marker diameter: 14 #[double]
    Point suffix: None #[string]

Translators: #Translators adapt your current marker set
    LASI: None #[string]
    RASI: None
    LPSI: None
    RPSI: None
    RTHI: None
    RKNE: None
    RKNM: None
    RTIB: None
    RANK: None
    RMED: None
    RHEE: None
    RTOE: None
    LTHI: None
    LKNE: None
    LKNM: None
    LTIB: None
    LANK: None
    LMED: None
    LHEE: None
    LTOE: None
    C7: None
    T10: None
    CLAV: None
    STRN: None
    LFHD: None
    LBHD: None
    RFHD: None
    RBHD: None
    LSHO: None
    LELB: None
    LWRB: None
    LWRA: None
    LFIN: None
    RSHO: None
    RELB: None
    RWRB: None
    RWRA: None
    RFIN: None

Calibration:
    Left flat foot: 1 #[integer](choice: 0 or 1)
    Right flat foot: 1
    Head flat : 1

Fitting:
    Moment Projection: JCS #[string](choice: Proximal, Global, Distal, JCS)


################
# DO NOT TOUCH #
################

ModelVersion: CGM1.1

CGM 2.1 Settings.

Warning

The Hip joint centre is located according Hara’s equations

Global:
    Marker diameter: 14 #[double]
    Point suffix: None #[string]

Translators: # Translators adapt your current marker set
    LASI: None #[string]
    RASI: None
    LPSI: None
    RPSI: None
    RTHI: None
    RKNE: None
    RKNM: None
    RTIB: None
    RANK: None
    RMED: None
    RHEE: None
    RTOE: None
    LTHI: None
    LKNE: None
    LKNM: None
    LTIB: None
    LANK: None
    LMED: None
    LHEE: None
    LTOE: None
    C7: None
    T10: None
    CLAV: None
    STRN: None
    LFHD: None
    LBHD: None
    RFHD: None
    RBHD: None
    LSHO: None
    LELB: None
    LWRB: None
    LWRA: None
    LFIN: None
    RSHO: None
    RELB: None
    RWRB: None
    RWRA: None
    RFIN: None


##### Calibration ########

Calibration:
    HJC:
        Left: Hara #[string](choice: Hara)
        Right:  Hara
    Left flat foot:  1 #[integer](choice: 0 or 1)
    Right flat foot:  1
    Head flat : 1

Fitting:
    Moment Projection: JCS #[string](choice: Proximal, Global, Distal, JCS)



################
# DO NOT TOUCH #
################

ModelVersion: CGM2.1

CGM 2.2 Settings.

These settings define a uniform weight set for the inverse kinematics.

Global:
    Marker diameter: 14 #[double]
    Point suffix: None #[string]

Translators: # Translators adapt your current marker set
  LASI: None #[string]
  RASI: None
  LPSI: None
  RPSI: None
  RTHI: None
  RKNE: None
  RKNM: None
  RTIB: None
  RANK: None
  RMED: None
  RHEE: None
  RTOE: None
  LTHI: None
  LKNE: None
  LKNM: None
  LTIB: None
  LANK: None
  LMED: None
  LHEE: None
  LTOE: None
  C7: None
  T10: None
  CLAV: None
  STRN: None
  LFHD: None
  LBHD: None
  RFHD: None
  RBHD: None
  LSHO: None
  LELB: None
  LWRB: None
  LWRA: None
  LFIN: None
  RSHO: None
  RELB: None
  RWRB: None
  RWRA: None
  RFIN: None

Calibration:
    HJC:
        Left: Hara #[string](choice: Hara only)
        Right: Hara
    Left flat foot: 1 #[integer] (choice: 0 or 1)
    Right flat foot: 1
    Head flat : 1

Fitting:
    Moment Projection: JCS #[string](choice: Proximal, Global, Distal, JCS)
    Weight:
        LASI: 100 #[double] : marker weight used by the Inverse Kinematics solver
        RASI: 100
        LPSI: 100
        RPSI: 100
        LTHI: 100
        LKNE: 100
        LTIB:  100
        LANK: 100
        LHEE: 100
        LTOE: 100
        RTHI: 100
        RKNE: 100
        RTIB:  100
        RANK: 100
        RHEE: 100
        RTOE: 100



################
# DO NOT TOUCH #
################

ModelVersion: CGM2.2

CGM 2.3 Settings.

These settings define a uniform weight set for the inverse kinematics.

Danger

By default, the CGM2.3 uses an inverse kinematics solver. The option EnableIK allow to disable Inverse Kinematics. In this case, the CGM2.3 works as a 6-Dof model

Global:
    Marker diameter: 14 #[double]
    Point suffix: None #[string]
    EnableIK: 1 #[integer](choice: 0 or 1): enable  the Inverse Kinematics solver

Translators: # Translators adapt your current marker set
    LASI: None  #[string]
    RASI: None
    LPSI: None
    RPSI: None
    RTHI: None
    RKNE: None
    RKNM: None
    RTHAP: None
    RTHAD: None
    RTIB: None
    RANK: None
    RMED: None
    RTIAP: None
    RTIAD: None
    RHEE: None
    RTOE: None
    LTHI: None
    LKNE: None
    LKNM: None
    LTHAP: None
    LTHAD: None
    LTIB: None
    LANK: None
    LMED: None
    LTIAP: None
    LTIAD: None
    LHEE: None
    LTOE: None
    C7: None
    T10: None
    CLAV: None
    STRN: None
    LFHD: None
    LBHD: None
    RFHD: None
    RBHD: None
    LSHO: None
    LELB: None
    LWRB: None
    LWRA: None
    LFIN: None
    RSHO: None
    RELB: None
    RWRB: None
    RWRA: None
    RFIN: None

Calibration:
    HJC:
        Left: Hara #[string](choice: Hara only)
        Right: Hara
    Left flat foot: 1 #[integer](choice: 0 or 1)
    Right flat foot: 1
    Head flat : 1

Fitting:
    Moment Projection: JCS #[string](choice: Proximal, Global, Distal, JCS)
    Weight:
        LASI: 100 #[double]: marker weight used by the Inverse Kinematics solver
        RASI: 100
        LPSI: 100
        RPSI: 100
        RTHI: 100
        RKNE: 100
        RTHAP: 100
        RTHAD: 100
        RTIB: 100
        RANK: 100
        RTIAP: 100
        RTIAD: 100
        RHEE: 100
        RTOE: 100
        LTHI: 100
        LKNE: 100
        LTHAP: 100
        LTHAD: 100
        LTIB: 100
        LANK: 100
        LTIAP: 100
        LTIAD: 100
        LHEE: 100
        LTOE: 100
        RTHLD: 0
        RPAT: 0
        LTHLD: 0
        LPAT: 0


################
# DO NOT TOUCH #
################

ModelVersion: CGM2.3

CGM 2.4 Settings.

These settings define a uniform weight set for the inverse kinematics.

Danger

By default, the CGM2.4 uses an inverse kinematics solver. The option EnableIK allow to disable Inverse Kinematics. In this case, the CGM2.4 works as a 6-Dof model

Global:
  Marker diameter: 14 #[double]
  Point suffix:  None #[string]
  EnableIK: 1 #[integer](choice: 0 or 1):  enable  the Inverse Kinematics solver

Translators: # Translators adapt your current marker set
    LASI: None #[string]
    RASI: None
    LPSI: None
    RPSI: None
    RTHI: None
    RKNE: None
    RTIAP: None
    RTIAD: None
    RTIB: None
    RANK: None
    RTIAP: None
    RTIAD: None
    RHEE: None
    RSMH: None
    RTOE: None
    RFMH: None
    RVMH: None
    LTHI: None
    LKNE: None
    LTHAP: None
    LTHAD: None
    LTIB: None
    LANK: None
    LTIAP: None
    LTIAD: None
    LHEE: None
    LSMH: None
    LTOE: None
    LFMH: None
    LVMH: None
    RKNM: None
    LKNM: None
    RMED: None
    LMED: None
    C7: None
    T10: None
    CLAV: None
    STRN: None
    LFHD: None
    LBHD: None
    RFHD: None
    RBHD: None
    LSHO: None
    LELB: None
    LWRB: None
    LWRA: None
    LFIN: None
    RSHO: None
    RELB: None
    RWRB: None
    RWRA: None
    RFIN: None

Calibration:
    HJC:
        Left: Hara #[string](choice: Hara only)
        Right: Hara
    Left flat foot: 1 [integer]
    Right flat foot: 1
    Head flat : 1

Fitting:
    Moment Projection: JCS #[string](choice: Proximal, Global, Distal, JCS)
    Weight:
        LASI: 100 #[double]: marker weight used by the Inverse Kinematics solver
        RASI: 100
        LPSI: 100
        RPSI: 100
        RTHI: 100
        RKNE: 100
        RTHAP: 100
        RTHAD: 100
        RTIB: 100
        RANK: 100
        RTIAP: 100
        RTIAD: 100
        RHEE: 100
        RSMH: 0
        RTOE: 100
        RFMH: 100
        RVMH: 100
        LTHI: 100
        LKNE: 100
        LTHAP: 100
        LTHAD: 100
        LTIB: 100
        LANK: 100
        LTIAP: 100
        LTIAD: 100
        LHEE: 100
        LSMH: 0
        LTOE: 100
        LFMH: 100
        LVMH: 100
        RTHLD: 0
        RPAT: 0
        LTHLD: 0
        LPAT: 0



################
# DO NOT TOUCH #
################

ModelVersion: CGM2.4

CGM 2.5 Settings.

These settings define a uniform weight set for the inverse kinematics.

Danger

By default, the CGM2.5 uses an inverse kinematics solver. The option EnableIK allow to disable Inverse Kinematics. In this case, the CGM2.5 works as a 6-Dof model

Global:
  Marker diameter: 14 #[double]
  Point suffix:  None #[string]
  EnableIK: 1 #[integer](choice: 0 or 1):  enable  the Inverse Kinematics solver

Translators: # Translators adapt your current marker set
    LASI: None #[string]
    RASI: None
    LPSI: None
    RPSI: None
    RTHI: None
    RKNE: None
    RTIAP: None
    RTIAD: None
    RTIB: None
    RANK: None
    RTIAP: None
    RTIAD: None
    RHEE: None
    RSMH: None
    RTOE: None
    RFMH: None
    RVMH: None
    LTHI: None
    LKNE: None
    LTHAP: None
    LTHAD: None
    LTIB: None
    LANK: None
    LTIAP: None
    LTIAD: None
    LHEE: None
    LSMH: None
    LTOE: None
    LFMH: None
    LVMH: None
    RKNM: None
    LKNM: None
    RMED: None
    LMED: None
    C7: T2 # cf Armand et al.2013 https://doi.org/10.1016/j.gaitpost.2013.06.016
    T10: None
    CLAV: None
    STRN: CLAV
    LFHD: GLAB #Eames et al.1999 10.1016/S0167-9457(99)00022-6
    LBHD: LMAS
    RFHD: GLAB
    RBHD: RMAS
    LSHO: None
    LELB: None
    LWRB: None
    LWRA: None
    LFIN: None
    RSHO: None
    RELB: None
    RWRB: None
    RWRA: None
    RFIN: None

Calibration:
    HJC:
        Left: Hara #[string](choice: Hara only)
        Right: Hara
    Left flat foot: 1 [integer]
    Right flat foot: 1
    Head flat : 1

Fitting:
    Moment Projection: JCS #[string](choice: Proximal, Global, Distal, JCS)
    Weight:
        LASI: 100 #[double]: marker weight used by the Inverse Kinematics solver
        RASI: 100
        LPSI: 100
        RPSI: 100
        RTHI: 100
        RKNE: 100
        RTHAP: 100
        RTHAD: 100
        RTIB: 100
        RANK: 100
        RTIAP: 100
        RTIAD: 100
        RHEE: 100
        RSMH: 0
        RTOE: 100
        RFMH: 100
        RVMH: 100
        LTHI: 100
        LKNE: 100
        LTHAP: 100
        LTHAD: 100
        LTIB: 100
        LANK: 100
        LTIAP: 100
        LTIAD: 100
        LHEE: 100
        LSMH: 0
        LTOE: 100
        LFMH: 100
        LVMH: 100
        RTHLD: 0
        RPAT: 0
        LTHLD: 0
        LPAT: 0



################
# DO NOT TOUCH #
################

ModelVersion: CGM2.5

EMG Settings.

This setting propose a typical emg configuration in clinical gait analysis.

Warning

Adapt it to your practice

In the proposed configuration, your 3D data collection software will define emg signals as ENG1, EMG2…EMG16. The EMG1 is located on the Left Rectus femoris and its normal activities (RECFEM) will be displayed in the background

########## EMG configuration ##########
# The configuration below considers the emg signals are named EMG1,EMG2... EMG16 in your c3d.
# items:
#  - "Muscle" is the name of the muscle where is placed the emg device
#  - "Context" indicates if you want to plot on a left or right gait cycle.
#  - "NormalActivity" defines the muscle whose normal activity will be plotted in background.
#     Values are the normal adult activities defined in Vicon Clinical Manager.
#     you can select :
#         -ADDBRE
#         -ADDLON
#         -ADDMAG
#         -BICFEM
#         -CALF
#         -EXTDIGLON
#         -EXTHALLON
#         -FLEDIGLON
#         -FLEHALLON
#         -GASTRO
#         -GLUMAX
#         -GLUMED
#         -GLUMIN
#         -GRACIL
#         -HAMSTR
#         -HIPABD
#         -HIPADD
#         -HIPEXT
#         -HIPFLE
#         -ILIACU
#         -ILIOPS
#         -LATHAM
#         -LATQUA
#         -MEDHAM
#         -MEDQUA
#         -PERBRE
#         -PERLON
#         -POPLIT
#         -RECFEM
#         -SARTOR
#         -SEMIME
#         -SEMITE
#         -SOLEUS
#         -TENFACLAT
#         -TIBANT
#         -TIBPOS
#         -VASINT
#         -VASLAT
#         -VASMEDLON
#         -VASMEDOBL
########## EMG configuration ##########



CHANNELS:
    Voltage.EMG1 :
        Muscle : RECFEM #[string]
        Context : Left #[string](choice: Left or Right)
        NormalActivity : RECFEM #[string](choice: see above)

    Voltage.EMG2 :
        Muscle : RECFEM
        Context : Right
        NormalActivity : RECFEM

    Voltage.EMG3 :
        Muscle : VASLAT
        Context : Left
        NormalActivity : VASLAT

    Voltage.EMG4 :
        Muscle : VASLAT
        Context : Right
        NormalActivity : VASLAT

    Voltage.EMG5 :
        Muscle : SEMITE
        Context : Left
        NormalActivity : SEMITE

    Voltage.EMG6 :
        Muscle : SEMITE
        Context : Right
        NormalActivity : SEMITE

    Voltage.EMG7 :
        Muscle : TIBANT
        Context : Left
        NormalActivity : TIBANT

    Voltage.EMG8 :
        Muscle : TIBANT
        Context : Right
        NormalActivity : TIBANT

    Voltage.EMG9 :
        Muscle : SOLEUS
        Context : Left
        NormalActivity : SOLEUS

    Voltage.EMG10 :
        Muscle : SOLEUS
        Context : Right
        NormalActivity : SOLEUS

    Voltage.EMG11 :
        Muscle : None
        Context : None
        NormalActivity : None

    Voltage.EMG12 :
        Muscle : None
        Context : None
        NormalActivity : None

    Voltage.EMG13 :
        Muscle : None
        Context : None
        NormalActivity : None

    Voltage.EMG14 :
        Muscle : None
        Context : None
        NormalActivity : None

    Voltage.EMG15 :
        Muscle : None
        Context : None
        NormalActivity : None

    Voltage.EMG16 :
        Muscle : None
        Context : None
        NormalActivity : None


################
# ADVANCED     #
################

Processing:
  BandpassFrequencies: [20,200] #[array of two double]: frequencies of the bandpass filter
  EnvelopLowpassFrequency: 6 #[double]: emg envelop frequency