autd3 38.1.0

AUTD3 library
Documentation 
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

use autd3_core::derive::*;

use autd3_driver::{common::rad, geometry::UnitVector3};

/// The option of [`Plane`].
#[derive(Debug, Clone, Copy, PartialEq)]
#[repr(C)]
pub struct PlaneOption {
    /// The intensity of the wave.
    pub intensity: Intensity,
    /// The phase offset of the wave.
    pub phase_offset: Phase,
}

impl Default for PlaneOption {
    fn default() -> Self {
        Self {
            intensity: Intensity::MAX,
            phase_offset: Phase::ZERO,
        }
    }
}

/// Plane wave
#[derive(Gain, Clone, PartialEq, Debug)]
pub struct Plane {
    /// The direction of the plane wave.
    pub dir: UnitVector3,
    /// The option of the gain.
    pub option: PlaneOption,
}

impl Plane {
    /// Create a new [`Plane`].
    #[must_use]
    pub const fn new(dir: UnitVector3, option: PlaneOption) -> Self {
        Self { dir, option }
    }
}

#[derive(Clone, Copy)]
pub struct Impl {
    dir: UnitVector3,
    intensity: Intensity,
    phase_offset: Phase,
    wavenumber: f32,
}

impl GainCalculator<'_> for Impl {
    fn calc(&self, tr: &Transducer) -> Drive {
        Drive {
            phase: Phase::from(-self.dir.dot(&tr.position().coords) * self.wavenumber * rad)
                + self.phase_offset,
            intensity: self.intensity,
        }
    }
}

impl GainCalculatorGenerator<'_> for Impl {
    type Calculator = Impl;

    fn generate(&mut self, _: &Device) -> Self::Calculator {
        *self
    }
}

impl Gain<'_> for Plane {
    type G = Impl;

    fn init(
        self,
        _: &Geometry,
        env: &Environment,
        _: &TransducerMask,
    ) -> Result<Self::G, GainError> {
        Ok(Impl {
            dir: self.dir,
            intensity: self.option.intensity,
            phase_offset: self.option.phase_offset,
            wavenumber: env.wavenumber(),
        })
    }
}

#[cfg(test)]
mod tests {
    use rand::RngExt;

    use super::*;

    use crate::tests::{create_geometry, random_vector3};

    fn plane_check(
        mut b: Impl,
        dir: UnitVector3,
        intensity: Intensity,
        phase_offset: Phase,
        geometry: &Geometry,
        env: &Environment,
    ) {
        geometry.iter().for_each(|dev| {
            let d = b.generate(dev);
            dev.iter().for_each(|tr| {
                let expected_phase =
                    Phase::from(-dir.dot(&tr.position().coords) * env.wavenumber() * rad)
                        + phase_offset;
                let d = d.calc(tr);
                assert_eq!(expected_phase, d.phase);
                assert_eq!(intensity, d.intensity);
            });
        });
    }

    #[test]
    fn plane() {
        let mut rng = rand::rng();

        let geometry = create_geometry(1);
        let env = Environment::new();

        let dir = UnitVector3::new_normalize(random_vector3(-1.0..1.0, -1.0..1.0, -1.0..1.0));
        let g = Plane::new(dir, PlaneOption::default());
        plane_check(
            g.init(&geometry, &env, &TransducerMask::AllEnabled)
                .unwrap(),
            dir,
            Intensity::MAX,
            Phase::ZERO,
            &geometry,
            &env,
        );

        let dir = UnitVector3::new_normalize(random_vector3(-1.0..1.0, -1.0..1.0, -1.0..1.0));
        let intensity = Intensity(rng.random());
        let phase_offset = Phase(rng.random());
        let g = Plane {
            dir,
            option: PlaneOption {
                intensity,
                phase_offset,
            },
        };
        plane_check(
            g.init(&geometry, &env, &TransducerMask::AllEnabled)
                .unwrap(),
            dir,
            intensity,
            phase_offset,
            &geometry,
            &env,
        );
    }
}