File size: 18,716 Bytes
68ce2fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  Created on:	2011-05-18

  (C) Copyright 2011-2020 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#include <cisstVector/vctEulerRotation3.h>
#include <cisstVector/vctMatrixRotation3Base.h>

namespace vctEulerRotation3Order {

    std::string ToString(vctEulerRotation3Order::OrderType order)
    {
        std::string str;
        switch(order) {
        case vctEulerRotation3Order::ZYZ:
            str = "ZYZ";
            break;
        case vctEulerRotation3Order::ZYX:
            str = "ZYX";
            break;
        case vctEulerRotation3Order::ZXZ:
            str = "ZXZ";
            break;
        case vctEulerRotation3Order::YZX:
            str = "YZX";
            break;
        default:
            str = "UNDEFINED";
            break;
        }
        return str;
    }

};


void vctEulerRotation3Base::Assign(double phi, double theta, double psi)
{
    this->Angles.Assign(phi, theta, psi);
}


vctEulerRotation3Base & vctEulerRotation3Base::InverseSelf(void)
{
    double tmp = Angles[0];
    if (Angles[2] == cmnPI)
        Angles[0] = Angles[2];
    else
        Angles[0] = -Angles[2];
    Angles[1] = -Angles[1];
    if (tmp == cmnPI)
        Angles[2] = tmp;
    else
        Angles[2] = -tmp;
    return *this;
}


vctEulerRotation3Base & vctEulerRotation3Base::NormalizedSelf(void)
{
    // TODO: limit Angles[1] to 0 to PI
    while (Angles[0] > cmnPI)
        Angles[0] -= 2*cmnPI;
    while (Angles[0] <= -cmnPI)
        Angles[0] += 2*cmnPI;
    while (Angles[2] > cmnPI)
        Angles[2] -= 2*cmnPI;
    while (Angles[2] <= -cmnPI)
        Angles[2] += 2*cmnPI;
    return *this;
}


bool vctEulerRotation3Base::IsNormalized(double CMN_UNUSED(tolerance)) const
{
#if 0
    return ((Angles[0] > -cmnPI) && (Angles[0] <= cmnPI) &&
            (Angles[1] >= 0.0) && (Angles[1] <= cmnPI) &&
            (Angles[2] > -cmnPI) && (Angles[2] <= cmnPI));
#else
    return true;
#endif
}


/*****************************************************************************

  ZYZ Euler Angles. This is an intrinsic rotation, where phi (angle[0]) is
  rotation about the Z axis, theta (angle[1]) is rotation about the Y' axis,
  and psi (angle[2]) is rotation about the Z'' axis.

*****************************************************************************/
template <class _matrixType>
void vctEulerToMatrixRotation3(const vctEulerZYZRotation3 & eulerRot,
                               vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    typedef typename _matrixType::value_type value_type;

    const double cphi = cos(eulerRot.phi());      // 0
    const double sphi = sin(eulerRot.phi());
    const double ctheta = cos(eulerRot.theta());  // 1
    const double stheta = sin(eulerRot.theta());
    const double cpsi = cos(eulerRot.psi());      // 2
    const double spsi = sin(eulerRot.psi());

    matrixRot.Element(0, 0) = static_cast<value_type>(cphi * ctheta * cpsi - sphi * spsi);
    matrixRot.Element(0, 1) = static_cast<value_type>(-cphi * ctheta * spsi - sphi * cpsi);
    matrixRot.Element(0, 2) = static_cast<value_type>(cphi * stheta);

    matrixRot.Element(1, 0) = static_cast<value_type>(sphi * ctheta * cpsi + cphi * spsi);
    matrixRot.Element(1, 1) = static_cast<value_type>(-sphi * ctheta * spsi + cphi * cpsi);
    matrixRot.Element(1, 2) = static_cast<value_type>(sphi * stheta);

    matrixRot.Element(2, 0) = static_cast<value_type>(-stheta * cpsi);
    matrixRot.Element(2, 1) = static_cast<value_type>(stheta * spsi);
    matrixRot.Element(2, 2) = static_cast<value_type>(ctheta);
}


