crseo 2.5.3

Cuda Engined Optics Rust Interface
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 super::{Diffractive, Geometric, Model};
use crate::{
    builders::SourceBuilder,
    imaging::{Detector, LensletArray, NoiseDataSheet},
    Builder, Cu, FromBuilder, Result, Source, WavefrontSensor, WavefrontSensorBuilder,
};
pub mod sensor;
pub use sensor::ShackHartmann;
use serde::{Deserialize, Serialize};

/// `ShackHartmann` builder
///
/// Default properties:
///  - n_sensor: 1
///  - lenslet_array:
///    - n_lenslet: 1
///    - n_px_lenslet: 511px
///    - lenslet_pitch: 25.5m
///  - detector:
///    - n_px_framelet: 512px
///    - n_px_imagelet: None\[512px\]
///    - osf: None\[2\]
///
/// # Examples
///
/// ```
/// use crseo::{Builder, FromBuilder,  ShackHartmann, Geometric};
/// let mut wfs = ShackHartmann::<Geometric>::builder().build();
/// ```
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub struct ShackHartmannBuilder<T: Model> {
    pub n_sensor: usize,
    pub lenslet_array: LensletArray,
    pub detector: Detector,
    marker: std::marker::PhantomData<T>,
}
impl<T: Model> FromBuilder for ShackHartmann<T> {
    type ComponentBuilder = ShackHartmannBuilder<T>;
}
impl<T: Model> PartialEq for ShackHartmannBuilder<T> {
    fn eq(&self, other: &Self) -> bool {
        self.n_sensor == other.n_sensor
            && self.lenslet_array == other.lenslet_array
            && self.detector == other.detector
    }
}
impl<T: Model> Default for ShackHartmannBuilder<T> {
    fn default() -> Self {
        ShackHartmannBuilder {
            n_sensor: 1,
            lenslet_array: LensletArray::default(),
            detector: Detector::default(),
            marker: std::marker::PhantomData,
        }
    }
}
impl<T: Model> ShackHartmannBuilder<T> {
    pub fn n_sensor(self, n_sensor: usize) -> Self {
        Self { n_sensor, ..self }
    }
    pub fn lenslet_array(self, n_side_lenslet: usize, n_px_lenslet: usize, d: f64) -> Self {
        Self {
            lenslet_array: LensletArray {
                n_side_lenslet,
                n_px_lenslet,
                d,
            },
            ..self
        }
    }
    pub fn detector(
        self,
        n_px_framelet: usize,
        n_px_imagelet: Option<usize>,
        osf: usize,
        noise_specs: Option<NoiseDataSheet>,
    ) -> Self {
        Self {
            detector: Detector {
                n_px_framelet,
                n_px_imagelet,
                osf,
                noise_specs,
            },
            ..self
        }
    }
}
impl<T: Model> WavefrontSensorBuilder for ShackHartmannBuilder<T> {
    fn guide_stars(&self, template: Option<SourceBuilder>) -> SourceBuilder {
        let LensletArray {
            n_side_lenslet,
            n_px_lenslet,
            d,
        } = self.lenslet_array;
        match template {
            Some(src) => src,
            None => Source::builder(),
        }
        .size(self.n_sensor)
        .pupil_size(d * n_side_lenslet as f64)
        .pupil_sampling(n_px_lenslet * n_side_lenslet + 1)
    }

    fn detector_noise_specs(self, noise_specs: NoiseDataSheet) -> Self {
        let mut detector = self.detector;
        detector.noise_specs = Some(noise_specs);
        Self { detector, ..self }
    }
}
impl<T: Model> Builder for ShackHartmannBuilder<T> {
    type Component = ShackHartmann<T>;
    fn build(self) -> Result<ShackHartmann<T>> {
        let LensletArray {
            n_side_lenslet,
            n_px_lenslet,
            d,
        } = self.lenslet_array;
        let Detector {
            n_px_framelet,
            n_px_imagelet,
            osf,
            noise_specs,
        } = self.detector;
        let mut wfs = ShackHartmann::<T> {
            _c_: Model::new(),
            n_side_lenslet: n_side_lenslet as i32,
            n_px_lenslet: n_px_lenslet as i32,
            d,
            n_sensor: self.n_sensor as i32,
            n_centroids: 0,
            centroids: Cu::vector((n_side_lenslet * n_side_lenslet * 2 * self.n_sensor) as usize),
            detector_noise_model: noise_specs,
        };
        let n_px = match n_px_imagelet {
            Some(n_px_imagelet) => n_px_imagelet,
            None => n_px_framelet,
        };
        let b = n_px / n_px_framelet;
        wfs.n_centroids = wfs.n_side_lenslet * wfs.n_side_lenslet * 2 * wfs.n_sensor;
        wfs._c_.build(
            wfs.n_side_lenslet,
            wfs.d as f32,
            wfs.n_sensor,
            wfs.n_px_lenslet,
            osf as i32,
            n_px as i32,
            b as i32,
        );
        wfs.centroids.from_ptr(wfs._c_.as_mut_ptr());
        Ok(wfs)
    }
}