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 std::ops::DerefMut;

use skyangle::Conversion;

use crate::{
    builders::{GmtBuilder, SourceBuilder},
    Builder,
};

use super::SegmentPistonSensor;

/// Segment piston sensor builder
///
/// Default properties
///  - lenslet size      : 1.5m
///  - dispersion        : 5"/micron
///  - field-of-view     : 3"
///  - nyquist_factor    : 1.0
///  - binning factor    : 2
///  - DFT preallocation : true
///
/// # Examples
///
/// ```
/// use crseo::{Builder, FromBuilder, SegmentPistonSensor};
/// let mut sps = SegmentPistonSensor::builder().build();
/// ```
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct SegmentPistonSensorBuilder {
    gmt_builder: GmtBuilder,
    src_builder: SourceBuilder,
    lenslet_size: f64,
    dispersion: f64,
    field_of_view: f64,
    nyquist_factor: f64,
    bin_image: usize,
    malloc_dft: bool,
    middle_mask_width: Option<f64>,
}

impl Default for SegmentPistonSensorBuilder {
    fn default() -> Self {
        Self {
            gmt_builder: GmtBuilder::default(),
            src_builder: SourceBuilder::default(),
            lenslet_size: 1.5,
            dispersion: 5.0.from_arcsec() * 1e6,
            field_of_view: 3.2.from_arcsec(),
            nyquist_factor: 1.0,
            bin_image: 2,
            malloc_dft: true,
            middle_mask_width: None,
        }
    }
}

impl SegmentPistonSensorBuilder {
    /// Sets the [GMT builder](GmtBuilder)
    pub fn gmt(mut self, gmt: GmtBuilder) -> Self {
        self.gmt_builder = gmt;
        self
    }
    /// Sets the [source builder](SourceBuilder)
    pub fn src(mut self, src: SourceBuilder) -> Self {
        self.src_builder = src;
        self
    }
    /// Sets the lenslet size in meters
    pub fn lenslet_size(mut self, lenslet_size: f64) -> Self {
        self.lenslet_size = lenslet_size;
        self
    }
    /// Sets the dispersion in radians per meter
    pub fn dispersion(mut self, dispersion: f64) -> Self {
        self.dispersion = dispersion;
        self
    }
    /// Sets the field of view in radians
    pub fn field_of_view(mut self, field_of_view: f64) -> Self {
        self.field_of_view = field_of_view;
        self
    }
    /// Sets the Nyquist factor
    pub fn nyquist_factor(mut self, nyquist_factor: f64) -> Self {
        self.nyquist_factor = nyquist_factor;
        self
    }
    /// Sets the image binning factor
    pub fn bin_image(mut self, bin_image: usize) -> Self {
        self.bin_image = bin_image;
        self
    }
    /// Sets the DFT preallocation flag
    pub fn malloc_dft(mut self, malloc_dft: bool) -> Self {
        self.malloc_dft = malloc_dft;
        self
    }
    /// Sets the lenslet mask width in meters
    pub fn middle_mask_width(mut self, middle_mask_width: f64) -> Self {
        self.middle_mask_width = Some(middle_mask_width);
        self
    }
}

impl Builder for SegmentPistonSensorBuilder {
    type Component = SegmentPistonSensor;

    fn build(self) -> crate::Result<Self::Component> {
        let Self {
            gmt_builder,
            src_builder,
            lenslet_size,
            dispersion,
            field_of_view,
            nyquist_factor,
            bin_image,
            malloc_dft,
            middle_mask_width,
        } = self;
        let mut gmt = gmt_builder.build()?;
        let mut src = src_builder.build()?;
        let mut sps = SegmentPistonSensor {
            _c_: Default::default(),
            malloc_dft,
            middle_mask_width,
        };
        if malloc_dft {
            unsafe {
                sps._c_.setup3(
                    gmt.m1.deref_mut(),
                    src.as_raw_mut_ptr(),
                    lenslet_size as f32,
                    dispersion as f32,
                    field_of_view as f32,
                    nyquist_factor as f32,
                    bin_image as i32,
                )
            }
        } else {
            unsafe {
                sps._c_.setup_alt(
                    gmt.m1.deref_mut(),
                    src.as_raw_mut_ptr(),
                    dispersion as f32,
                    field_of_view as f32,
                    nyquist_factor as f32,
                    bin_image as i32,
                )
            }
        }
        Ok(sps)
    }
}