Struct PatternRecord

Source

pub struct PatternRecord {
    pub x_deg: Vec<f64>,
    pub observed_y: Option<Vec<f64>>,
    pub uncertainty: Option<Vec<f64>>,
    pub mask: Option<Vec<bool>>,
    pub background_y: Vec<f64>,
}

Expand description

Owned observed powder pattern for one histogram.

Fields§

§x_deg: Vec<f64>

Strictly increasing coordinate grid in degrees 2theta.

§observed_y: Option<Vec<f64>>

Optional observed intensity values.

§uncertainty: Option<Vec<f64>>

Optional positive one-sigma uncertainties.

§mask: Option<Vec<bool>>

Optional inclusion mask.

§background_y: Vec<f64>

Supplied fixed background, always sample-aligned.

Implementations§

Source §

impl PatternRecord

Source

pub fn new( x_deg: Vec<f64>, observed_y: Option<Vec<f64>>, uncertainty: Option<Vec<f64>>, mask: Option<Vec<bool>>, background_y: Option<Vec<f64>>, ) -> Result<Self, DomainError>

Validate and own one pattern grid and its optional observations.

§Errors

Returns DomainError for non-finite, unordered, or mismatched arrays.

Source

pub fn sample_count(&self) -> usize

Return the number of samples.

Source

pub fn validate(&self) -> Result<(), DomainError>

Revalidate all arrays after direct adapter-side record construction.

§Errors

Returns DomainError for non-finite, unordered, or mismatched arrays.

Trait Implementations§

Source §

impl Clone for PatternRecord

Source §

fn clone(&self) -> PatternRecord

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl Debug for PatternRecord

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Source §

impl PartialEq for PatternRecord

Source §

fn eq(&self, other: &PatternRecord) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for PatternRecord

Auto Trait Implementations§

§

impl UnwindSafe for PatternRecord

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §