Skip to main content

ResolutionParams

Struct ResolutionParams 

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

Resolution function parameters for time-of-flight instruments.

Implementations§

Source§

impl ResolutionParams

Source

pub fn new( flight_path_m: f64, delta_t_us: f64, delta_l_m: f64, delta_e_us: f64, ) -> Result<Self, ResolutionParamsError>

Create validated resolution parameters.

delta_t_us and delta_l_m are W-parameters (σ = W/√2), not standard deviations. If your instrument numbers are 1σ or FWHM, use from_sigma or from_fwhm instead of converting by hand.

§Arguments
  • flight_path_m — Flight path length in meters (must be > 0).
  • delta_t_us — Timing width in microseconds, W-parameter (must be >= 0).
  • delta_l_m — Flight path width in meters, W-parameter (must be >= 0).
  • delta_e_us — Exponential tail parameter in SAMMY Deltae units (must be >= 0). When 0, pure Gaussian broadening is used.
§Errors

Returns ResolutionParamsError::InvalidFlightPath if flight_path_m <= 0.0 or is not finite. Returns ResolutionParamsError::InvalidDeltaT if delta_t_us < 0.0 or is not finite. Returns ResolutionParamsError::InvalidDeltaL if delta_l_m < 0.0 or is not finite. Returns ResolutionParamsError::InvalidDeltaE if delta_e_us < 0.0 or is not finite.

Source

pub fn from_sigma( flight_path_m: f64, sigma_t_us: f64, sigma_l_m: f64, delta_e_us: f64, ) -> Result<Self, ResolutionParamsError>

Create resolution parameters from standard deviations.

Instrument metrology is usually quoted as a 1σ jitter, while this type stores W-parameters. This constructor applies W = σ·√2 to the timing and flight-path terms, so a measured 1σ can be passed in directly.

delta_e_us is not a Gaussian width — it is SAMMY’s exponential tail parameter Deltae — so it is passed through unchanged.

§Errors

Same as new, on the converted values.

Source

pub fn from_fwhm( flight_path_m: f64, fwhm_t_us: f64, fwhm_l_m: f64, delta_e_us: f64, ) -> Result<Self, ResolutionParamsError>

Create resolution parameters from full widths at half maximum.

Applies W = FWHM/(2·√(ln 2)) to the timing and flight-path terms. This is the measure SAMMY’s Deltag uses, so a value taken from a SAMMY .inp timing field can be passed in directly.

delta_e_us is SAMMY’s exponential tail parameter, not a Gaussian width, so it is passed through unchanged.

§Errors

Same as new, on the converted values.

Source

pub fn flight_path_m(&self) -> f64

Returns the flight path length in meters.

Source

pub fn delta_t_us(&self) -> f64

Total timing width in microseconds, as a W-parameter (σ = W/√2).

The factor of 2 in gaussian_width() comes from the energy-TOF derivative dE/E = 2·dt/t, not from a width-measure conversion — the convention is unchanged between time and energy.

Source

pub fn delta_l_m(&self) -> f64

Returns the flight path width in meters, as a W-parameter (σ = W/√2).

Source

pub fn delta_e_us(&self) -> f64

Returns the exponential tail parameter (SAMMY Deltae units).

Source

pub fn has_exponential_tail(&self) -> bool

Whether the exponential tail is active (Deltae > 0, SAMMY Iesopr=3).

Source

pub fn exp_width(&self, energy_ev: f64) -> f64

Exponential tail width Widexp(E) in eV.

SAMMY Ref: rsl/mrsl4.f90 Wdsint lines 55-56 (Kedxfw=false path): Widexp = E * Co2 * sqrt(E) where Co2 = 2·Deltae / (Sm2·Dist).

Combined: Widexp = 2·Deltae·E^(3/2) / (TOF_FACTOR·L).

Source

pub fn gaussian_width(&self, energy_ev: f64) -> f64

Gaussian resolution width W_g(E) in eV — the W of exp(-x²/W_g²).

Combines timing and flight-path contributions in quadrature: W_g² = (2·Δt/t × E)² + (2·ΔL/L × E)²

where t = TOF_FACTOR × L / √E is the time-of-flight in μs. Δt and ΔL are W-parameters too, so the convention carries through unchanged; the standard deviation is W_g/√2 and the FWHM is fwhm.

Source

pub fn fwhm(&self, energy_ev: f64) -> f64

FWHM of the resolution function at energy E, in eV.

FWHM = 2·√(ln 2)·W, the conversion for exp(-x²/W²). For the standard deviation instead, use gaussian_width(E)/√2.

Trait Implementations§

Source§

impl Clone for ResolutionParams

Source§

fn clone(&self) -> ResolutionParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResolutionParams

Source§

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

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

impl Copy for ResolutionParams

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more