Skip to main content

TransmissionFitModel

Struct TransmissionFitModel 

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

Forward model for fitting isotopic areal densities from transmission data.

The model computes T(E) for a set of isotopes with variable areal densities. Each isotope’s resonance data and the energy grid are fixed; only the areal densities are adjusted during fitting.

Optionally, the sample temperature can also be fitted by setting temperature_index to the parameter slot holding the temperature value. When temperature_index is Some(idx), the Doppler broadening kernel is recomputed at params[idx] when the temperature changes (cached across calls at the same temperature), and the analytical Jacobian provides density columns directly plus a single FD column for temperature.

instrument uses Arc so that parallel pixel loops can share one copy of a potentially large tabulated resolution kernel via cheap reference-count increments instead of deep-cloning per pixel.

Implementations§

Source§

impl TransmissionFitModel

Source

pub fn new( energies: Vec<f64>, resonance_data: Vec<ResonanceData>, temperature_k: f64, instrument: Option<Arc<InstrumentParams>>, density_mapping: (Vec<usize>, Vec<f64>), temperature_index: Option<usize>, external_base_xs: Option<Arc<Vec<Vec<f64>>>>, ) -> Result<Self, FittingError>

Create a validated TransmissionFitModel.

When external_base_xs is Some, uses those precomputed unbroadened cross-sections instead of computing them (expensive Reich-Moore). spatial_map precomputes once for all pixels and passes them here.

§Errors

Returns FittingError::InvalidConfig if temperature_index overlaps with density_indices, or if external_base_xs has a mismatched shape.

Trait Implementations§

Source§

impl FitModel for TransmissionFitModel

Source§

fn analytical_jacobian( &self, params: &[f64], free_param_indices: &[usize], y_current: &[f64], ) -> Option<FlatMatrix>

Analytical Jacobian for the transmission model with temperature fitting.

When base_xs is available (temperature fitting path):

  • Density columns: ∂T/∂nᵢ = -σᵢ(E)·T(E) using cached broadened XS from the most recent evaluate() call. Same formula as PrecomputedTransmissionModel, zero extra broadening calls.
  • Temperature column: analytical chain rule via on-demand ∂σ/∂T. ∂T/∂T_temp = -T(E) · Σᵢ nᵢ·rᵢ·∂σᵢ/∂T. The derivative is computed once per temperature via broadened_cross_sections_with_analytical_derivative_from_base() and cached until temperature changes. Costs one broadening call per Jacobian (same as the old FD approach, but exact).

Returns None for the no-base_xs path (full forward model), which falls back to finite-difference in the LM solver. Analytical Jacobian for density and temperature fitting.

Without resolution: ∂T/∂N_g = -(Σ_{i∈g} rᵢ σᵢ) · T ∂T/∂Temp = -T · Σᵢ nᵢ rᵢ ∂σᵢ/∂T

With resolution (R is a linear operator): ∂T_obs/∂N_g = R[-(Σ_{i∈g} rᵢ σᵢ) · T] ∂T_obs/∂Temp = R[-T · Σᵢ nᵢ rᵢ ∂σᵢ/∂T]

Returns None only when base_xs is not available (full forward model path falls back to FD) or when the temperature cache is stale.

Source§

fn evaluate(&self, params: &[f64]) -> Result<Vec<f64>, FittingError>

Evaluate the model for the given parameters. Read more
Source§

impl ForwardModel for TransmissionFitModel

Source§

fn predict(&self, params: &[f64]) -> Result<Vec<f64>, FittingError>

Predict model output for the given parameter vector. Read more
Source§

fn jacobian( &self, params: &[f64], free_param_indices: &[usize], y_current: &[f64], ) -> Option<Vec<Vec<f64>>>

Analytical Jacobian (column-major layout). Read more
Source§

fn n_data(&self) -> usize

Number of data points in the model output.
Source§

fn n_params(&self) -> usize

Number of parameters (total, including fixed).

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> 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, 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