neurodec.mdt.MotorUnitsActionPotentials#

class neurodec.mdt.MotorUnitsActionPotentials(dictionary: dict)#

The action potentials for all motor units of a single muscle

property data: ArrayLike#

Returns the data associated with this MUAP

property id: int#

Returns the ID of the object

classmethod new(fibers: Fibers, fiber_basis: FiberBasis, fiber_properties: FiberProperties, motor_units: MotorUnits, sampling_frequency: float, force_computation: bool = False) → MotorUnitsActionPotentials#

Create new motor units action potentials for a single muscle

Creates new motor units action potentials (MUAPs) for the fibers of a muscle. This will initiate a call to the Neurodec Myoelectric Digital Twin (MDT) API that will generate MUAPs and return their metadata.

Parameters

  • fibers – The fibers for which to generate the MUAPs.

  • fiber_basis – The fiber basis for which to generate the MUAPs.

  • fiber_properties – The fiber properties for which to generate the MUAPs.

  • motor_units – The motor units for which to generate the MUAPs.

  • sampling_frequency – The sampling frequency of the output MUAPs, in Hertz.

  • force_computation – Boolean flag that allows to bypass a status check. Normally, the API would check if an object with the requested parameters was already present in the database. If this was the case, the API would not request its computation and would simply return its identifier. By setting this flag to True, the user can bypass this logic and force the computation of the resource even if it existed already. The main reason is to allow starting a calculation again in case of unexpected errors.

Returns

The metadata of the new MUAPs. If another set of MUAPs with the same parameters already exits, those will be returned instead of generating a new ones.

property status: Status#

Returns the up-to-date status of the object, by performing an API request.

wait()#

Wait for the object to be ready