goldsluice.reference

The Python mirror of every algorithm: one module per algorithm, listed in ALL.

A module defines NAME, OUTPUTS (a transform that returns a trace sets KIND = "trace" and OUTPUTS = ("trace",), and its kernel returns a list of floats; an optional ATOL is the absolute tolerance of the parity test), problem(n_samples, **params), kernel(trace, **params) (one trace as a plain list of floats, a tuple of numbers back), cases() (the standard inputs of the parity test), bad_cases() (inputs both versions must refuse) and either goldpan_expected(traces, params) (the same numbers from goldpan’s own functions) or NO_GOLDPAN, a string that says why goldpan has none. The Rust function of the same NAME and keyword arguments lives in src/; PORTING.md explains how to port one to the other.

Modules

baseline	Python mirror of src/baseline.rs: the mean and the standard deviation of the pretrigger window of a trace.
excursion	Python mirror of src/excursion.rs: how far a trace strays from its baseline after the pretrigger window, and relative to its noise.
integral	Python mirror of src/integral.rs: the integral of the baseline-subtracted trace over the whole trace.
lowpass	Python mirror of src/lowpass.rs: a zero-phase Butterworth low-pass filter of a trace (a transform: it returns a trace).
max_time	Python mirror of src/max_time.rs: the time of the largest sample of each trace, from the start of the trace (s).
peak	Python mirror of src/peak.rs: the largest ADC value and the largest current above the pretrigger baseline of a trace.
rise_crossing	Python mirror of src/rise_crossing.rs: the time at which the rising edge of the largest pulse of a trace crosses fraction of its height (s).
rise_time	Python mirror of src/rise_time.rs: the 10-90 % rise time of the largest pulse of a trace (s), as goldpan.algorithms.rise_time.
subtract_line	Python mirror of src/subtract_line.rs: a trace minus the straight line fitted to its pretrigger samples (a transform: it returns a trace).
window_integral	Python mirror of src/window_integral.rs: the integral of the baseline-subtracted trace between two samples.