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

/*
 * File: stm_focus.rs
 * Project: defined
 * Created Date: 05/10/2023
 * Author: Shun Suzuki
 * -----
 * Last Modified: 21/11/2023
 * Modified By: Shun Suzuki (suzuki@hapis.k.u-tokyo.ac.jp)
 * -----
 * Copyright (c) 2023 Shun Suzuki. All rights reserved.
 *
 */

use crate::{common::EmitIntensity, defined::float, derive::prelude::AUTDInternalError};

use super::{FOCUS_STM_FIXED_NUM_LOWER, FOCUS_STM_FIXED_NUM_UNIT, FOCUS_STM_FIXED_NUM_UPPER};

#[repr(C)]
pub struct STMFocus {
    pub(crate) buf: [u16; 4],
}

impl STMFocus {
    pub fn set(
        &mut self,
        x: float,
        y: float,
        z: float,
        intensity: EmitIntensity,
    ) -> Result<(), AUTDInternalError> {
        let ix = (x / FOCUS_STM_FIXED_NUM_UNIT).round() as i32;
        let iy = (y / FOCUS_STM_FIXED_NUM_UNIT).round() as i32;
        let iz = (z / FOCUS_STM_FIXED_NUM_UNIT).round() as i32;
        if !(FOCUS_STM_FIXED_NUM_LOWER..=FOCUS_STM_FIXED_NUM_UPPER).contains(&ix)
            || !(FOCUS_STM_FIXED_NUM_LOWER..=FOCUS_STM_FIXED_NUM_UPPER).contains(&iy)
            || !(FOCUS_STM_FIXED_NUM_LOWER..=FOCUS_STM_FIXED_NUM_UPPER).contains(&iz)
        {
            return Err(AUTDInternalError::FocusSTMPointOutOfRange(x, y, z));
        }
        self.buf[0] = (ix & 0xFFFF) as u16;
        self.buf[1] = ((iy << 2) & 0xFFFC) as u16
            | ((ix >> 30) & 0x0002) as u16
            | ((ix >> 16) & 0x0001) as u16;
        self.buf[2] = ((iz << 4) & 0xFFF0) as u16
            | ((iy >> 28) & 0x0008) as u16
            | ((iy >> 14) & 0x0007) as u16;
        self.buf[3] = (((intensity.value() as u16) << 6) & 0x3FC0)
            | ((iz >> 26) & 0x0020) as u16
            | ((iz >> 12) & 0x001F) as u16;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use crate::fpga::FOCUS_STM_FIXED_NUM_WIDTH;

    use super::*;

    #[test]
    fn stm_focus() {
        let mut p = STMFocus { buf: [0; 4] };

        let x = FOCUS_STM_FIXED_NUM_UNIT;
        let y = 2. * FOCUS_STM_FIXED_NUM_UNIT;
        let z = 3. * FOCUS_STM_FIXED_NUM_UNIT;
        let intensity = EmitIntensity::new(4);

        assert!(p.set(x, y, z, intensity).is_ok());

        assert_eq!(
            (p.buf[0] as u32) & ((1 << FOCUS_STM_FIXED_NUM_WIDTH) - 1),
            1
        );
        assert_eq!(
            ((p.buf[1] >> 2) as u32) & ((1 << FOCUS_STM_FIXED_NUM_WIDTH) - 1),
            2
        );
        assert_eq!(
            ((p.buf[2] >> 4) as u32) & ((1 << FOCUS_STM_FIXED_NUM_WIDTH) - 1),
            3
        );
        assert_eq!((p.buf[3] >> 6) & 0xFF, 4);

        let x = -FOCUS_STM_FIXED_NUM_UNIT;
        let y = -2. * FOCUS_STM_FIXED_NUM_UNIT;
        let z = -3. * FOCUS_STM_FIXED_NUM_UNIT;
        let intensity = EmitIntensity::new(0xFF);

        assert!(p.set(x, y, z, intensity).is_ok());

        assert_eq!(p.buf[0], 0xFFFF);
        assert_eq!(p.buf[1] & 0b01, 0b01);
        assert_eq!(p.buf[1] & 0b10, 0b10);

        assert_eq!(p.buf[1] & 0b1111111111111100, 0b1111111111111000);
        assert_eq!(p.buf[2] & 0b0111, 0b0111);
        assert_eq!(p.buf[2] & 0b1000, 0b1000);

        assert_eq!(p.buf[2] & 0b1111111111110000, 0b1111111111010000);
        assert_eq!(p.buf[3] & 0b011111, 0b011111);
        assert_eq!(p.buf[3] & 0b100000, 0b100000);

        assert_eq!((p.buf[3] >> 6) & 0xFF, 0xFF);

        let x = FOCUS_STM_FIXED_NUM_UNIT * ((1 << (FOCUS_STM_FIXED_NUM_WIDTH - 1)) - 1) as float;
        let y = FOCUS_STM_FIXED_NUM_UNIT * ((1 << (FOCUS_STM_FIXED_NUM_WIDTH - 1)) - 1) as float;
        let z = FOCUS_STM_FIXED_NUM_UNIT * ((1 << (FOCUS_STM_FIXED_NUM_WIDTH - 1)) - 1) as float;
        let intensity = EmitIntensity::new(0);

        assert!(p.set(x, y, z, intensity).is_ok());

        assert!(p
            .set(x + FOCUS_STM_FIXED_NUM_UNIT, y, z, intensity)
            .is_err());
        assert!(p
            .set(x, y + FOCUS_STM_FIXED_NUM_UNIT, z, intensity)
            .is_err());
        assert!(p
            .set(x, y, z + FOCUS_STM_FIXED_NUM_UNIT, intensity)
            .is_err());

        let x = -FOCUS_STM_FIXED_NUM_UNIT * (1 << (FOCUS_STM_FIXED_NUM_WIDTH - 1)) as float;
        let y = -FOCUS_STM_FIXED_NUM_UNIT * (1 << (FOCUS_STM_FIXED_NUM_WIDTH - 1)) as float;
        let z = -FOCUS_STM_FIXED_NUM_UNIT * (1 << (FOCUS_STM_FIXED_NUM_WIDTH - 1)) as float;
        let intensity = EmitIntensity::new(0);

        assert!(p.set(x, y, z, intensity).is_ok());

        assert!(p
            .set(x - FOCUS_STM_FIXED_NUM_UNIT, y, z, intensity)
            .is_err());
        assert!(p
            .set(x, y - FOCUS_STM_FIXED_NUM_UNIT, z, intensity)
            .is_err());
        assert!(p
            .set(x, y, z - FOCUS_STM_FIXED_NUM_UNIT, intensity)
            .is_err());
    }
}