nominal-api 0.1239.0

/// Returns the bode magnitude and phase of a system's frequency response.
#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct Bode {
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::NumericSeries>,
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "output")]
    output: Box<super::NumericSeries>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::AlignmentConfiguration>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "alignmentConfiguration",
        skip_serializing_if = "Option::is_none",
        default
    )]
    alignment_configuration: Option<Box<super::AlignmentConfiguration>>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::StftOptions>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "stftOptions", skip_serializing_if = "Option::is_none", default)]
    stft_options: Option<Box<super::StftOptions>>,
    #[builder(default, into)]
    #[serde(
        rename = "magnitudeScaling",
        skip_serializing_if = "Option::is_none",
        default
    )]
    magnitude_scaling: Option<super::MagnitudeScaling>,
    #[builder(default, into)]
    #[serde(
        rename = "outputFrequencyType",
        skip_serializing_if = "Option::is_none",
        default
    )]
    output_frequency_type: Option<super::OutputFrequencyType>,
    #[builder(default, into)]
    #[serde(rename = "unwrapPhase", skip_serializing_if = "Option::is_none", default)]
    unwrap_phase: Option<bool>,
}
impl Bode {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(input: super::NumericSeries, output: super::NumericSeries) -> Self {
        Self::builder().input(input).output(output).build()
    }
    #[inline]
    pub fn input(&self) -> &super::NumericSeries {
        &*self.input
    }
    #[inline]
    pub fn output(&self) -> &super::NumericSeries {
        &*self.output
    }
    /// When present, aligns one Bode input to the other using the configured interpolation and driver series
    /// before estimating the frequency response. When absent, Bode preserves the existing strict behavior and
    /// requires the input and output value arrays to have equal length. For Bode, FIRST uses the input
    /// timestamps and SECOND uses the output timestamps.
    #[inline]
    pub fn alignment_configuration(&self) -> Option<&super::AlignmentConfiguration> {
        self.alignment_configuration.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn stft_options(&self) -> Option<&super::StftOptions> {
        self.stft_options.as_ref().map(|o| &**o)
    }
    /// The scaling to apply to the output magnitude. Defaults to MAGNITUDE_DB_20 if not specified.
    #[inline]
    pub fn magnitude_scaling(&self) -> Option<&super::MagnitudeScaling> {
        self.magnitude_scaling.as_ref().map(|o| &*o)
    }
    /// The type of the output frequency. Defaults to LINEAR if not specified.
    #[inline]
    pub fn output_frequency_type(&self) -> Option<&super::OutputFrequencyType> {
        self.output_frequency_type.as_ref().map(|o| &*o)
    }
    /// Unwrap the phase of the output. Defaults to true if not specified.
    #[inline]
    pub fn unwrap_phase(&self) -> Option<bool> {
        self.unwrap_phase.as_ref().map(|o| *o)
    }
}