:py:mod:`rofunc.simulator.src.franka_osc`
=========================================

.. py:module:: rofunc.simulator.src.franka_osc

.. autodoc2-docstring:: rofunc.simulator.src.franka_osc
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`orientation_error <rofunc.simulator.src.franka_osc.orientation_error>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.orientation_error
          :summary:

Data
~~~~

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

   * - :py:obj:`args <rofunc.simulator.src.franka_osc.args>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.args
          :summary:
   * - :py:obj:`gym <rofunc.simulator.src.franka_osc.gym>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.gym
          :summary:
   * - :py:obj:`sim_params <rofunc.simulator.src.franka_osc.sim_params>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.sim_params
          :summary:
   * - :py:obj:`sim <rofunc.simulator.src.franka_osc.sim>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.sim
          :summary:
   * - :py:obj:`viewer <rofunc.simulator.src.franka_osc.viewer>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.viewer
          :summary:
   * - :py:obj:`plane_params <rofunc.simulator.src.franka_osc.plane_params>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.plane_params
          :summary:
   * - :py:obj:`asset_root <rofunc.simulator.src.franka_osc.asset_root>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.asset_root
          :summary:
   * - :py:obj:`franka_asset_file <rofunc.simulator.src.franka_osc.franka_asset_file>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_asset_file
          :summary:
   * - :py:obj:`asset_options <rofunc.simulator.src.franka_osc.asset_options>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.asset_options
          :summary:
   * - :py:obj:`franka_asset <rofunc.simulator.src.franka_osc.franka_asset>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_asset
          :summary:
   * - :py:obj:`franka_dof_props <rofunc.simulator.src.franka_osc.franka_dof_props>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_dof_props
          :summary:
   * - :py:obj:`franka_lower_limits <rofunc.simulator.src.franka_osc.franka_lower_limits>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_lower_limits
          :summary:
   * - :py:obj:`franka_upper_limits <rofunc.simulator.src.franka_osc.franka_upper_limits>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_upper_limits
          :summary:
   * - :py:obj:`franka_ranges <rofunc.simulator.src.franka_osc.franka_ranges>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_ranges
          :summary:
   * - :py:obj:`franka_mids <rofunc.simulator.src.franka_osc.franka_mids>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_mids
          :summary:
   * - :py:obj:`franka_num_dofs <rofunc.simulator.src.franka_osc.franka_num_dofs>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_num_dofs
          :summary:
   * - :py:obj:`default_dof_state <rofunc.simulator.src.franka_osc.default_dof_state>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.default_dof_state
          :summary:
   * - :py:obj:`num_envs <rofunc.simulator.src.franka_osc.num_envs>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.num_envs
          :summary:
   * - :py:obj:`num_per_row <rofunc.simulator.src.franka_osc.num_per_row>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.num_per_row
          :summary:
   * - :py:obj:`spacing <rofunc.simulator.src.franka_osc.spacing>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.spacing
          :summary:
   * - :py:obj:`env_lower <rofunc.simulator.src.franka_osc.env_lower>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.env_lower
          :summary:
   * - :py:obj:`env_upper <rofunc.simulator.src.franka_osc.env_upper>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.env_upper
          :summary:
   * - :py:obj:`pose <rofunc.simulator.src.franka_osc.pose>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.pose
          :summary:
   * - :py:obj:`envs <rofunc.simulator.src.franka_osc.envs>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.envs
          :summary:
   * - :py:obj:`hand_idxs <rofunc.simulator.src.franka_osc.hand_idxs>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.hand_idxs
          :summary:
   * - :py:obj:`init_pos_list <rofunc.simulator.src.franka_osc.init_pos_list>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_pos_list
          :summary:
   * - :py:obj:`init_orn_list <rofunc.simulator.src.franka_osc.init_orn_list>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_orn_list
          :summary:
   * - :py:obj:`cam_pos <rofunc.simulator.src.franka_osc.cam_pos>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.cam_pos
          :summary:
   * - :py:obj:`cam_target <rofunc.simulator.src.franka_osc.cam_target>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.cam_target
          :summary:
   * - :py:obj:`middle_env <rofunc.simulator.src.franka_osc.middle_env>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.middle_env
          :summary:
   * - :py:obj:`init_pos <rofunc.simulator.src.franka_osc.init_pos>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_pos
          :summary:
   * - :py:obj:`init_orn <rofunc.simulator.src.franka_osc.init_orn>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_orn
          :summary:
   * - :py:obj:`pos_des <rofunc.simulator.src.franka_osc.pos_des>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.pos_des
          :summary:
   * - :py:obj:`orn_des <rofunc.simulator.src.franka_osc.orn_des>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.orn_des
          :summary:
   * - :py:obj:`jacobian <rofunc.simulator.src.franka_osc.jacobian>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.jacobian
          :summary:
   * - :py:obj:`hand_index <rofunc.simulator.src.franka_osc.hand_index>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.hand_index
          :summary:
   * - :py:obj:`j_eef <rofunc.simulator.src.franka_osc.j_eef>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.j_eef
          :summary:
   * - :py:obj:`mm <rofunc.simulator.src.franka_osc.mm>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.mm
          :summary:
   * - :py:obj:`kp <rofunc.simulator.src.franka_osc.kp>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.kp
          :summary:
   * - :py:obj:`kv <rofunc.simulator.src.franka_osc.kv>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.kv
          :summary:
   * - :py:obj:`rb_states <rofunc.simulator.src.franka_osc.rb_states>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.rb_states
          :summary:
   * - :py:obj:`dof_states <rofunc.simulator.src.franka_osc.dof_states>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.dof_states
          :summary:
   * - :py:obj:`dof_vel <rofunc.simulator.src.franka_osc.dof_vel>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.dof_vel
          :summary:
   * - :py:obj:`dof_pos <rofunc.simulator.src.franka_osc.dof_pos>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.dof_pos
          :summary:
   * - :py:obj:`itr <rofunc.simulator.src.franka_osc.itr>`
     - .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.itr
          :summary:

API
~~~

.. py:function:: orientation_error(desired, current)
   :canonical: rofunc.simulator.src.franka_osc.orientation_error

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.orientation_error

.. py:data:: args
   :canonical: rofunc.simulator.src.franka_osc.args
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.args

.. py:data:: gym
   :canonical: rofunc.simulator.src.franka_osc.gym
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.gym

.. py:data:: sim_params
   :canonical: rofunc.simulator.src.franka_osc.sim_params
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.sim_params

.. py:data:: sim
   :canonical: rofunc.simulator.src.franka_osc.sim
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.sim

.. py:data:: viewer
   :canonical: rofunc.simulator.src.franka_osc.viewer
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.viewer

.. py:data:: plane_params
   :canonical: rofunc.simulator.src.franka_osc.plane_params
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.plane_params

.. py:data:: asset_root
   :canonical: rofunc.simulator.src.franka_osc.asset_root
   :value: '../assets'

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.asset_root

.. py:data:: franka_asset_file
   :canonical: rofunc.simulator.src.franka_osc.franka_asset_file
   :value: 'urdf/franka_description/robots/franka_panda.urdf'

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_asset_file

.. py:data:: asset_options
   :canonical: rofunc.simulator.src.franka_osc.asset_options
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.asset_options

.. py:data:: franka_asset
   :canonical: rofunc.simulator.src.franka_osc.franka_asset
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_asset

.. py:data:: franka_dof_props
   :canonical: rofunc.simulator.src.franka_osc.franka_dof_props
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_dof_props

.. py:data:: franka_lower_limits
   :canonical: rofunc.simulator.src.franka_osc.franka_lower_limits
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_lower_limits

.. py:data:: franka_upper_limits
   :canonical: rofunc.simulator.src.franka_osc.franka_upper_limits
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_upper_limits

.. py:data:: franka_ranges
   :canonical: rofunc.simulator.src.franka_osc.franka_ranges
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_ranges

.. py:data:: franka_mids
   :canonical: rofunc.simulator.src.franka_osc.franka_mids
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_mids

.. py:data:: franka_num_dofs
   :canonical: rofunc.simulator.src.franka_osc.franka_num_dofs
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.franka_num_dofs

.. py:data:: default_dof_state
   :canonical: rofunc.simulator.src.franka_osc.default_dof_state
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.default_dof_state

.. py:data:: num_envs
   :canonical: rofunc.simulator.src.franka_osc.num_envs
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.num_envs

.. py:data:: num_per_row
   :canonical: rofunc.simulator.src.franka_osc.num_per_row
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.num_per_row

.. py:data:: spacing
   :canonical: rofunc.simulator.src.franka_osc.spacing
   :value: 1.0

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.spacing

.. py:data:: env_lower
   :canonical: rofunc.simulator.src.franka_osc.env_lower
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.env_lower

.. py:data:: env_upper
   :canonical: rofunc.simulator.src.franka_osc.env_upper
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.env_upper

.. py:data:: pose
   :canonical: rofunc.simulator.src.franka_osc.pose
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.pose

.. py:data:: envs
   :canonical: rofunc.simulator.src.franka_osc.envs
   :value: []

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.envs

.. py:data:: hand_idxs
   :canonical: rofunc.simulator.src.franka_osc.hand_idxs
   :value: []

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.hand_idxs

.. py:data:: init_pos_list
   :canonical: rofunc.simulator.src.franka_osc.init_pos_list
   :value: []

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_pos_list

.. py:data:: init_orn_list
   :canonical: rofunc.simulator.src.franka_osc.init_orn_list
   :value: []

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_orn_list

.. py:data:: cam_pos
   :canonical: rofunc.simulator.src.franka_osc.cam_pos
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.cam_pos

.. py:data:: cam_target
   :canonical: rofunc.simulator.src.franka_osc.cam_target
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.cam_target

.. py:data:: middle_env
   :canonical: rofunc.simulator.src.franka_osc.middle_env
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.middle_env

.. py:data:: init_pos
   :canonical: rofunc.simulator.src.franka_osc.init_pos
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_pos

.. py:data:: init_orn
   :canonical: rofunc.simulator.src.franka_osc.init_orn
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.init_orn

.. py:data:: pos_des
   :canonical: rofunc.simulator.src.franka_osc.pos_des
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.pos_des

.. py:data:: orn_des
   :canonical: rofunc.simulator.src.franka_osc.orn_des
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.orn_des

.. py:data:: jacobian
   :canonical: rofunc.simulator.src.franka_osc.jacobian
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.jacobian

.. py:data:: hand_index
   :canonical: rofunc.simulator.src.franka_osc.hand_index
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.hand_index

.. py:data:: j_eef
   :canonical: rofunc.simulator.src.franka_osc.j_eef
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.j_eef

.. py:data:: mm
   :canonical: rofunc.simulator.src.franka_osc.mm
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.mm

.. py:data:: kp
   :canonical: rofunc.simulator.src.franka_osc.kp
   :value: 5

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.kp

.. py:data:: kv
   :canonical: rofunc.simulator.src.franka_osc.kv
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.kv

.. py:data:: rb_states
   :canonical: rofunc.simulator.src.franka_osc.rb_states
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.rb_states

.. py:data:: dof_states
   :canonical: rofunc.simulator.src.franka_osc.dof_states
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.dof_states

.. py:data:: dof_vel
   :canonical: rofunc.simulator.src.franka_osc.dof_vel
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.dof_vel

.. py:data:: dof_pos
   :canonical: rofunc.simulator.src.franka_osc.dof_pos
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.dof_pos

.. py:data:: itr
   :canonical: rofunc.simulator.src.franka_osc.itr
   :value: 0

   .. autodoc2-docstring:: rofunc.simulator.src.franka_osc.itr