Metadata-Version: 2.1
Name: dual-quaternions
Version: 0.3.1
Summary: Dual quaternion implementation
Home-page: http://github.com/Achllle/dual_quaternions
Author: Achille Verheye
Author-email: achille.verheye@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Dist: numpy
Requires-Dist: pyquaternion

Dual Quaternions
================

|travis| |tags|

.. |travis| image:: https://travis-ci.com/Achllle/dual_quaternions.svg?branch=master
    :target: https://travis-ci.com/Achllle/dual_quaternions

.. |tags| image:: https://img.shields.io/github/v/tag/achllle/dual_quaternions
    :alt: GitHub tag (latest SemVer)
    :target: https://GitHub.com/Achllle/dual_quaternions/tags/

Dual quaternions are a way of representing rigid body transformations, just like homogeneous transformations do.
Instead of using a 4 by 4 matrix, the transformation is represented as two quaternions. This has several advantages,
which are listed under `Why use dual quaternions?`_ The term 'dual' refers to dual number theory, which allows
representing numbers (or in this case quaternions) very similar to complex numbers with the difference being that
:code:`i` or :code:`j` becomes :code:`e` (epsilon) and instead of :code:`i^2 = -1` we have :code:`e^2 = 0`.
This allows e.g. multiplication of two dual quaternions to work in the same way as homogeneous matrix multiplication.

For more information on dual quaternions, take a look at the `References`_.
For conversion from and to common ROS messages, see `dual_quaternions_ros <https://github.com/Achllle/dual_quaternions_ros>`__.

.. image:: viz.gif
    :scale: 50 %
    :align: center
    :target: https://gist.github.com/Achllle/c06c7a9b6706d4942fdc2e198119f0a2

Why use dual quaternions?
-------------------------

* dual quaternions have all the advantages of quaternions including unambiguous representation, no gimbal lock, compact representation
* direct and simple relation with screw theory. Simple and fast Screw Linear Interpolation (ScLERP) which is shortest path on the manifold
* dual quaternions have an exact tangent / derivative due to dual number theory (higher order taylor series are exactly zero)
* we want to use quaternions but they can only handle rotation. Dual quaternions are the correct extension to handle translations as well.
* easy normalization. Homogeneous tranformation matrices are orthogonal and due to floating point errors operations on them often result in matrices that need to be renormalized. This can be done using the Gram-Schmidt method but that is a slow algorithm. Quaternion normalization is very fast.
* mathematically pleasing

Installation
------------

pip
~~~

.. code-block:: bash

  pip install dual_quaternions

ROS package
~~~~~~~~~~~

Release into apt is on its way. Until then you'll have to build the catkin package from source.

.. code-block:: bash

  cd ~/catkin_ws/src
  git clone https://github.com/Achllle/dual_quaternions
  cd ..
  catkin_make

Usage
-----

Import using::

    from dual_quaternions import DualQuaternion

References
----------

* \K. Daniilidis, E. Bayro-Corrochano, "The dual quaternion approach to hand-eye calibration", IEEE International Conference on Pattern Recognition, 1996
* Kavan, Ladislav & Collins, Steven & Zara, Jiri & O'Sullivan, Carol. (2007). Skinning with dual quaternions. I3D. 39-46. 10.1145/1230100.1230107.
* Kenwright, B. (2012). A Beginners Guide to Dual-Quaternions What They Are, How They Work, and How to Use Them for 3D Character Hierarchies.
* Furrer, Fadri & Fehr, Marius & Novkovic, Tonci & Sommer, Hannes & Gilitschenski, Igor & Siegwart, Roland. (2018). Evaluation of Combined Time-Offset Estimation and Hand-Eye Calibration on Robotic Datasets. 145-159. 10.1007/978-3-319-67361-5_10.


