TransmissionKLBackgroundModel

Struct TransmissionKLBackgroundModel 

Source
pub struct TransmissionKLBackgroundModel<'a> {
    pub inner: &'a dyn FitModel,
    pub inv_sqrt_energies: Vec<f64>,
    pub b0_index: usize,
    pub b1_index: usize,
    pub n_params: usize,
}
Expand description

KL-compatible background model for transmission data.

Given a transmission model T_inner(θ), predicts:

T_out(E) = T_inner(E) + b₀ + b₁/√E

where b₀ and b₁ are the additive background parameters at indices b0_index and b1_index in the parameter vector.

Unlike NormalizedTransmissionModel (which uses Anorm * T + BackA + BackB/√E + BackC√E with 4 free parameters), this model:

  • Has only 2 background parameters (b₀, b₁), reducing overfitting risk
  • Constrains b₀, b₁ ≥ 0 via parameter bounds (physical: background adds counts, never subtracts), ensuring T_out > 0 for valid Poisson NLL
  • Does NOT multiply T_inner by a normalization factor — normalization is handled separately (nuisance estimation for counts, or pre-processing for transmission data)

§Gradient

  • ∂T_out/∂nₖ = ∂T_inner/∂nₖ = -σₖ(E)·T_inner(E) (same as bare model)
  • ∂T_out/∂b₀ = 1
  • ∂T_out/∂b₁ = 1/√E

Fields§

§inner: &'a dyn FitModel

Underlying transmission model (density parameters only).

§inv_sqrt_energies: Vec<f64>

Precomputed 1/√E for each energy bin.

§b0_index: usize

Index of b₀ (constant background) in the parameter vector.

§b1_index: usize

Index of b₁ (1/√E background) in the parameter vector.

§n_params: usize

Total parameter count in the wrapped model.

Trait Implementations§

Source§

impl<'a> FitModel for TransmissionKLBackgroundModel<'a>

Source§

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

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

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

Optionally provide an analytical Jacobian. Read more
Source§

impl<'a> ForwardModel for TransmissionKLBackgroundModel<'a>

Source§

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

Predict model output for the given parameter vector. 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).
Source§

fn jacobian( &self, _params: &[f64], _free_param_indices: &[usize], _y_current: &[f64], ) -> Option<Vec<Vec<f64>>>

Analytical Jacobian (column-major layout). Read more

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