template <class _matrixType>
void vctEulerFromMatrixRotation3(vctEulerZYZRotation3 & eulerRot,
                                 const vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    typedef typename _matrixType::value_type value_type;

    // Initialize to the current Euler Angles -- these are used to resolve the singularity (gimbal lock)
    double phi = eulerRot.phi();
    double theta = eulerRot.theta();
    double psi = eulerRot.psi();

    if ((matrixRot.Element(0,2) * matrixRot.Element(0,2) + matrixRot.Element(1,2) * matrixRot.Element(1,2))  < 0.0001) {
        if (matrixRot.Element(2,2) > 0){
            theta = 0.0;
            value_type ftmp = atan2(matrixRot.Element(1,0), matrixRot.Element(0,0));
            double  ftmp2 = (ftmp - (phi + psi)) / 2.0;
            phi += ftmp2;
            psi += ftmp2;
        }
        else {
            theta = cmnPI;
            value_type  ftmp = atan2(matrixRot.Element(0,1), matrixRot.Element(1,1));
            double  ftmp2 = (ftmp - (psi - phi)) / 2.0;
            phi -= ftmp2;
            psi += ftmp2;
        }
    }
    else  {  // non-singular config.
        phi = atan(matrixRot.Element(1,2)/matrixRot.Element(0,2));
        double  cphi = cos(phi);
        double  sphi = sin(phi);
        theta = atan2((cphi * matrixRot.Element(0,2) + sphi * matrixRot.Element(1,2)), (double)matrixRot.Element(2,2));
        psi = atan2((-sphi * matrixRot.Element(0,0) + cphi * matrixRot.Element(1,0)),
                    (-sphi * matrixRot.Element(0,1) + cphi * matrixRot.Element(1,1)));
    }
    eulerRot.Assign(phi, theta, psi);
}


/*****************************************************************************

  ZYX Euler Angles, which can be called Yaw-Pitch-Roll. This is an intrinsic
  rotation of yaw about the Z axis, pitch about the Y' axis, and roll
  about the X'' axis.  Note that this is also equivalent to an extrinsic
  XYZ rotation, with the angles in reverse order (i.e., roll about the X axis,
  pitch about the Y axis, and yaw about the Z axis). In this context, roll, pitch
  and yaw do not have the same meaning as in aircraft dynamics.

*****************************************************************************/
template <class _matrixType>
void vctEulerToMatrixRotation3(const vctEulerZYXRotation3 & eulerRot,
                               vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    typedef typename _matrixType::value_type value_type;

    const double  z = eulerRot.alpha();
    const double  y = eulerRot.beta();
    const double  x = eulerRot.gamma();

    const double cz = cos(z);
    const double sz = sin(z);

    const double cy = cos(y);
    const double sy = sin(y);

    const double cx = cos(x);
    const double sx = sin(x);

    matrixRot.Element(0, 0) = static_cast<value_type>(cy * cz);
    matrixRot.Element(0, 1) = static_cast<value_type>(cz * sx * sy - cx * sz);
    matrixRot.Element(0, 2) = static_cast<value_type>(cx * cz * sy + sx * sz);

    matrixRot.Element(1, 0) = static_cast<value_type>(cy * sz);
    matrixRot.Element(1, 1) = static_cast<value_type>(cx * cz + sx * sy * sz);
    matrixRot.Element(1, 2) = static_cast<value_type>(-cz * sx + cx * sy * sz);

    matrixRot.Element(2, 0) = static_cast<value_type>(-sy);
    matrixRot.Element(2, 1) = static_cast<value_type>(cy * sx);
    matrixRot.Element(2, 2) = static_cast<value_type>(cx * cy);
}


template <class _matrixType>
void vctEulerFromMatrixRotation3(vctEulerZYXRotation3 & eulerRot,
                                 const vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    double z, y, x;

    if (matrixRot.Element(2, 0) < 1.0) {
        if (matrixRot.Element(2, 0) > -1.0) {
            y = asin(-matrixRot.Element(2, 0));
            z = atan2(matrixRot.Element(1, 0), matrixRot.Element(0, 0));
            x = atan2(matrixRot.Element(2, 1), matrixRot.Element(2, 2));
        }
        else {
            y = cmnPI_2;
            z = -atan2(-matrixRot.Element(1, 2), matrixRot.Element(1, 1));
            x = 0;
        }
    }
    else {
        y = -cmnPI_2;
        z = atan2(-matrixRot.Element(1, 2), matrixRot.Element(1, 1));
        x = 0;
    }

    eulerRot.Assign(z, y, x);
}


