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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
/*
* ANISE Toolkit
* Copyright (C) 2021-onward Christopher Rabotin <christopher.rabotin@gmail.com> et al. (cf. AUTHORS.md)
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*
* Documentation: https://nyxspace.com/
*/
use crate::{
astro::PhysicsResult,
errors::{InvalidRotationSnafu, InvalidStateRotationSnafu, PhysicsError},
math::{cartesian::CartesianState, Matrix3, Matrix6, Vector3, Vector6},
prelude::Frame,
NaifId,
};
use nalgebra::Vector4;
use snafu::ensure;
use super::{r1, r2, r3, Quaternion, Rotation};
use core::fmt;
use core::ops::Mul;
#[cfg(feature = "python")]
use pyo3::prelude::*;
/// Defines a direction cosine matrix from one frame ID to another frame ID, optionally with its time derivative.
/// It provides a number of run-time checks that prevent invalid rotations.
///
/// :type np_rot_mat: numpy.array
/// :type from_id: int
/// :type to_id: int
/// :type np_rot_mat_dt: numpy.array, optional
/// :rtype: DCM
#[derive(Copy, Clone, Debug, Default)]
#[cfg_attr(feature = "python", pyclass(name = "DCM"))]
#[cfg_attr(feature = "python", pyo3(module = "anise.rotation"))]
pub struct DCM {
/// The rotation matrix itself
pub rot_mat: Matrix3,
/// The time derivative of the rotation matrix
pub rot_mat_dt: Option<Matrix3>,
/// The source frame
pub from: NaifId,
/// The destination frame
pub to: NaifId,
}
impl Rotation for DCM {}
impl DCM {
/// Returns a rotation matrix for a rotation about the X axis.
///
/// Source: `euler1` function from Baslisk
/// # Arguments
///
/// * `angle_rad` - The angle of rotation in radians.
///
pub fn r1(angle_rad: f64, from: NaifId, to: NaifId) -> Self {
Self {
rot_mat: r1(angle_rad),
from,
to,
rot_mat_dt: None,
}
}
/// Returns a rotation matrix for a rotation about the Y axis.
///
/// Source: `euler2` function from Basilisk
/// # Arguments
///
/// * `angle` - The angle of rotation in radians.
///
pub fn r2(angle_rad: f64, from: NaifId, to: NaifId) -> Self {
Self {
rot_mat: r2(angle_rad),
from,
to,
rot_mat_dt: None,
}
}
/// Returns a rotation matrix for a rotation about the Z axis.
///
/// Source: `euler3` function from Basilisk
/// # Arguments
///
/// * `angle_rad` - The angle of rotation in radians.
///
pub fn r3(angle_rad: f64, from: NaifId, to: NaifId) -> Self {
Self {
rot_mat: r3(angle_rad),
from,
to,
rot_mat_dt: None,
}
}
/// Builds an identity rotation
pub fn identity(from: i32, to: i32) -> Self {
let rot_mat = Matrix3::identity();
Self {
rot_mat,
from,
to,
rot_mat_dt: None,
}
}
/// Constructs a DCM using the "Align and Clock" (Two-Vector Targeting / TRIAD) method.
///
/// This defines a rotation based on two geometric constraints:
/// 1. **Align**: The `primary_body_axis` is aligned exactly with the `primary_inertial_vec`.
/// 2. **Clock**: The `secondary_body_axis` is aligned as closely as possible with the `secondary_inertial_vec`.
///
/// This constructs the rotation matrix $R_{from \to to}$.
///
/// # Arguments
/// * `primary_body_axis` - The axis in the "from" frame to align (e.g. Sensor Boresight).
/// * `primary_inertial_vec` - The target vector in the "to" frame (e.g. Vector to Earth).
/// * `secondary_body_axis` - The axis in the "from" frame to clock (e.g. Solar Panel Normal).
/// * `secondary_inertial_vec` - The target vector in the "to" frame (e.g. Vector to Sun).
/// * `from` - The ID of the source frame.
/// * `to` - The ID of the destination frame.
pub fn align_and_clock(
primary_body_axis: Vector3,
primary_vec: Vector3,
secondary_body_axis: Vector3,
secondary_vec: Vector3,
from: i32,
to: i32,
) -> Result<Self, PhysicsError> {
// 1. Normalize inputs and check for zero length
let u_b = primary_body_axis.normalize();
let v_b = secondary_body_axis.normalize();
let u_n = primary_vec.normalize();
let v_n = secondary_vec.normalize();
// 2. Build the "Body" Triad (From Frame)
// t1_b is the primary axis
let t1_b = u_b;
// t2_b is the normal to the plane defined by primary and secondary
let t2_b_raw = u_b.cross(&v_b);
ensure!(
t2_b_raw.norm() > f64::EPSILON,
InvalidRotationSnafu {
action: "align_and_clock: primary and secondary body axes are collinear",
from1: from,
to1: from,
from2: from,
to2: from
}
);
let t2_b = t2_b_raw.normalize();
// t3_b completes the right-handed set
let t3_b = t1_b.cross(&t2_b);
// 3. Build the "Inertial" Triad (To Frame)
// t1_n is the primary target
let t1_n = u_n;
// t2_n is the normal to the plane defined by primary and secondary targets
let t2_n_raw = u_n.cross(&v_n);
ensure!(
t2_n_raw.norm() > f64::EPSILON,
InvalidRotationSnafu {
action: "align_and_clock: primary and secondary inertial vectors are collinear",
from1: to,
to1: to,
from2: to,
to2: to
}
);
let t2_n = t2_n_raw.normalize();
let t3_n = t1_n.cross(&t2_n);
// 4. Construct Rotation Matrix
// We want R_{from->to}.
// The triad matrices M_b = [t1_b, t2_b, t3_b] and M_n = [t1_n, t2_n, t3_n]
// map the "Triad Frame" to the "Body" and "Inertial" frames respectively.
// R_{triad->body} = M_b
// R_{triad->inertial} = M_n
// We want R_{body->inertial} = R_{triad->inertial} * R_{body->triad}
// = M_n * M_b^T
let m_b = Matrix3::from_columns(&[t1_b, t2_b, t3_b]);
let m_n = Matrix3::from_columns(&[t1_n, t2_n, t3_n]);
let rot_mat = m_n * m_b.transpose();
Ok(Self {
rot_mat,
rot_mat_dt: None, // This is an instantaneous geometric definition
from,
to,
})
}
/// Returns the 6x6 DCM to rotate a state. If the time derivative of this DCM is defined, this 6x6 accounts for the transport theorem.
pub fn state_dcm(&self) -> Matrix6 {
let mut full_dcm = Matrix6::zeros();
for i in 0..6 {
for j in 0..6 {
if (i < 3 && j < 3) || (i >= 3 && j >= 3) {
full_dcm[(i, j)] = self.rot_mat[(i % 3, j % 3)];
} else if i >= 3 && j < 3 {
full_dcm[(i, j)] = self
.rot_mat_dt
.map(|dcm_dt| dcm_dt[(i - 3, j)])
.unwrap_or(0.0);
}
}
}
full_dcm
}
/// Returns the skew symmetric matrix if this DCM defines a rotation rate.
pub fn skew_symmetric(&self) -> Option<Matrix3> {
self.rot_mat_dt
.map(|c_dot| c_dot * self.rot_mat.transpose())
}
/// Returns the angular velocity vector in deg/s of this DCM is it has a defined rotation rate.
pub fn angular_velocity_rad_s(&self) -> Option<Vector3> {
self.skew_symmetric().map(|omega_skew_symmetric| {
// Extract the angular velocity vector components from the skew-symmetric matrix.
// omega_x = (m32 - m23) / 2
// omega_y = (m13 - m31) / 2
// omega_z = (m21 - m12) / 2
// This averaging of opposite elements is more robust to floating-point errors.
Vector3::new(
-(omega_skew_symmetric.m32 - omega_skew_symmetric.m23) / 2.0,
-(omega_skew_symmetric.m13 - omega_skew_symmetric.m31) / 2.0,
-(omega_skew_symmetric.m21 - omega_skew_symmetric.m12) / 2.0,
)
})
}
/// Returns the angular velocity vector in deg/s if a rotation rate is defined.
pub fn angular_velocity_deg_s(&self) -> Option<Vector3> {
self.angular_velocity_rad_s()
.map(|rad_vec| rad_vec.map(|component| component.to_degrees()))
}
/// Multiplies this DCM with another one WITHOUT checking if the frames match.
pub(crate) fn mul_unchecked(&self, other: Self) -> Self {
let mut rslt = *self;
rslt.rot_mat *= other.rot_mat;
rslt.from = other.from;
// Make sure to apply the transport theorem.
if let Some(other_rot_mat_dt) = other.rot_mat_dt {
if let Some(rot_mat_dt) = self.rot_mat_dt {
rslt.rot_mat_dt =
Some(rot_mat_dt * other.rot_mat + self.rot_mat * other_rot_mat_dt);
} else {
rslt.rot_mat_dt = Some(self.rot_mat * other_rot_mat_dt);
}
} else if let Some(rot_mat_dt) = self.rot_mat_dt {
rslt.rot_mat_dt = Some(rot_mat_dt * other.rot_mat);
}
rslt
}
}
// Methods shared with Python
#[cfg_attr(feature = "python", pymethods)]
impl DCM {
/// Returns the transpose of this DCM
///
/// :rtype: DCM
pub fn transpose(&self) -> Self {
Self {
rot_mat: self.rot_mat.transpose(),
rot_mat_dt: self.rot_mat_dt.map(|rot_mat_dt| rot_mat_dt.transpose()),
to: self.from,
from: self.to,
}
}
/// Returns whether this rotation is identity, checking first the frames and then the rotation matrix (but ignores its time derivative)
///
/// :rtype: bool
pub fn is_identity(&self) -> bool {
self.to == self.from || (self.rot_mat - Matrix3::identity()).norm() < 1e-8
}
/// Returns whether the `rot_mat` of this DCM is a valid rotation matrix.
/// The criteria for validity are:
/// -- The columns of the matrix are unit vectors, within a specified tolerance (unit_tol).
/// -- The determinant of the matrix formed by unitizing the columns of the input matrix is 1, within a specified tolerance. This criterion ensures that the columns of the matrix are nearly orthogonal, and that they form a right-handed basis (det_tol).
/// [Source: SPICE's rotation.req](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/rotation.html#Validating%20a%20rotation%20matrix)
///
/// :type unit_tol: float
/// :type det_tol: float
/// :rtype: bool
pub fn is_valid(&self, unit_tol: f64, det_tol: f64) -> bool {
for col in self.rot_mat.column_iter() {
if (col.norm() - 1.0).abs() > unit_tol {
return false;
}
}
(self.rot_mat.determinant() - 1.0).abs() < det_tol
}
}
impl Mul for DCM {
type Output = Result<Self, PhysicsError>;
fn mul(self, rhs: Self) -> Self::Output {
ensure!(
self.from == rhs.to,
InvalidRotationSnafu {
action: "multiply DCMs",
from1: self.from,
to1: self.to,
from2: rhs.from,
to2: rhs.to
}
);
if self.is_identity() {
let mut rslt = rhs;
rslt.from = rhs.from;
rslt.to = self.to;
Ok(rslt)
} else if rhs.is_identity() {
let mut rslt = self;
rslt.from = rhs.from;
rslt.to = self.to;
Ok(rslt)
} else {
Ok(self.mul_unchecked(rhs))
}
}
}
impl Mul<Vector3> for DCM {
type Output = Vector3;
/// Applying the matrix to a vector yields the vector's representation relative to the rotated coordinate system.
///
/// # Example
///
/// ```
/// use anise::math::Vector3;
/// use anise::math::rotation::DCM;
/// use core::f64::consts::FRAC_PI_2;
///
///
/// let r1 = DCM::r1(FRAC_PI_2, 0, 1);
///
/// // Rotation of the X vector about X, yields X
/// assert_eq!(r1 * Vector3::x(), Vector3::x());
/// // Rotation of the Z vector about X by half pi, yields -Y
/// assert!((r1 * Vector3::z() - Vector3::y()).norm() < f64::EPSILON);
/// // Rotation of the Y vector about X by half pi, yields Z
/// assert!((r1 * Vector3::y() + Vector3::z()).norm() < f64::EPSILON);
/// ```
///
/// # Warnings
///
/// + No frame checks are done when multiplying by a vector
/// + As a Vector3, this is assumed to be only position, and so the transport theorem is not applied.
///
fn mul(self, rhs: Vector3) -> Self::Output {
self.rot_mat * rhs
}
}
impl Mul<Vector6> for DCM {
type Output = Vector6;
/// Applying the matrix to a vector yields the vector's representation in the new coordinate system.
fn mul(self, rhs: Vector6) -> Self::Output {
self.state_dcm() * rhs
}
}
impl Mul<CartesianState> for DCM {
type Output = PhysicsResult<CartesianState>;
fn mul(self, rhs: CartesianState) -> Self::Output {
self * &rhs
}
}
impl Mul<&CartesianState> for DCM {
type Output = PhysicsResult<CartesianState>;
fn mul(self, rhs: &CartesianState) -> Self::Output {
ensure!(
self.from == rhs.frame.orientation_id,
InvalidStateRotationSnafu {
from: self.from,
to: self.to,
state_frame: rhs.frame
}
);
let new_state = self.state_dcm() * rhs.to_cartesian_pos_vel();
let mut rslt = *rhs;
rslt.radius_km = new_state.fixed_rows::<3>(0).to_owned().into();
rslt.velocity_km_s = new_state.fixed_rows::<3>(3).to_owned().into();
rslt.frame.orientation_id = self.to;
Ok(rslt)
}
}
impl Mul<Matrix3> for DCM {
type Output = Self;
/// Multiplying a DCM with a Matrix3 will apply that matrix to BOTH the DCM and its time derivative.
fn mul(mut self, rhs: Matrix3) -> Self::Output {
self.rot_mat *= rhs;
self.rot_mat_dt = self.rot_mat_dt.map(|rot_mat_dt| rot_mat_dt * rhs);
self
}
}
impl From<DCM> for Quaternion {
/// Convert from a DCM into its quaternion representation
///
/// # Warning
/// If this DCM has a time derivative, it will be lost in the conversion.
///
/// # Failure cases
/// This conversion cannot fail.
fn from(dcm: DCM) -> Self {
// From Basilisk's `C2EP` function
let c = dcm.rot_mat;
let tr = c.trace();
let b2 = Vector4::new(
(1.0 + tr) / 4.0,
(1.0 + 2.0 * c[(0, 0)] - tr) / 4.0,
(1.0 + 2.0 * c[(1, 1)] - tr) / 4.0,
(1.0 + 2.0 * c[(2, 2)] - tr) / 4.0,
);
let (w, x, y, z) = match b2.imax() {
0 => {
let w = b2[0].sqrt();
(
w,
(c[(1, 2)] - c[(2, 1)]) / (4.0 * w),
(c[(2, 0)] - c[(0, 2)]) / (4.0 * w),
(c[(0, 1)] - c[(1, 0)]) / (4.0 * w),
)
}
1 => {
let mut x = b2[1].sqrt();
let mut w = (c[(1, 2)] - c[(2, 1)]) / (4.0 * x);
if w < 0.0 {
w = -w;
x = -x;
}
let y = (c[(0, 1)] + c[(1, 0)]) / (4.0 * x);
let z = (c[(2, 0)] + c[(0, 2)]) / (4.0 * x);
(w, x, y, z)
}
2 => {
let mut y = b2[2].sqrt();
let mut w = (c[(2, 0)] - c[(0, 2)]) / (4.0 * y);
if w < 0.0 {
w = -w;
y = -y;
}
let x = (c[(0, 1)] + c[(1, 0)]) / (4.0 * y);
let z = (c[(1, 2)] + c[(2, 1)]) / (4.0 * y);
(w, x, y, z)
}
3 => {
let mut z = b2[3].sqrt();
let mut w = (c[(0, 1)] - c[(1, 0)]) / (4.0 * z);
if w < 0.0 {
z = -z;
w = -w;
}
let x = (c[(2, 0)] + c[(0, 2)]) / (4.0 * z);
let y = (c[(1, 2)] + c[(2, 1)]) / (4.0 * z);
(w, x, y, z)
}
_ => unreachable!(),
};
Quaternion::new(w, x, y, z, dcm.from, dcm.to)
}
}
impl From<Quaternion> for DCM {
/// Returns the direction cosine matrix in terms of the provided euler parameter
fn from(q: Quaternion) -> Self {
let q = q.normalize();
let q0 = q.w;
let q1 = q.x;
let q2 = q.y;
let q3 = q.z;
let mut c = Matrix3::zeros();
c[(0, 0)] = q0 * q0 + q1 * q1 - q2 * q2 - q3 * q3;
c[(0, 1)] = 2.0 * (q1 * q2 + q0 * q3);
c[(0, 2)] = 2.0 * (q1 * q3 - q0 * q2);
c[(1, 0)] = 2.0 * (q1 * q2 - q0 * q3);
c[(1, 1)] = q0 * q0 - q1 * q1 + q2 * q2 - q3 * q3;
c[(1, 2)] = 2.0 * (q2 * q3 + q0 * q1);
c[(2, 0)] = 2.0 * (q1 * q3 + q0 * q2);
c[(2, 1)] = 2.0 * (q2 * q3 - q0 * q1);
c[(2, 2)] = q0 * q0 - q1 * q1 - q2 * q2 + q3 * q3;
Self {
rot_mat: c,
rot_mat_dt: None,
from: q.from,
to: q.to,
}
}
}
impl PartialEq for DCM {
fn eq(&self, other: &Self) -> bool {
if (self.rot_mat_dt.is_none() && other.rot_mat_dt.is_some())
|| (self.rot_mat_dt.is_some() && other.rot_mat_dt.is_none())
{
false
} else {
let rot_mat_match = (self.rot_mat - other.rot_mat).norm() < 1e-1;
let dt_match = if let Some(self_dt) = self.rot_mat_dt {
(self_dt - other.rot_mat_dt.unwrap()).norm() < 1e-5
} else {
true
};
self.from == other.from && self.to == other.to && rot_mat_match && dt_match
}
}
}
impl fmt::Display for DCM {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"Rotation {:o} -> {:o} (transport theorem = {}){}Derivative: {}",
Frame::from_orient_ssb(self.from),
Frame::from_orient_ssb(self.to),
self.rot_mat_dt.is_some(),
self.rot_mat,
match self.rot_mat_dt {
None => "None".to_string(),
Some(dcm_dt) => format!("{dcm_dt}"),
}
)
}
}
#[cfg(test)]
mod ut_dcm {
use crate::math::Matrix3;
use super::{Vector3, DCM};
use core::f64::consts::FRAC_PI_2;
#[test]
fn test_r1() {
let r1 = DCM::r1(FRAC_PI_2, 0, 1);
// Rotation of the X vector about X, yields X
assert_eq!(r1 * Vector3::x(), Vector3::x());
// Rotation of the Z vector about X by half pi, yields Y
assert!((r1 * Vector3::z() - Vector3::y()).norm() < f64::EPSILON);
// Rotation of the Y vector about X by half pi, yields -Z
assert!((r1 * Vector3::y() + Vector3::z()).norm() < f64::EPSILON);
assert!(
(r1.rot_mat - Matrix3::new(1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, -1.0, 0.0)).norm()
< f64::EPSILON
);
}
#[test]
fn test_r2() {
let r2 = DCM::r2(FRAC_PI_2, 0, 1);
// Rotation of the Y vector about Y, yields Y
assert_eq!(r2 * Vector3::y(), Vector3::y());
// Rotation of the X vector about Y by -half pi, yields Z
assert!((r2 * Vector3::x() - Vector3::z()).norm() < f64::EPSILON);
// Rotation of the Z vector about Y by -half pi, yields -X
assert!((r2 * Vector3::z() + Vector3::x()).norm() < f64::EPSILON);
// Edge case: Rotation by 0 degrees should yield the original vector
let r2_zero = DCM::r2(0.0, 0, 1);
assert!((r2_zero * Vector3::x() - Vector3::x()).norm() < f64::EPSILON);
assert!(
(r2.rot_mat - Matrix3::new(0.0, 0.0, -1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 0.0)).norm()
< f64::EPSILON
);
}
#[test]
fn test_r3() {
let r3 = DCM::r3(FRAC_PI_2, 0, 1);
assert!(r3.is_valid(1e-12, 1e-12));
// Rotation of the Z vector about Z, yields Z
assert_eq!(r3 * Vector3::z(), Vector3::z());
// Rotation of the X vector about Z by -half pi, yields -Y
assert!((r3 * Vector3::x() + Vector3::y()).norm() < f64::EPSILON);
// Rotation of the Y vector about Z by -half pi, yields X
assert!((r3 * Vector3::y() - Vector3::x()).norm() < f64::EPSILON);
// Edge case: Rotation by 0 degrees should yield the original vector
let r3_zero = DCM::r3(0.0, 0, 1);
assert!((r3_zero * Vector3::x() - Vector3::x()).norm() < f64::EPSILON);
assert!(
(r3.rot_mat - Matrix3::new(0.0, 1.0, 0.0, -1.0, 0.0, 0.0, 0.0, 0.0, 1.0)).norm()
< f64::EPSILON
);
}
#[test]
fn test_align_and_clock_ric() {
// SCENARIO: Replicate the creation of an RIC (Radial-Intrack-Crosstrack) Frame.
// We want to construct the rotation FROM RIC TO Inertial.
// 1. Define "Inertial" vectors (Mock data)
// R (Position) is along Inertial Y
let r_inertial = Vector3::y();
// V (Velocity) is along Inertial -X
let v_inertial = -Vector3::x();
// Compute the basis vectors expected for RIC (Right-Handed)
// Radial (R) = r / |r| = +Y
// Cross-track (C) = (r x v) / |r x v| = (Y x -X) = Z
// In-track (I) = C x R = (Z x Y) = -X (Matches velocity direction)
let r_hat = r_inertial.normalize();
let c_hat = r_inertial.cross(&v_inertial).normalize();
let i_hat = c_hat.cross(&r_hat); // Right-handed definition
// Build the Expected DCM (RIC -> Inertial)
// Columns are the basis vectors expressed in Inertial
let expected_rot = Matrix3::from_columns(&[r_hat, i_hat, c_hat]);
let expected_dcm = DCM {
rot_mat: expected_rot,
rot_mat_dt: None,
from: 10, // RIC
to: 20, // Inertial
};
// 2. Use align_and_clock to generate this DCM
// We want R_{RIC->Inertial}.
// Primary Constraint: RIC Radial (+X) aligns with Inertial Position (r_hat)
let primary_body = Vector3::x();
let primary_inertial = r_inertial;
// Secondary Constraint: RIC Cross-track (+Z) aligns with Inertial Angular Momentum (c_hat)
// (This clocks the Y axis to be In-track)
let secondary_body = Vector3::z();
let secondary_inertial = r_inertial.cross(&v_inertial);
let dcm = DCM::align_and_clock(
primary_body,
primary_inertial,
secondary_body,
secondary_inertial,
10, // from RIC
20, // to Inertial
)
.expect("Alignment should succeed");
// 3. Compare
assert!(
(dcm.rot_mat - expected_dcm.rot_mat).norm() < 1e-12,
"Align/Clock DCM did not match constructed RIC frame.\nGot:\n{}\nExpected:\n{}",
dcm.rot_mat,
expected_dcm.rot_mat
);
// Verify individual vector mappings
// 1. X_RIC (Radial) should map to +Y_Inertial
let x_mapped = dcm * Vector3::x();
assert!((x_mapped - Vector3::y()).norm() < 1e-12);
// 2. Z_RIC (Cross-track) should map to +Z_Inertial (since Y x -X = Z)
let z_mapped = dcm * Vector3::z();
assert!((z_mapped - Vector3::z()).norm() < 1e-12);
}
}