common.enums

A file to hold common enums

class common.enums.Commands(value)

The enum of all possible commands to be sent to the backend

QUIT = 1

EVAL_PYTHON = 2

LOAD = 3

GET = 4

SAVE = 5

CONNECT = 6

REPLAY = 7

REFILTER = 8

TRAIN = 9

TRAIN_AUTOENC = 10

TEST_EVAL = 11

CONVERT_FILE = 12

UPDATE = 13

COLLECT = 14

TEST = 15

CONTROL = 16

DUAL = 17

STORE = 18

SWAP = 19

EXPORT = 20

LOAD_MULTIPLE = 24

SIMULATE_EMG = 26

SIMULATE_XHAT = 27

MOV_DETECT = 28

CALIBRATE = 29

CROSS_VALIDATION = 30

PAUSE_EMG = 31

RESUME_EMG = 32

LOAD_DETECTOR_REPLAY = 33

RUN_PY_SCRIPT = 34

SAVE_COMMAND_HISTORY = 35

class common.enums.CommandResponses(value)

Enum of all possible responses the backend will provide to a Command or AyncCommand

SUCCESS = 1

ERROR = 2

PROMPT = 3

PLOT = 4

EVAL_PYTHON = 5

class common.enums.DataStatus(value)

The status of the backend data

NO_DATA = 'No Data'

LOADED = 'Loaded'

SAVED = 'Saved'

RECORDING = 'Recording'

RECORDED = 'Recorded (Unsaved)'

REFILTERING = 'Refiltering'

REFILTERED = 'Refiltered (Unsaved)'

MULTIPLE = 'Multiple Files Loaded'

class common.enums.DecoderStatus(value)

The status of the backend’s decoder

NO_DECODER = 'No Decoder'

LOADED = 'Loaded'

SAVED = 'Saved'

TRAINING = 'Training'

TRAINED = 'Trained (Unsaved)'

UPDATING = 'Updating'

UPDATED = 'Updated (Unsaved)'

class common.enums.AutoencStatus(value)

The status of the backend’s autoencoder

NO_AUTOENC = 'No Autoenc'

LOADED = 'Loaded'

SAVED = 'Saved'

TRAINING = 'Training'

TRAINED = 'Trained (Unsaved)'

UPDATING = 'Updating'

UPDATED = 'Updated (Unsaved)'

class common.enums.UpdateType(value)

The type of update that the frontend gives the backend. This is given as a parameter in the backend’s update() method to determine which data the backend should update using the other params included in that update() method

GENERAL_SETTINGS = 1

RAW_SETTINGS = 2

OUTPUT_SETTINGS = 3

TRAIN_MOVS = 4

TEST_MOVS = 5

FILTER = 6

FEATURES = 7

DECODER = 8

AUTOENCODER = 9

RESULTS = 10

TRAINER = 11

COLLECTOR = 12

TESTER = 13

MOV_DETECTOR = 14

FEATURE_SETTINGS = 15

EMG_SIMULATOR = 16

ANALYSIS_PACKET_SELECTED = 17

XHAT_SIMULATOR = 18

RESULT_SETTINGS = 19

class common.enums.AsyncCommands(value)

Commands that the GUI sends the backend asynchronously.

TOGGLE_VERBOSE = 1

TOGGLE_GRAPHS = 2

TOGGLE_FILTER_GRAPHS = 3

SHORTEN_TIMESTEP = 4

LENGTHEN_TIMESTEP = 5

SLOW_REPLAY = 6

SPEED_UP_REPLAY = 7

SHRINK_WINDOW_SIZE = 8

EXPAND_WINDOW_SIZE = 9

TOGGLE_2_CHANNEL_VIEW = 10

STOP_TASK = 11

TOGGLE_COMPRESS = 12

DISCONNECT = 13

TOGGLE_SRB2 = 14

EVAL_PYTHON = 15

PLOT_CURRENT = 16

PLOT_MULTIPLE = 17

COMPARE = 18

LOAD_ANALYSIS = 19

TOGGLE_SCROLL = 20

TOGGLE_OUTPUT_FILTERS = 21

