Skip to main content

LeBailPhase

Struct LeBailPhase 

Source
pub struct LeBailPhase { /* private fields */ }
Expand description

One fixed reflection phase whose integrated intensities are extracted.

Implementations§

Source§

impl LeBailPhase

Source

pub fn new( phase_id: impl Into<String>, name: impl Into<String>, reflection_ids: Vec<String>, hkl: Vec<[i32; 3]>, d_spacing_angstrom: Vec<f64>, two_theta_deg: Vec<f64>, integrated_intensity: Vec<f64>, scale: f64, preserve_unobserved: Vec<bool>, ) -> Result<Self, LeBailError>

Validate and own one ordered fixed-reflection phase.

preserve_unobserved marks generated reflections outside the currently visible interval. Their checkpoint intensity is retained when their finite profile support has no included samples. Pass an empty vector for ordinary fixed reflection lists.

§Errors

Returns LeBailError::InvalidPhase for invalid identity, shape, or numerical state.

Source

pub fn from_lattice_domain( phase_id: impl Into<String>, name: impl Into<String>, cell: UnitCell, scale: f64, reflection_domain: LatticeReflectionDomain, ) -> Result<Self, LeBailError>

Generate and own a bounded dynamic-lattice phase.

§Errors

Returns LeBailError if the cell lies outside the domain, reflection generation fails, or the resulting phase state is invalid.

Source

pub fn phase_id(&self) -> &str

Borrow the stable phase ID.

Source

pub fn name(&self) -> &str

Borrow the display name.

Source

pub fn reflection_ids(&self) -> &[String]

Borrow reflection IDs in calculation order.

Source

pub fn hkl(&self) -> &[[i32; 3]]

Borrow Miller indices in reflection order.

Source

pub fn d_spacing_angstrom(&self) -> &[f64]

Borrow d-spacings in ångströms.

Source

pub fn two_theta_deg(&self) -> &[f64]

Borrow fixed reflection positions in degrees 2theta.

Source

pub fn integrated_intensity(&self) -> &[f64]

Borrow current integrated intensities.

Source

pub fn with_integrated_intensities( &self, values: &[f64], ) -> Result<Self, LeBailError>

Replace integrated intensities while preserving phase identity/geometry.

§Errors

Returns LeBailError for a shape mismatch, negative value, or non-finite value.

Source

pub const fn scale(&self) -> f64

Return the phase scale.

Source

pub fn preserve_unobserved(&self) -> &[bool]

Borrow the preserve-if-unobserved mask.

Source

pub const fn cell(&self) -> Option<UnitCell>

Return the current cell for a dynamic-lattice phase.

Source

pub const fn reflection_domain(&self) -> Option<&LatticeReflectionDomain>

Borrow the guarded reflection domain for a dynamic-lattice phase.

Source

pub fn regenerate_lattice_at_cell( &self, cell: UnitCell, ) -> Result<Self, LeBailError>

Regenerate a dynamic phase at another accepted bounded cell.

Intensities transfer by stable reflection ID and new families use the domain’s declared initial intensity.

§Errors

Returns LeBailError for a fixed phase, out-of-bounds cell, or reflection-generation failure.

Trait Implementations§

Source§

impl Clone for LeBailPhase

Source§

fn clone(&self) -> LeBailPhase

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 LeBailPhase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LeBailPhase

Source§

fn eq(&self, other: &LeBailPhase) -> 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 LeBailPhase

Auto Trait Implementations§

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<U> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.