rofunc.devices.optitrack.windows_server.DataDescriptions#

1.  Module Contents#

1.1.  Classes#

MarkerSetDescription

RBMarker

RigidBodyDescription

SkeletonDescription

ForcePlateDescription

DeviceDescription

Device Description class

CameraDescription

Camera Description class

DataDescriptions

Data Descriptions class

1.2.  Functions#

get_tab_str

add_lists

test_hash

test_hash2

get_as_string

get_data_sub_packet_type

generate_marker_set_description

generate_marker_set_description - Testing functions

generate_rb_marker

generate_rb_marker - Generate rigid body marker based on marker number

generate_rigid_body_description

generate_rigid_body_description - Generate Rigid Body Description Data

generate_skeleton_description

generate_skeleton_description -Generate Test SkeletonDescription Data

generate_force_plate_description

generate_force_plate_description - Generate Test ForcePlateDescription Data

generate_device_description

generate_device_description- Generate Test DeviceDescription Data

generate_camera_description

generate_camera_description - Generate Test CameraDescription data

generate_data_descriptions

Generate data descriptions

test_all

Test all the Data Description classes

1.3.  Data#

K_SKIP

K_FAIL

K_PASS

1.4.  API#

rofunc.devices.optitrack.windows_server.DataDescriptions.K_SKIP = [0, 0, 1]#
rofunc.devices.optitrack.windows_server.DataDescriptions.K_FAIL = [0, 1, 0]#
rofunc.devices.optitrack.windows_server.DataDescriptions.K_PASS = [1, 0, 0]#
rofunc.devices.optitrack.windows_server.DataDescriptions.get_tab_str(tab_str, level)[source]#
rofunc.devices.optitrack.windows_server.DataDescriptions.add_lists(totals, totals_tmp)[source]#
rofunc.devices.optitrack.windows_server.DataDescriptions.test_hash(test_name, test_hash_str, test_object)[source]#
rofunc.devices.optitrack.windows_server.DataDescriptions.test_hash2(test_name, test_hash_str, test_object, run_test=True)[source]#
rofunc.devices.optitrack.windows_server.DataDescriptions.get_as_string(input_str)[source]#
rofunc.devices.optitrack.windows_server.DataDescriptions.get_data_sub_packet_type(new_data)[source]#
class rofunc.devices.optitrack.windows_server.DataDescriptions.MarkerSetDescription[source]#

Initialization

set_name(new_name)[source]#
get_num_markers()[source]#
add_marker_name(marker_name)[source]#
get_as_string(tab_str='  ', level=0)[source]#
class rofunc.devices.optitrack.windows_server.DataDescriptions.RBMarker(marker_name='', active_label=0, pos=[0.0, 0.0, 0.0])[source]#

Initialization

get_as_string(tab_str='  ', level=0)[source]#
class rofunc.devices.optitrack.windows_server.DataDescriptions.RigidBodyDescription(sz_name='', new_id=0, parent_id=0, pos=[0.0, 0.0, 0.0])[source]#

Initialization

set_name(new_name)[source]#
set_id(new_id)[source]#
set_parent_id(parent_id)[source]#
set_pos(p_x, p_y, p_z)[source]#
get_num_markers()[source]#
add_rb_marker(new_rb_maker)[source]#
get_as_string(tab_str='  ', level=0)[source]#
class rofunc.devices.optitrack.windows_server.DataDescriptions.SkeletonDescription(name='', new_id=0)[source]#

Initialization

set_name(new_name)[source]#
set_id(new_id)[source]#
add_rigid_body_description(rigid_body_description)[source]#
get_as_string(tab_str='  ', level=0)[source]#
class rofunc.devices.optitrack.windows_server.DataDescriptions.ForcePlateDescription(new_id=0, serial_number='')[source]#

Initialization

set_id(new_id)[source]#
set_serial_number(serial_number)[source]#
set_dimensions(width, length)[source]#
set_origin(p_x, p_y, p_z)[source]#
set_cal_matrix(cal_matrix)[source]#
set_corners(corners)[source]#
set_plate_type(plate_type)[source]#
set_channel_data_type(channel_data_type)[source]#
add_channel_name(channel_name)[source]#
get_cal_matrix_as_string(tab_str='', level=0)[source]#

Get force plate calibration matrix as string

get_corners_as_string(tab_str='', level=0)[source]#

Get force plate corner positions as a string

get_as_string(tab_str='  ', level=0)[source]#

Get force plate description as a class

class rofunc.devices.optitrack.windows_server.DataDescriptions.DeviceDescription(new_id, name, serial_number, device_type, channel_data_type)[source]#

Device Description class

Initialization

set_id(new_id)[source]#

Set the device id

set_name(name)[source]#

Set the Device name

add_channel_name(channel_name)[source]#

Add channel name to channel_list

get_as_string(tab_str='  ', level=0)[source]#

Get Device Description as string

class rofunc.devices.optitrack.windows_server.DataDescriptions.CameraDescription(name, position_vec3, orientation_quat)[source]#

Camera Description class

Initialization

get_as_string(tab_str='..', level=0)[source]#

Get Camera Description as a string

class rofunc.devices.optitrack.windows_server.DataDescriptions.DataDescriptions[source]#

Data Descriptions class

Initialization

order_num = 0#
generate_order_name()[source]#

Generate the name for the order list based on the current length of the list

add_marker_set(new_marker_set)[source]#

Add a marker set

add_rigid_body(new_rigid_body)[source]#

Add a rigid body

add_skeleton(new_skeleton)[source]#

Add a skeleton

add_force_plate(new_force_plate)[source]#

Add a force plate

add_device(newdevice)[source]#

add_device - Add a device

add_camera(newcamera)[source]#

Add a new camera

add_data(new_data)[source]#

Add data based on data type

get_object_from_list(list_name, pos_num)[source]#

Determine list name and position of the object

get_as_string(tab_str='  ', level=0)[source]#

Ensure data comes back as a string

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_marker_set_description(set_num=0)[source]#

generate_marker_set_description - Testing functions

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_rb_marker(marker_num=0)[source]#

generate_rb_marker - Generate rigid body marker based on marker number

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_rigid_body_description(rbd_num=0)[source]#

generate_rigid_body_description - Generate Rigid Body Description Data

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_skeleton_description(skeleton_num=0)[source]#

generate_skeleton_description -Generate Test SkeletonDescription Data

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_force_plate_description(force_plate_num=0)[source]#

generate_force_plate_description - Generate Test ForcePlateDescription Data

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_device_description(dev_num=0)[source]#

generate_device_description- Generate Test DeviceDescription Data

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_camera_description(cam_num=0)[source]#

generate_camera_description - Generate Test CameraDescription data

rofunc.devices.optitrack.windows_server.DataDescriptions.generate_data_descriptions(data_desc_num=0)[source]#

Generate data descriptions

rofunc.devices.optitrack.windows_server.DataDescriptions.test_all(run_test=True)[source]#

Test all the Data Description classes