Struct IkedaCarpenterParams 

pub struct IkedaCarpenterParams {
    pub alpha: EnergyLaw,
    pub beta: EnergyLaw,
    pub r: EnergyLaw,
    pub burst_sigma_us: Option<f64>,
    pub channel_fwhm_us: Option<f64>,
    pub detector_tail: Option<DetectorTail>,
}

Parameters of the Ikeda–Carpenter resolution model.

Fields

alpha: EnergyLaw

Fast (slowing-down) rate α(E), 1/µs. Must evaluate to at least 1e-9.

beta: EnergyLaw

Slow (storage) rate β(E), 1/µs. Must evaluate to at least 1e-9.

r: EnergyLaw

Storage mixing fraction R(E), 0 ≤ R ≤ 1.

burst_sigma_us: Option<f64>

Optional proton-burst Gaussian standard deviation (µs); refused in detector time.

channel_fwhm_us: Option<f64>

Optional chopper/channel triangle FWHM (µs).

detector_tail: Option<DetectorTail>

Optional detector tail; detector time only, refused by the kernel table.

Implementations

impl IkedaCarpenterParams

pub fn constant(alpha: f64, beta: f64, r: f64) -> Self

A pure-moderator parameter set (no burst, no channel) with constant rates — the simplest case, useful for fixed-parameter or unit-test use.

pub fn delays_us( &self, energy_ev: f64, ) -> Result<(f64, f64), ResolutionParseError>

The first and last delay, in µs after the nominal arrival, of a neutron of energy_ev, outside which IkedaCarpenter::detector_bin_probabilities gives it less than NEGLIGIBLE_ARRIVAL_PROBABILITY chance of arriving: the triangle’s half-base before 0, and that half-base after the delay where the chance of a later record without the triangle falls to that chance.

Errors

ResolutionParseError::InvalidFormat when energy_ev is not positive and finite, a law is singular or out of range there, the pulse has a Gaussian burst, or its detector tail is out of range.

pub fn bin_probabilities_at( &self, true_energy_ev: f64, arrival_us: f64, detector_time_edges_us: &[f64], ) -> Result<Vec<f64>, ResolutionParseError>

Probability that a neutron of true_energy_ev whose nominal arrival, before the pulse’s delay, is arrival_us is recorded in each bin of detector_time_edges_us; as IkedaCarpenter::detector_bin_probabilities.

Errors

As IkedaCarpenter::detector_bin_probabilities, with arrival_us finite.

pub fn bin_arrival_slopes_at( &self, true_energy_ev: f64, arrival_us: f64, detector_time_edges_us: &[f64], ) -> Result<Vec<f64>, ResolutionParseError>

The derivative of each of Self::bin_probabilities_at with respect to arrival_us, per µs: the pulse density, folded with the triangle, at the bin’s lower edge minus that at its upper edge.

Errors

As Self::bin_probabilities_at.

pub fn bin_pulse_slopes_at( &self, true_energy_ev: f64, arrival_us: f64, detector_time_edges_us: &[f64], ) -> Result<[Vec<f64>; 4], ResolutionParseError>

The derivatives of each of Self::bin_probabilities_at with respect to α, β, R and the square of the triangle’s FWHM h, each evaluated at true_energy_ev: [∂P/∂α, ∂P/∂β, ∂P/∂R, ∂P/∂h²], one value per bin. The probabilities are even in h and smooth in h², so ∂P/∂h² is finite and generally not 0 at h = 0.

Errors

As Self::bin_probabilities_at.

pub fn bin_tail_slopes_at( &self, true_energy_ev: f64, arrival_us: f64, detector_time_edges_us: &[f64], ) -> Result<[Vec<f64>; 2], ResolutionParseError>

The derivatives of each of Self::bin_probabilities_at with respect to the detector tail’s f and τ_D, each per its unit: [∂P/∂f, ∂P/∂τ_D], one value per bin.

Errors

As Self::bin_probabilities_at, and ResolutionParseError::InvalidFormat for a pulse without a detector tail.

Trait Implementations

impl Clone for IkedaCarpenterParams

fn clone(&self) -> IkedaCarpenterParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IkedaCarpenterParams

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

Formats the value using the given formatter.

impl PartialEq for IkedaCarpenterParams

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IkedaCarpenterParams