pyCGM2.Nexus#

Devices#

Channel(label, values, unit, description)

Represents a channel in a pyCGM2-Nexus interface.

Device(NEXUS, id)

Represents a generic device in a pyCGM2-Nexus interface.

AnalogDevice(NEXUS, id)

Represents an analog device in a pyCGM2-Nexus interface, extending the Device class.

ForcePlate(NEXUS, id)

Represents a force plate device in a pyCGM2-Nexus interface, extending the Device class.

Filters#

NexusModelFilter(NEXUS, iModel, iAcq, ...[, ...])

Nexus Model Filter is an interface running the method viconExport of a pyCGM2 Model instance.

NexusConstructAcquisitionFilter(NEXUS, ...)

Filter for constructing a btk.Acquisition from Nexus API.

Tools#

appendAnalysisParameters(NEXUS, acq)

Appends analysis parameters to a BTK acquisition.

appendAngleFromAcq(NEXUS, vskName, label, acq)

Appends an angle data to Nexus from a BTK acquisition.

appendBones(NEXUS, vskName, acq, label, segment)

Appends a Vicon bone from a BTK acquisition.

appendBtkScalarFromAcq(NEXUS, vskName, ...)

Appends BTK scalar to the acquisition instance.

appendForceFromAcq(NEXUS, vskName, label, acq)

Appends force data to Nexus from a BTK acquisition.

appendModelledMarkerFromAcq(NEXUS, vskName, ...)

Appends a modeled marker to Nexus from a BTK acquisition.

appendMomentFromAcq(NEXUS, vskName, label, acq)

Appends moment data to Nexus from a BTK acquisition.

appendPowerFromAcq(NEXUS, vskName, label, acq)

Appends power data to Nexus from a BTK acquisition.

checkActivatedSubject(NEXUS, subjectNames)

Checks and retrieves the activated subject in Nexus (Obsolete, use getActiveSubject instead).

createEvents(NEXUS, subject, acq, labels)

Appends specific events from a BTK acquisition to Nexus.

createGeneralEvents(NEXUS, subject, acq, labels)

Appends general events from a BTK acquisition to Nexus.

getActiveSubject(NEXUS)

Retrieves the active subject from Nexus.

getForcePlateAssignment(NEXUS)

Retrieves force plate assignments from Nexus.

setTrajectoryFromAcq(NEXUS, vskName, label, acq)

Sets a trajectory in Nexus using data from a BTK acquisition.

setTrajectoryFromArray(NEXUS, vskName, ...)

Sets a trajectory in Nexus using data from an array.

Utils#

getNexusSubjectMp(NEXUS, subject[, resetFlag])

Retrieves required and optional anthropometric parameters from Nexus.

updateNexusSubjectMp(NEXUS, model, subjectName)

Updates anthropometric parameters in Nexus from a pyCGM2 model instance.

Connection#

NexusConnection()

Connection to a running Vicon Nexus instance.

Additional tools#

checkEvents(NEXUS, subject, event_names)

check the presence of events from nexus

getTrialName(NEXUS)

Return the folder and the name of the trial loaded in Nexus.

updateEvents(NEXUS, subject, acq)

Appends specific events from a BTK acquisition to Nexus.

Vsk#

Vsk(file)

Class for handling vsk files.

checkSetReadOnly(vskfilename)

Checks if a vsk file is in read-only mode and modifies it if necessary.

getFromVskSubjectMp(vskInstance[, resetFlag])

Returns CGM anthropometric data (mass parameters) of a pyCGM2.Eclipse.Vsk instance.

getVskFiles(path)

Returns vsk files detected in a folder.