TOGGLE_RAW_PLOTS = 22

TOGGLE_RECORD_COMMANDS = 23

CLEAR_COMMAND_HISTORY = 24

GET_STATUS = 101

GET_DIRECTORY = 102

FILE_EXISTS = 103

class common.enums.PlotCommands(value)

Commands the backend process sends the plotter process over the plot pipe

RESIZE = 0

REINIT = 1

UPDATE = 2

FILTER = 3

PLOT = 4

HIDE = 5

SHOW = 6

BUFFER = 7

class common.enums.ColumnPlotCommands(value)

Commands the backend process sends the column plotter process over the column plot pipe

PLOT = 0

SHOW = 1

HIDE = 2

N_COL = 3

THRESHOLD = 4

class common.enums.FeatureType(value)

All available types of features

MAV = 'Mean Absolute Value'

MFL = 'Maximum Fractal Length'

POS_DERIVS = 'Position Derivatives'

ZERO_CROSS = 'Zero Crossings'

WAVE_LENGTH = 'Waveform Length'

SLOPE_CHANGE = 'Slope Sign Changes'

RAW = 'Raw Data Group Vectorized'

class common.enums.CollectType(value)

All available types of collectors

TRAJECTORY = 'Trajectory'

FREE = 'Free Collect'

SOURCE = 'Source'

ACTION = 'Action Selection'

class common.enums.TestType(value)

All available types of testers

TARGET = 'Target'

TRAJECTORY = 'Trajectory'

FREE = 'Free Test'

SOURCE = 'Source'

FILE = 'File'

class common.enums.FilterType(value)

Types of filters

FIR = 'FIR'

IIR = 'IIR'

class common.enums.AutoencoderMode(value)

The way in which the autoencoder is used

OFF = 0

NO_GRADIENT = 1

AUTOENC_GRADIENT = 2

AUTOENC_AND_DECODER_GRADIENT = 3

class common.enums.ControlType(value)

What the program outputs its control signals to

MUJOCO_HAND = 'Mujoco Hand'

ROBOTIC_HAND = 'Robotic Hand'

COLUMNS = 'Columns'

NONE = 'None'

class common.enums.SubjectType(value)

Whether the program records finger data from the glove or not

INTACT = 'Intact'

AMPUTEE = 'Amputee'

class common.enums.SourceType(value)

Whether the data for the current test is pulled from a file or not

LIVE = 'Live'

FILE = 'File'

GEN = 'Generated Trajectory'

class common.enums.DataType(value)

the purpose of the current data

TEST = 'test'

TRAIN = 'train'

NO_DATA = 'NO_DATA'

MULTIPLE = 'MULTIPLE_DATA'

class common.enums.SampleType(value)

What type of data this sample is

PROMPT = 0

MOVE = 1

REST = 2

class common.enums.ResultType(value)

All available types of test results calculations

RISE_TIME = 'Rise Time'

FIRST_HOLD_TIME = 'First Hold Time'

MAX_HOLD_TIME = 'Max Hold Time'

RATIO_ON_TARGET = 'Ratio on Target'

TRAJECTORY_LENGTH = 'Trajectory Length'

SUCCESS = 'Success'

RMSE_MOVING = 'RMSE (Moving DOF)'

RMSE_STATIONARY = 'RMSE (Stationary DOF)'

RMSE_TOTAL = 'RMSE (Total)'

RMSE_ALL = 'RMSE (All DOFs)'

RMSE_CROSS = 'Cross RMSE'

R_SQUARED = 'R^2'

LMAJ = 'Log Mean Absolute Jerk'

DOF_CORRELATION = 'DOF Correlation'

MSE_NORM = 'Normalized MSE'

RMSE = 'RMSE'

MSE = 'MSE'

MSE_MOVING = 'MSE (Moving DOF)'

MSE_STATIONARY = 'MSE (Stationary DOF)'

class common.enums.TimingType(value)

An enumeration.

DECODER = 'Decoder'

FEATURE = 'Feature'

FILTER = 'Filter'

FINGER = 'Finger'

OUTPUT = 'Output'

OUTPUT_LOOP = 'Output Loop'