Struct FlightTimeGrid 

pub struct FlightTimeGrid { /* private fields */ }

Uniform flight-time grid over a window, with the probability that each grid point’s neutrons are counted in each bin.

Implementations

impl FlightTimeGrid

pub fn new( time_edges_us: &[f64], t0_us: f64, flight_path_m: f64, pulse: &DetectorPulse, ) -> Result<Self, FlightTimeGridError>

The grid for bins time_edges_us (µs) with timing offset t0_us, flight path flight_path_m and pulse. The step, half the pulse’s shorter rise at the two ends of the flight times whose neutrons can reach the bins, is a starting step: the counts are converged once Self::halved no longer changes them. The grid extends one step beyond those flight times at each end. For a storage fraction that rises with energy, the latest arrival that sets the earliest flight time takes the fraction at its largest over the energy span.

Errors

See FlightTimeGridError.

pub fn spanning( time_edges_us: &[f64], (t0_us, last_t0_us): (f64, f64), flight_path_m: f64, pulse: &DetectorPulse, ) -> Result<Self, FlightTimeGridError>

The grid of Self::new for every timing offset from t0_us to last_t0_us: its flight times are those whose neutrons can reach the bins at either, and Self::rows are at t0_us.

Errors

See FlightTimeGridError.

pub fn covers( &self, t0_us: f64, flight_path_m: f64, params: &IkedaCarpenterParams, ) -> Result<bool, FlightTimeGridError>

Whether the grid’s points, arriving as Self::rows_at places them, cover every flight time whose neutrons can reach the bins when the timing offset is t0_us, the flight path flight_path_m and the pulse’s laws params.

Errors

As Self::new for that timing offset, flight path and pulse.

impl FlightTimeGrid

pub fn halved(&self) -> Result<Self, FlightTimeGridError>

The same window at half the step.

Errors

As Self::new, when the halved grid exceeds MAX_POINTS.

pub fn rows_at( &self, t0_us: f64, flight_path_m: f64, params: &IkedaCarpenterParams, ) -> Result<Rows, FlightTimeGridError>

The probability that each grid point’s neutrons are counted in each bin when the timing offset is t0_us, the flight path flight_path_m and the pulse’s laws params, with the step each point then stands for. Neutrons from flight times the grid does not cover there are not counted.

Errors

FlightTimeGridError::InvalidTimingOffset or FlightTimeGridError::InvalidFlightPath unless t0_us is finite and flight_path_m finite and positive; FlightTimeGridError::Pulse if the pulse cannot be evaluated there.

pub fn arrival_slopes_at( &self, t0_us: f64, flight_path_m: f64, params: &IkedaCarpenterParams, ) -> Result<Rows, FlightTimeGridError>

The derivative of Self::rows_at’s probabilities with respect to each point’s arrival time, per µs, with the same step.

Errors

As Self::rows_at.

pub fn pulse_slopes_at( &self, t0_us: f64, flight_path_m: f64, params: &IkedaCarpenterParams, ) -> Result<[Rows; 4], FlightTimeGridError>

The derivatives of Self::rows_at’s probabilities with respect to α, β, R and the square of the triangle’s FWHM, each at its point’s energy, with the same step: IkedaCarpenterParams::bin_pulse_slopes_at for every point.

Errors

As Self::rows_at.

pub fn tail_slopes_at( &self, t0_us: f64, flight_path_m: f64, params: &IkedaCarpenterParams, ) -> Result<[Rows; 2], FlightTimeGridError>

The derivatives of Self::rows_at’s probabilities with respect to the detector tail’s f and τ_D, with the same step: IkedaCarpenterParams::bin_tail_slopes_at for every point.

Errors

As Self::rows_at, and FlightTimeGridError::Pulse for a pulse without a detector tail.

pub fn rows(&self) -> &Rows

The probabilities at the grid’s own timing offset, flight path and pulse.

pub fn pulse(&self) -> &DetectorPulse

The pulse the grid was built at.

pub fn t0_us(&self) -> f64

The timing offset in µs the grid was built at.

pub fn flight_path_m(&self) -> f64

The flight path in m the grid was built at.

pub fn range_us(&self) -> (f64, f64)

(u_lo, u_hi), the flight-time range in µs at the timing offset and flight path the grid was built at.

pub fn step_us(&self) -> f64

The grid step in µs at the flight path the grid was built at.

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

The grid’s flight times in µs, ascending.

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

The time-bin edges in µs, ascending.

pub fn energies_ev(&self) -> Vec<f64>

The energy, in eV, of each grid point, descending.

pub fn predict(&self, values: &[f64]) -> Result<Vec<f64>, FlightTimeGridError>

step · Σ_j v_j P_k(u_j) for each bin k: the counts a beam of values[j] neutrons per µs at each grid point predicts, or, for any other per-point values, the same linear map. It differs from the trapezoid rule by half a step of the end points’ terms, where P_k is zero, or at most NEGLIGIBLE_ARRIVAL_PROBABILITY at the fast end for an unfolded pulse. Features of the values narrower than the step are not resolved.

Errors

FlightTimeGridError::ValuesLength unless values has one entry per grid point.

Trait Implementations

impl Clone for FlightTimeGrid

fn clone(&self) -> FlightTimeGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlightTimeGrid

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

Formats the value using the given formatter.