Skip to main content

nominal_api/conjure/objects/scout/compute/api/
nyquist.rs

1/// Returns a complex-valued frequency response, H(f), of the input series to the output series.
2#[derive(
3    Debug,
4    Clone,
5    conjure_object::serde::Serialize,
6    conjure_object::serde::Deserialize,
7    conjure_object::private::DeriveWith
8)]
9#[serde(crate = "conjure_object::serde")]
10#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[conjure_object::private::staged_builder::staged_builder]
12#[builder(crate = conjure_object::private::staged_builder, update, inline)]
13pub struct Nyquist {
14    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
15    #[serde(rename = "input")]
16    input: Box<super::NumericSeries>,
17    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
18    #[serde(rename = "output")]
19    output: Box<super::NumericSeries>,
20    #[builder(
21        default,
22        custom(
23            type = impl
24            Into<Option<super::StftOptions>>,
25            convert = |v|v.into().map(Box::new)
26        )
27    )]
28    #[serde(rename = "stftOptions", skip_serializing_if = "Option::is_none", default)]
29    stft_options: Option<Box<super::StftOptions>>,
30}
31impl Nyquist {
32    /// Constructs a new instance of the type.
33    #[inline]
34    pub fn new(input: super::NumericSeries, output: super::NumericSeries) -> Self {
35        Self::builder().input(input).output(output).build()
36    }
37    #[inline]
38    pub fn input(&self) -> &super::NumericSeries {
39        &*self.input
40    }
41    #[inline]
42    pub fn output(&self) -> &super::NumericSeries {
43        &*self.output
44    }
45    #[inline]
46    pub fn stft_options(&self) -> Option<&super::StftOptions> {
47        self.stft_options.as_ref().map(|o| &**o)
48    }
49}