TrialEnfReader

class pyCGM2.Nexus.eclipse.TrialEnfReader(path: str, enfFile: str)

A class for handling a Trial.enf file created by Vicon Eclipse.

Inherits from EnfReader.

__init__(path: str, enfFile: str)

Initializes the SessionEnfReader object.

Methods

__init__(path, enfFile)	Initializes the SessionEnfReader object.
get(label)	Retrieves the value of a specified parameter from the Trial.enf file.
getC3d()	Retrieves the corresponding .c3d filename for the Trial.enf file.
getFile()	Retrieves the filename of the .enf file.
getForcePlateAssigment()	Retrieves the force plate assignment from the Trial.enf file.
getPath()	Retrieves the path of the folder containing the .enf file.
getSection(section)	Returns the content of a specified section from the .enf file.
getTrialInfos()	Retrieves the trial information section from the Trial.enf file.
isC3dExist()	Checks if the corresponding .c3d file for the Trial.enf exists.
save()	"
set(label, value)	Sets the value of a specified parameter in the Trial.enf file.
setForcePlates(mappedForcePlateCharacters)	Assigns force plates based on the provided mapping characters.

get(label: str)

Retrieves the value of a specified parameter from the Trial.enf file.

Parameters:

label (str) – The name of the parameter.

Returns:

Any – The value of the specified parameter.

getC3d()

Retrieves the corresponding .c3d filename for the Trial.enf file.

Returns:

str – The .c3d filename.

getForcePlateAssigment()

Retrieves the force plate assignment from the Trial.enf file.

Returns:

str – A string indicating the assignment of force plates.

getTrialInfos()

Retrieves the trial information section from the Trial.enf file.

Returns:

dict – A dictionary containing trial information.

isC3dExist()

Checks if the corresponding .c3d file for the Trial.enf exists.

Returns:

bool – True if the .c3d file exists, False otherwise.

save()

” Saves the changes made to the Trial.enf file.

set(label: str, value: str)

Sets the value of a specified parameter in the Trial.enf file.

Parameters:

• label (str) – The name of the parameter.

• value (str) – The value to be set.

setForcePlates(mappedForcePlateCharacters: str)

Assigns force plates based on the provided mapping characters.

Parameters:

mappedForcePlateCharacters (str) – Characters indicating the side assigned to each force plate.