/*****************************************************************************

  ZXZ Euler Angles. This is an intrinsic rotation, where phi
  (angle[0]) is rotation about the Z axis, theta (angle[1]) is
  rotation about the X' axis, and psi (angle[2]) is rotation about the
  Z'' axis.  See
  https://www.geometrictools.com/Documentation/EulerAngles.pdf

*****************************************************************************/
#include <cisstVector/vctTransformationTypes.h>

template <class _matrixType>
void vctEulerToMatrixRotation3(const vctEulerZXZRotation3 & eulerRot,
                               vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    typedef typename _matrixType::value_type value_type;

    const double cphi = cos(eulerRot.phi());      // 0
    const double sphi = sin(eulerRot.phi());
    const double ctheta = cos(eulerRot.theta());  // 1
    const double stheta = sin(eulerRot.theta());
    const double cpsi = cos(eulerRot.psi());      // 2
    const double spsi = sin(eulerRot.psi());

    matrixRot.Element(0, 0) = static_cast<value_type>(cphi * cpsi - ctheta * sphi * spsi);
    matrixRot.Element(0, 1) = static_cast<value_type>(-ctheta * cpsi * sphi - cphi * spsi);
    matrixRot.Element(0, 2) = static_cast<value_type>(stheta * sphi);

    matrixRot.Element(1, 0) = static_cast<value_type>(cpsi * sphi + ctheta * cphi * spsi);
    matrixRot.Element(1, 1) = static_cast<value_type>(ctheta * cphi * cpsi - sphi * spsi);
    matrixRot.Element(1, 2) = static_cast<value_type>(-stheta * cphi);

    matrixRot.Element(2, 0) = static_cast<value_type>(stheta * spsi);
    matrixRot.Element(2, 1) = static_cast<value_type>(stheta * cpsi);
    matrixRot.Element(2, 2) = static_cast<value_type>(ctheta);
}


template <class _matrixType>
void vctEulerFromMatrixRotation3(vctEulerZXZRotation3 & eulerRot,
                                 const vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    typedef typename _matrixType::value_type value_type;

    // Initialize to the current Euler Angles -- these are used to resolve the singularity (gimbal lock)
    double phi = eulerRot.phi();
    double theta = eulerRot.theta();
    double psi = eulerRot.psi();

    if (matrixRot.Element(2, 2) < 1.0) {
        if (matrixRot.Element(2, 2) > -1.0) {
            theta = acos(matrixRot.Element(2, 2));
            phi = atan2(matrixRot.Element(0, 2), -matrixRot.Element(1, 2));
            psi = atan2(matrixRot.Element(2, 0), matrixRot.Element(2, 1));
        } else {
            // r22 = -1, not a  unique  solution: psi − phi = atan2(-r01 , r00)
            theta = cmnPI;
            value_type diff = atan2(-matrixRot.Element(0, 1), matrixRot.Element(0, 0));
            double correction = ((psi - phi) - diff) / 2.0;
            phi += correction;
            psi -= correction;
        }
    } else {
        // r22 = +1, not a unique solution: psi + phi = atan2(-r01 , r00)
        theta = 0.0;
        value_type sum = atan2(-matrixRot.Element(0, 1), matrixRot.Element(0,0));
        double correction = ((phi + psi) - sum) / 2.0;
        psi -= correction;
        phi -= correction;
    }
    eulerRot.Assign(phi, theta, psi);
}


/*****************************************************************************

  YZX Euler Angles. This is an intrinsic rotation, where phi
  (angle[0]) is rotation about the Y axis, theta (angle[1]) is
  rotation about the Z' axis, and psi (angle[2]) is rotation about the
  X'' axis.  See
  https://www.geometrictools.com/Documentation/EulerAngles.pdf

*****************************************************************************/

