info

Description

This module contains all the information regarding:

• Data
  • Structures of data
  • How to access data
• Abbreviations
• AboutUs
• Contacts
• Links
• CiteUs

data(emgfile)

Print a description of the emgfile data structure.

Print a detailed description of the emgfile data structure and of how to access the contained elements.

PARAMETER	DESCRIPTION
emgfile	The dictionary containing the emgfile. TYPE: dict

Examples:

>>> import openhdemg.library as emg
>>> emgfile = emg.askopenfile(filesource="DEMUSE")
>>> emg.info().data(emgfile)
emgfile type is:
<class 'dict'>
emgfile keys are:
dict_keys(['SOURCE', 'FILENAME', 'RAW_SIGNAL', 'REF_SIGNAL', 'ACCURACY', 'IPTS', 'MUPULSES', 'FSAMP', 'IED', 'EMG_LENGTH', 'NUMBER_OF_MUS', 'BINARY_MUS_FIRING', 'EXTRAS'])
Any key can be acced as emgfile[key].
emgfile['SOURCE'] is a <class 'str'> of value:
DEMUSE
.
.
.

abbreviations()

Print common abbreviations.

RETURNS	DESCRIPTION
abbr	The dictionary containing the abbreviations and their meaning. TYPE: dict

Examples:

>>> import openhdemg.library as emg
>>> emg.info().abbreviations()
"COV": "Coefficient of variation",
"DERT": "DERecruitment threshold",
"DD": "Double differential",
"DR": "Discharge rate",
"FSAMP": "Sampling frequency",
"IDR": "Instantaneous discharge rate",
"IED": "Inter electrode distance",
"IPTS": "Impulse train (decomposed source)",
"MU": "Motor units",
"MUAP": "MUs action potential",
"PIC": "Persistent inward currents",
"PNR": "Pulse to noise ratio",
"RT": "Recruitment threshold",
"SD": "Single differential",
"SIL": "Silhouette score",
"STA": "Spike-triggered average",
"SVR": "Support Vector Regression",
"XCC": "Cross-correlation coefficient"

aboutus()

Print informations about the library and the authors.

RETURNS	DESCRIPTION
about, us : str	The strings containing the information.

Examples:

>>> import openhdemg.library as emg
>>> emg.info().aboutus()
The openhdemg project was born in 2022 with the aim to provide a
free and open-source framework to analyse HIGH-DENSITY EMG
recordings...

contacts()

Print the contacts.

RETURNS	DESCRIPTION
contacts	The dictionary containing the contact details. TYPE: dict

Examples:

>>> import openhdemg.library as emg
>>> emg.info().contacts()
"Primary contact": "openhdemg@gmail.com",
"Twitter": "@openhdemg",
"Maintainer": "Giacomo Valli",
"Maintainer Email": "giacomo.valli@unibs.it",

links()

Print a collection of useful links.

RETURNS	DESCRIPTION
links	The dictionary containing the useful links. TYPE: dict

Examples:

>>> import openhdemg.library as emg
>>> emg.info().links()

citeus()

Print how to cite the project.

RETURNS	DESCRIPTION
cite	The full citation. TYPE: str

Examples:

>>> import openhdemg.library as emg
>>> emg.info().citeus()