Files
Jungfraujoch/common/ScalingSettings.cpp
T
leonarski_fandClaude Opus 5 f2b92e3f4d
Build Packages / build:viewer-tgz:cpu (push) Successful in 8m30s
Build Packages / build:viewer-tgz:cuda (push) Successful in 9m3s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 13m52s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 14m4s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 14m23s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 14m27s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 14m59s
Build Packages / build:rpm (rocky8) (push) Successful in 11m45s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 12m59s
Build Packages / XDS test (durin plugin) (push) Successful in 7m14s
Build Packages / Generate python client (push) Successful in 29s
Build Packages / Build documentation (push) Successful in 1m7s
Build Packages / Create release (push) Skipped
Build Packages / build:rpm (rocky9) (push) Successful in 13m21s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 13m3s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 13m38s
Build Packages / DIALS test (push) Successful in 14m4s
Build Packages / XDS test (neggia plugin) (push) Successful in 8m4s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 8m49s
Build Packages / Unit tests (push) Successful in 1h1m28s
Build Packages / build:windows:nocuda (push) Canceled after 0s
Build Packages / build:windows:cuda (push) Canceled after 0s
rugnux: --search-min-zeta drops badly-measured observations from the symmetry search
zeta is the sine of the angle between a reflection's rocking path and the
spindle. Near 0 the reflection crosses the Ewald sphere almost tangentially,
spends many frames in diffracting position and is measured worst. The de-novo
space-group search asks how EQUAL an operator's paired intensities are, so its
answer is dominated by whichever reflections are measured worst - and when the
spindle lies in a lattice plane, an operator that permutes the two in-plane
axes samples a different mixture of measurement qualities than one that only
flips signs. That is not a fair comparison, and it can make a real symmetry
operator look like a twin law.

Measured on a thaumatin set mounted that way (its 4-fold is 88.9 deg from the
spindle), the added operators' disagreement is 1.74x the parent's over pairs
where both reflections have zeta < 0.85 and 1.003x - i.e. the symmetry is
exact - over pairs where both are above it. The search consequently refuses the
422 promotion and merges the crystal in P222, while the same data forced to the
right group give CC1/2 99.2% at multiplicity 10.7, matching XDS.

With the option the de-novo pass ignores those observations (the final merge
keeps everything - there completeness is the point):

  zeta cut   observations ignored   H ratio   adopted
  0 (off)                       -      1.47   P222
  0.5                     1620648      1.44   P222
  0.7                     3006013      1.34   P21212
  0.85                    4536724   promoted  P4212   (correct point group)

OFF BY DEFAULT, and it must stay off, because the same cut costs four other
crystals their space group (P41212 -> P212121, I23 -> P2, I23 -> I222 twice):
at 0.85 it discards 40-80% of all observations, which on a crystal whose
geometry is not the problem simply starves the search. Two independent
implementations - filtering the pairs that enter the statistic, and filtering
the observations that enter the merge - trade exactly the same crystals, so
this is a property of the cut and not of where it is applied. Verified
bit-identical to the previous binary when off.

The companion diagnostic is already there: the run now reports how close a
symmetry axis lies to the spindle, which is the geometry that makes this
option worth reaching for.

Implementation note for anyone tempted by the cheaper route: excluding these
observations from the ASU grouping alone does NOT work. The 3D combine selects
partials on corr, not on their group, so their intensity still reaches the
fulls and the merged intensities are unchanged - measured, the statistic did
not move by 0.03 while 67% of observations were nominally excluded. Zeroing
corr is what removes an observation from the combine, the merge and the error
model alike.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-28 20:03:43 +02:00

282 lines
8.2 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;
}
double ScalingSettings::GetSearchMinZeta() const {
return search_min_zeta;
}
ScalingSettings &ScalingSettings::SearchMinZeta(double input) {
if (input < 0.0 || input >= 1.0)
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"Search zeta limit must be in [0,1)");
search_min_zeta = input;
return *this;
}
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;
}