Files
Jungfraujoch/common/ScalingSettings.cpp
T
leonarski_fandClaude Opus 5 a29c36600f Beam-stop shadow detection, and a low-resolution limit for scaling
rugnux finds the beam stop and its holder in a projection of 60 images and
marks them in the pixel mask as bit 9 (--detect-beam-stop[=N|off], on by
default). Reflections behind the stop are attenuated but not flagged, so they
integrate low with a plausible sigma and nothing downstream catches them: the
signal-box gate requires 100% valid pixels and shadow pixels are valid, the
background clip is high-side only, and the |zeta| cut applies only to the
space-group search merge.

The detection compares each pixel's background against the typical background
at the same radius on two channels. An azimuthal one (the ring median) finds
the holder arm, which is a minority of its ring; a radial one (the background
just outside) finds the disk, which the ring median cannot see because inside a
fully blocked ring the median is the shadow itself. Pixels are pooled over a
5x5 box and tested only where the background has actually been counted, so
low-background data no longer masks the whole detector. Recorded reflections
are carved back out - a beam stop cannot block a reflection that was measured.

Bit 9 belongs to the run that found it, not to the dataset: it is cleared when
a run starts, so a mask read back from a file that carries one starts clear.
The user mask (bit 8) is left alone.

Scaling and merging gain a low-resolution limit, default 50 A
(--scaling-low-resolution <num>, 0 removes it), applied per observation before
scaling so it also protects the per-frame scale fit and the space-group search.
50 A is the value XDS configurations use; rugnux_vs_xds.py now matches both of
XDS's resolution limits instead of only the high one, so the lowest shell is
the same shell in the two programs.

The viewer draws the detected shadow in coral with a "Show beam stop" switch in
the side panel, exposes the low-resolution limit in the settings dock, and
offers detection in its processing jobs. Adding an image marker meant giving
the reader a MIN_REAL_PXL_VALUE, because several places classify a pixel by
range rather than by equality and would otherwise read the new marker as a very
negative intensity.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-09 01:05:31 +02:00

306 lines
9.1 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;
}
ScalingSettings& ScalingSettings::LowResolutionLimit_A(std::optional<double> limit) {
if (limit.has_value() && limit.value() <= 0.0)
throw JFJochException(JFJochExceptionCategory::InputParameterBelowMin, "Low resolution limit must be positive");
low_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;
}
std::optional<double> ScalingSettings::GetLowResolutionLimit_A() const {
return low_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;
}
float ScalingSettings::GetIceMinScore() const {
return ice_min_score;
}
float ScalingSettings::GetIceMinSpotRatio() const {
return ice_min_spot_ratio;
}
ScalingSettings &ScalingSettings::IceMinSpotRatio(float input) {
if (input < 0)
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Ice spot-ratio gate must be non-negative");
ice_min_spot_ratio = input;
return *this;
}
ScalingSettings &ScalingSettings::IceMinScore(float input) {
if (input < 0)
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Ice score gate must be non-negative");
ice_min_score = input;
return *this;
}
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::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;
}