template <class _matrixType>
void vctEulerToMatrixRotation3(const vctEulerYZXRotation3 & eulerRot,
                               vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    typedef typename _matrixType::value_type value_type;

    // Rename to avoid confusion
    const double cy = cos(eulerRot.phi());      // 0 // Y
    const double sy = sin(eulerRot.phi());
    const double cz = cos(eulerRot.theta());  // 1 // Z
    const double sz = sin(eulerRot.theta());
    const double cx = cos(eulerRot.psi());      // 2 // X
    const double sx = sin(eulerRot.psi());

    matrixRot.Element(0, 0) = static_cast<value_type>(cy * cz);
    matrixRot.Element(0, 1) = static_cast<value_type>(sx * sy - cx * cy * sz);
    matrixRot.Element(0, 2) = static_cast<value_type>(cx * sy + cy * sx * sz);

    matrixRot.Element(1, 0) = static_cast<value_type>(sz);
    matrixRot.Element(1, 1) = static_cast<value_type>(cx * cz);
    matrixRot.Element(1, 2) = static_cast<value_type>(-cz * sx);

    matrixRot.Element(2, 0) = static_cast<value_type>(-cz * sy);
    matrixRot.Element(2, 1) = static_cast<value_type>(cy * sx + cx * sy * sz);
    matrixRot.Element(2, 2) = static_cast<value_type>(cx * cy - sx * sy * sz);
}


template <class _matrixType>
void vctEulerFromMatrixRotation3(vctEulerYZXRotation3 & eulerRot,
                                 const vctMatrixRotation3Base<_matrixType> & matrixRot)
{
    // Initialize to the current Euler Angles -- these are used to resolve the singularity (gimbal lock)

    // Rename to avoid confusion
    double y = eulerRot.phi();
    double z = eulerRot.theta();
    double x = eulerRot.psi();

    if (matrixRot.Element(1, 0) < 1.0) {
        if (matrixRot.Element(1, 0) > -1.0) {
            z = asin(matrixRot.Element(1, 0));
            y = atan2(-matrixRot.Element(2, 0), matrixRot.Element(0, 0));
            x = atan2(-matrixRot.Element(1, 2), matrixRot.Element(1, 1));
        } else {
            z = -cmnPI_2;
            y = -atan2(matrixRot.Element(2, 1), matrixRot.Element(2, 2));
            x = 0;
        }
    } else {
        z = cmnPI_2;
        y = atan2(matrixRot.Element(2, 1), matrixRot.Element(2, 2));
        x = 0;

    }
    eulerRot.Assign(y, z, x);
}


// force instantiation of helper functions
#define INSTANTIATE_EULER_TEMPLATES(ORDER)                              \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrix<double, 3, 3, VCT_ROW_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrix<double, 3, 3, VCT_COL_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrix<float, 3, 3, VCT_ROW_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrix<float, 3, 3, VCT_COL_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrixRef<double, 3, 3, 4, 1> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrixRef<double, 3, 3, 1, 4> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrixRef<float, 3, 3, 4, 1> > & matrixRot); \
    template void                                                       \
    vctEulerFromMatrixRotation3(vctEulerRotation3<ORDER> & eulerRot,    \
                                const vctMatrixRotation3Base<vctFixedSizeMatrixRef<float, 3, 3, 1, 4> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrix<double, 3, 3, VCT_ROW_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrix<double, 3, 3, VCT_COL_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrix<float, 3, 3, VCT_ROW_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrix<float, 3, 3, VCT_COL_MAJOR> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrixRef<double, 3, 3, 4, 1> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrixRef<double, 3, 3, 1, 4> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrixRef<float, 3, 3, 4, 1> > & matrixRot); \
    template void                                                       \
    vctEulerToMatrixRotation3(const vctEulerRotation3<ORDER> & eulerRot, \
                              vctMatrixRotation3Base<vctFixedSizeMatrixRef<float, 3, 3, 1, 4> > & matrixRot);

// Instantiate templates for each supported Euler angle convention (e.g., ZYZ)
INSTANTIATE_EULER_TEMPLATES(vctEulerRotation3Order::ZYZ)
INSTANTIATE_EULER_TEMPLATES(vctEulerRotation3Order::ZYX)
INSTANTIATE_EULER_TEMPLATES(vctEulerRotation3Order::ZXZ)
INSTANTIATE_EULER_TEMPLATES(vctEulerRotation3Order::YZX)