One changeset, developed together in response to a review of this branch, so the files carry several of the changes at once. Full test suite passes (733 cases). Spot finding - Split ImageSpotFinder into Detect() (flag strong pixels - the expensive per-pixel pass) and ExtractSpots() (CCL + min/max-pix + resolution mask), with Run() = both. The per-image min-pix escalation now detects ONCE and repeats only the cheap extraction, instead of re-running the whole finder four times per frame as it did on the default path. It also keeps the winning attempt's spot list rather than re-extracting it, so the frame that is integrated is exactly the frame that was scored - which a GPU re-extract could not guarantee (float atomic ordering). - spot_finding_time_s no longer swallows indexing time, and indexing_time_s now sums every escalation call instead of reporting only the last. Detection limits follow the detector - The azimuthal-integration upper q and the spot-finding high-resolution limit are now std::optional, in the C++ structs AND in the OpenAPI schema, and resolve to the detector's own maximum (DiffractionExperiment::GetDetectorMaxQ_ recipA). Adaptive detection reads a pixel's ring from the azimuthal bins, so a pixel outside that q range could never be strong - the integration range silently bounded what detection could see, regardless of the requested resolution limit. Regenerated the C++ and TypeScript clients; the viewer and the web frontend each gained a "to detector edge" switch. Detection defaults are now per workflow (measured, not assumed) - Stills: adaptive detection, min-pix chosen per image, no resolution clipping. - Rotation: fixed-threshold finder, min-pix 2, 1.5 A limit. On a 33-crystal rotation battery, adaptive detection helped four hard crystals but deterministically broke three (a lost space group, a halved indexing rate, a collapsed merge), and the detector-edge limit cost indexing on a strong rotation set (100.0 -> 96.8%). Each is still overridable by its flag, and --no-adaptive-spots is new. Indexer seed escalation - Stop escalating once a seed's lattice explains >= 90% of the seed spots. Previously any frame with >= 80 spots always paid three indexer calls, online broker included. Merge-consistency filter - --min-image-cc gated on a per-image CC computed BEFORE the stills partiality post-refinement and never refreshed; the refiner now recomputes it, so the reported CC describes the data that are actually merged. - Replaced the per-call cc_mask argument with one MergeOnTheFly flag, so the merge, the error model and MergeStats can no longer disagree about which images are in (the --scale path merged unfiltered while its statistics were filtered). Per-image B-factor refinement (-B) removed - Measured on four serial-stills datasets: it is a no-op where the per-image fit is well conditioned and actively harmful where it is not (CC1/2 -8.1, R_meas +23.2 on the weakest large-cell set, whose fits hit their [-50, 200] bounds on 14-25% of images). It had also been silently DISCARDED since the partiality post-refinement landed - reported but not applied. Rather than fix and keep a knob with no demonstrated benefit, the flag and the whole image_scale_b_factor chain are gone: setting, scaling fit, message field, CBOR, HDF5 write and read-back, per-image plot, OpenAPI enum, viewer column and checkbox, docs. ScaleOnTheFly no longer needs Ceres at all - the fit is a linear IRLS. (The Wilson per-image b_factor is a different quantity and stays.) Stills partiality width now fits both of its components - sigma^2 = gamma0^2 + (gamma_e*d*)^2 instead of a purely angular gamma_e*d* with gamma0 pinned to 0. Fitted per crystal by least squares of dist_ewald^2 on d*^2. The angular-only width is fitted over a d*^2-dense population, so it was pinned by the high-resolution edge and collapsed at low d*: median partiality 0.008 beyond 13 A for reflections that were plainly recorded, 55% of them under the merge's partiality floor, and the survivors divided by those values - which inflated the merged low-resolution intensity scale 3.6x (~ +9 A^2 of apparent B). Measured on 5000 stills: the ramp flattens to 0.89x, no observation is dropped any more (701750 -> 716811), shell-mean CC1/2 and R-free improve slightly. Note CC1/2, R_meas, completeness and a B-refining R-free are all blind to that ramp, which is why it survived earlier validation; the cost is high-resolution R_meas (98.5 -> 101.9 shell-averaged). Removed dead code from add-then-remove churn - Prediction-time "still partiality" (unreachable: no setter), the phantom IndexingSettings::min_indexed_spot_fraction knob (getter, no setter - now the constant it always was), StillsPartialityRefine's caller-less Settings constructor and its reference to a long-gone env var, ProcessImage's unread bool return, an unused include, and a dead viewer overlay hook. Also - Viewer: the magnifier compared a QImage with itself, so its scene rect was set once ever and it could not pan into a larger dataset; the hover tail timer could fire after leaveEvent and resurrect the resolution readout outside the image. - update_version.sh regenerated the frontend lock file BEFORE bumping the version (every release shipped an off-by-one lock), and did git rm/git add on a path that has not existed since the client moved to src/client - with no set -e, both failed silently. - fpga/pcie_driver/postinstall.sh tested "[ ! occurrences > 0 ]", which is a redirect, not a test, so dkms add never ran. - Unit tests for the adaptive-threshold host functions, which had none. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
270 lines
7.8 KiB
C++
270 lines
7.8 KiB
C++
// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
|
|
#include "ScalingSettings.h"
|
|
|
|
|
|
ScalingSettings& ScalingSettings::MergeFriedel(bool input) {
|
|
merge_friedel = input;
|
|
return *this;
|
|
}
|
|
|
|
ScalingSettings& ScalingSettings::HighResolutionLimit_A(double limit) {
|
|
if (limit <= 0.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterBelowMin, "High resolution limit must be positive");
|
|
high_resolution_limit_A = limit;
|
|
return *this;
|
|
}
|
|
|
|
ScalingSettings& ScalingSettings::HighResolutionLimit_A(std::optional<double> limit) {
|
|
if (limit.has_value() && limit.value() <= 0.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterBelowMin, "High resolution limit must be positive");
|
|
high_resolution_limit_A = limit;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetMergeFriedel() const {
|
|
return merge_friedel;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::RefineRotationWedge(bool input) {
|
|
refine_wedge = input;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetRefineWedge() const {
|
|
return refine_wedge;
|
|
}
|
|
|
|
std::optional<double> ScalingSettings::GetHighResolutionLimit_A() const {
|
|
return high_resolution_limit_A;
|
|
}
|
|
|
|
double ScalingSettings::GetMinMosaicity() const {
|
|
return 0.001;
|
|
}
|
|
|
|
double ScalingSettings::GetMaxMosaicity() const {
|
|
return 1.0;
|
|
}
|
|
|
|
double ScalingSettings::GetMinWedge() const {
|
|
return 0.001;
|
|
|
|
}
|
|
|
|
double ScalingSettings::GetMaxWedge() const {
|
|
return 10.0;
|
|
}
|
|
|
|
double ScalingSettings::GetDefaultMosaicity() const {
|
|
return 0.1;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::RotationWedgeForScaling(std::optional<double> input) {
|
|
if (input) {
|
|
// TODO: Use fmt
|
|
if (input.value() < GetMinWedge() || input.value() > GetMaxWedge())
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
|
|
"Wedge for scaling must be between " + std::to_string(GetMinWedge()) +
|
|
" and " + std::to_string(GetMaxWedge()));
|
|
}
|
|
wedge_for_scaling = input;
|
|
return *this;
|
|
}
|
|
|
|
std::optional<double> ScalingSettings::GetRotationWedgeForScaling() const {
|
|
return wedge_for_scaling;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::MinPartiality(double input) {
|
|
if (min_partiality < 0.0 || min_partiality > 1.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Min partiality must be between 0 and 1");
|
|
min_partiality = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetMinCCForImage() const {
|
|
return min_cc_for_image;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::MinCCForImage(double input) {
|
|
if (input < 0.0 || input > 1.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Min CC for image must be between 0 and 1");
|
|
min_cc_for_image = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetOutlierRejectNsigma() const {
|
|
return outlier_reject_nsigma;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::OutlierRejectNsigma(double input) {
|
|
outlier_reject_nsigma = input; // <= 0 disables; no upper bound (large = effectively off)
|
|
return *this;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ScaleFulls(bool input) {
|
|
scale_fulls = input;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetScaleFulls() const {
|
|
return scale_fulls;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::AbsorptionIter(int input) {
|
|
if (input < 0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Absorption iterations must be non-negative");
|
|
absorption_iter = input;
|
|
return *this;
|
|
}
|
|
|
|
int ScalingSettings::GetAbsorptionIter() const {
|
|
return absorption_iter;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::CorrectionSurfaces(bool input) {
|
|
correction_surfaces = input;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetCorrectionSurfaces() const {
|
|
return correction_surfaces;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::StillsPartialityRefine(bool input) {
|
|
stills_partiality_refine = input;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetStillsPartialityRefine() const {
|
|
return stills_partiality_refine;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ExpectedVarianceMerge(bool input) {
|
|
expected_variance_merge = input;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetExpectedVarianceMerge() const {
|
|
return expected_variance_merge;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::SmoothGDegrees(double input) {
|
|
if (input < 0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Smooth-G range must be non-negative");
|
|
smooth_g_deg = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetSmoothGDegrees() const {
|
|
return smooth_g_deg;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::RelativeBDegrees(double input) {
|
|
if (input < 0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Relative-B batch width must be non-negative");
|
|
relative_b_deg = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetRelativeBDegrees() const {
|
|
return relative_b_deg;
|
|
}
|
|
|
|
double ScalingSettings::GetMinPartiality() const {
|
|
return min_partiality;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ForcedMosaicity(std::optional<double> input) {
|
|
if (input.has_value() && (input.value() < GetMinMosaicity() || input.value() > GetMaxMosaicity()))
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
|
|
"Forced mosaicity must be between " + std::to_string(GetMinMosaicity()) +
|
|
" and " + std::to_string(GetMaxMosaicity()));
|
|
forced_mosaicity = input;
|
|
return *this;
|
|
}
|
|
|
|
std::optional<double> ScalingSettings::GetForcedMosaicity() const {
|
|
return forced_mosaicity;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::CaptureUncertaintyCoeff(double input) {
|
|
if (input < 0.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
|
|
"Capture uncertainty coefficient must be non-negative");
|
|
capture_uncertainty_coeff = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetCaptureUncertaintyCoeff() const {
|
|
return capture_uncertainty_coeff;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::MinCapturedFraction(double input) {
|
|
if (input < 0.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
|
|
"Minimum captured fraction must be non-negative");
|
|
min_captured_fraction = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetMinCapturedFraction() const {
|
|
return min_captured_fraction;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::RfreeFraction(double input) {
|
|
if (input < 0.0 || input > 1.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "R-free fraction must be between 0 and 1");
|
|
rfree_fraction = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetRfreeFraction() const {
|
|
return rfree_fraction;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ScalingRegularize(bool input) {
|
|
scaling_regularize = input;
|
|
return *this;
|
|
}
|
|
|
|
bool ScalingSettings::GetScalingRegularize() const {
|
|
return scaling_regularize;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ResolutionCutoff(ResolutionCutoffMethod input) {
|
|
resolution_cutoff = input;
|
|
return *this;
|
|
}
|
|
|
|
ResolutionCutoffMethod ScalingSettings::GetResolutionCutoff() const {
|
|
return resolution_cutoff;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ResolutionCCTarget(double input) {
|
|
if (input <= 0.0 || input >= 1.0)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
|
|
"Resolution CC target must be between 0 and 1");
|
|
resolution_cc_target = input;
|
|
return *this;
|
|
}
|
|
|
|
double ScalingSettings::GetResolutionCCTarget() const {
|
|
return resolution_cc_target;
|
|
}
|
|
|
|
ScalingSettings &ScalingSettings::ReportShellCount(int input) {
|
|
if (input < 1)
|
|
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
|
|
"Number of report shells must be at least 1");
|
|
report_shell_count = input;
|
|
return *this;
|
|
}
|
|
|
|
int ScalingSettings::GetReportShellCount() const {
|
|
return report_shell_count;
|
|
}
|