:py:mod:`rofunc.devices.xsens.src.mvnx_file_accessor`
=====================================================

.. py:module:: rofunc.devices.xsens.src.mvnx_file_accessor

.. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`MvnxFileAccessor <rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor>`
     - .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor
          :summary:

API
~~~

.. py:class:: MvnxFileAccessor()
   :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor

   .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.__init__

   .. py:property:: original_file_name
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.original_file_name

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.original_file_name

   .. py:property:: actor_name
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.actor_name

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.actor_name

   .. py:property:: actor_color
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.actor_color

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.actor_color

   .. py:property:: profile
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.profile

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.profile

   .. py:property:: configuration
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.configuration

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.configuration

   .. py:property:: comments
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.comments

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.comments

   .. py:property:: quality
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.quality

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.quality

   .. py:property:: frame_count
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.frame_count

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.frame_count

   .. py:property:: segment_count
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.segment_count

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.segment_count

   .. py:property:: joint_count
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.joint_count

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.joint_count

   .. py:property:: finger_joint_count
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.finger_joint_count

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.finger_joint_count

   .. py:property:: ergo_joint_count
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.ergo_joint_count

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.ergo_joint_count

   .. py:property:: sensor_count
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.sensor_count

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.sensor_count

   .. py:property:: frame_rate
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.frame_rate
      :type: int

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.frame_rate

   .. py:property:: recording_date
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.recording_date
      :type: str

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.recording_date

   .. py:property:: version
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.version

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.version

   .. py:method:: create_index_to_segment_dict()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_segment_dict

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_segment_dict

   .. py:method:: create_index_to_joint_dict()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_joint_dict

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_joint_dict

   .. py:method:: create_index_to_sensor_dict()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_sensor_dict

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_sensor_dict

   .. py:method:: create_index_to_ergo_joint_dict()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_ergo_joint_dict

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.create_index_to_ergo_joint_dict

   .. py:method:: set_frame_window(first_frame, last_frame)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.set_frame_window

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.set_frame_window

   .. py:method:: reset_frame_window()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.reset_frame_window

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.reset_frame_window

   .. py:method:: window_profile()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.window_profile

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.window_profile

   .. py:method:: frame_to_mapped_slice(frame) -> (slice, bool)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.frame_to_mapped_slice

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.frame_to_mapped_slice

   .. py:method:: segment_name_from_index(segment_index)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.segment_name_from_index

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.segment_name_from_index

   .. py:method:: joint_name_from_index(joint_index)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.joint_name_from_index

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.joint_name_from_index

   .. py:method:: sensor_name_from_index(sensor_index)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.sensor_name_from_index

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.sensor_name_from_index

   .. py:method:: ergo_joint_name_from_index(ergo_joint_index)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.ergo_joint_name_from_index

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.ergo_joint_name_from_index

   .. py:method:: point_name_from_indices(segment_index, point_index)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.point_name_from_indices

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.point_name_from_indices

   .. py:method:: identity_pose_is_valid()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose_is_valid

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose_is_valid

   .. py:method:: identity_pose_segment_pos(segment)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose_segment_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose_segment_pos

   .. py:method:: identity_pose_segment_ori(segment)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose_segment_ori

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose_segment_ori

   .. py:method:: t_pose_is_valid()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose_is_valid

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose_is_valid

   .. py:method:: t_pose_segment_pos(segment)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose_segment_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose_segment_pos

   .. py:method:: t_pose_segment_ori(segment)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose_segment_ori

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose_segment_ori

   .. py:method:: identity_pose()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.identity_pose

   .. py:method:: t_pose()
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.t_pose

   .. py:method:: get_segment_pos(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_pos

   .. py:method:: get_segment_ori(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_ori

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_ori

   .. py:method:: get_segment_point_pos(segment, point)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_point_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_point_pos

   .. py:method:: get_point_pos(segment, point)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_point_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_point_pos

   .. py:method:: get_segment_vel(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_vel

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_vel

   .. py:method:: get_segment_acc(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_acc

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_acc

   .. py:method:: get_segment_angular_vel(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_angular_vel

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_angular_vel

   .. py:method:: get_segment_angular_acc(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_angular_acc

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_angular_acc

   .. py:method:: get_segment_data(data_field, segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_data

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_segment_data

   .. py:method:: get_finger_segment_pos(hand_idx, segment_name, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_finger_segment_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_finger_segment_pos

   .. py:method:: get_finger_segment_ori(hand_idx, segment_name, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_finger_segment_ori

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_finger_segment_ori

   .. py:method:: get_finger_segment_data(data_field, hand_idx, segment_name, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_finger_segment_data

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_finger_segment_data

   .. py:method:: get_joint_angle(joint, frame=mvn.FRAMES_ALL, angle=mvn.ANGLE_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_joint_angle

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_joint_angle

   .. py:method:: get_joint_angle_xzy(joint, frame=mvn.FRAMES_ALL, angle=mvn.ANGLE_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_joint_angle_xzy

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_joint_angle_xzy

   .. py:method:: get_ergo_joint_angle(joint, frame=mvn.FRAMES_ALL, angle=mvn.ANGLE_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_ergo_joint_angle

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_ergo_joint_angle

   .. py:method:: get_center_of_mass_pos(frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_center_of_mass_pos

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_center_of_mass_pos

   .. py:method:: get_center_of_mass_vel(frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_center_of_mass_vel

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_center_of_mass_vel

   .. py:method:: get_center_of_mass_acc(frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_center_of_mass_acc

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_center_of_mass_acc

   .. py:method:: get_sensor_ori(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_sensor_ori

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_sensor_ori

   .. py:method:: get_sensor_free_acc(segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_sensor_free_acc

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_sensor_free_acc

   .. py:method:: get_sensor_data(data_field, sensor_segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_sensor_data

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_sensor_data

   .. py:method:: get_foot_contacts(frame)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_foot_contacts

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_foot_contacts

   .. py:method:: has_foot_contact(frame, foot_contact_flags=0)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.has_foot_contact

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.has_foot_contact

   .. py:method:: get_data(data_set, data_field, segment, frame=mvn.FRAMES_ALL, axis=mvn.AXIS_ALL)
      :canonical: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_data

      .. autodoc2-docstring:: rofunc.devices.xsens.src.mvnx_file_accessor.MvnxFileAccessor.get_data