jfjoch_process: optional absorption surface for rot3d scaling (--absorption)
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 13m18s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 14m31s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 14m57s
Build Packages / build:rpm (rocky8) (push) Successful in 14m6s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 15m15s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 15m23s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 15m34s
Build Packages / XDS test (neggia plugin) (push) Successful in 8m55s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 9m17s
Build Packages / XDS test (durin plugin) (push) Successful in 9m25s
Build Packages / Create release (push) Skipped
Build Packages / Generate python client (push) Successful in 28s
Build Packages / Build documentation (push) Successful in 57s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 11m31s
Build Packages / build:rpm (rocky9) (push) Successful in 12m45s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 11m44s
Build Packages / DIALS test (push) Successful in 13m3s
Build Packages / Unit tests (push) Successful in 58m30s
Build Packages / build:windows:cuda (push) Successful in 20m21s
Build Packages / build:windows:nocuda (push) Successful in 10m30s

Adds an opt-in smooth absorption correction for rotation scaling. After the
rot3d fulls are scaled, --absorption[=num] fits a multiplicative surface
A(s1_crystal) - a degree<=4 monomial basis (real spherical harmonics up to l=4,
as XDS/DIALS) of the diffracted-beam direction in the crystal/goniometer frame,
by ridge-regularized log-linear least-squares of I_scaled/I_ref weighted by
(I/sigma)^2, over num iterations (default 3); the surface divides image_scale_corr
and the fulls are re-merged.

Off by default and a no-op without rot3d. On the test panel (~13 keV, thin
crystals) it is metric-neutral - fitted rms(log A) ~3-4%, ISa/CC1/2 unchanged -
because absorption is negligible there and the per-frame scale G(phi) already
absorbs the angular part. It is kept as a lever for low-energy data (e.g. 6 keV)
where absorption becomes significant. Stored as ScalingSettings::absorption_iter.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-06-30 15:23:01 +02:00
co-authored by Claude Opus 4.8
parent 77f1ed2566
commit e45a1577d6
4 changed files with 115 additions and 1 deletions
+87
View File
@@ -32,7 +32,11 @@
#include "../image_analysis/scale_merge/SearchSpaceGroup.h"
#include "../image_analysis/scale_merge/TwinningAnalysis.h"
#include "../image_analysis/scale_merge/Combine3D.h"
#include "../image_analysis/scale_merge/HKLKey.h"
#include "../image_analysis/WriteReflections.h"
#include <array>
#include <map>
#include <Eigen/Dense>
namespace {
// Pick up to requested_images ordinals spread evenly across [0, images_to_process) for the
@@ -79,6 +83,85 @@ namespace {
logger.Info("Scaled fulls (XDS order, Unity model)");
}
// Absorption surface. A smooth multiplicative correction A(s1_crystal) shared across the sweep,
// fit by ridge-regularized log-linear least-squares of I_scaled/I_ref against a degree<=4
// monomial basis of the diffracted-beam direction in the crystal (goniometer) frame - the same
// function space as real spherical harmonics up to l=4, as XDS/DIALS use. Applied by dividing
// image_scale_corr by A, then re-merged. Negligible at hard X-rays / thin crystals but matters
// at low energy (e.g. 6 keV).
void AbsorptionSurface(const DiffractionExperiment &exp,
std::vector<IntegrationOutcome> &fulls, int n_iter, Logger &logger) {
const auto gon_opt = exp.GetGoniometer();
if (!gon_opt) { logger.Warning("Absorption: no goniometer, skipping"); return; }
const auto &gon = *gon_opt;
const Coord axis = gon.GetAxis().Normalize();
const DiffractionGeometry geom = exp.GetDiffractionGeometry();
const HKLKeyGenerator keygen(exp.GetScalingSettings().GetMergeFriedel(),
exp.GetSpaceGroupNumber().value_or(1));
constexpr int MAXDEG = 4;
constexpr int NB = (MAXDEG + 1) * (MAXDEG + 2) * (MAXDEG + 3) / 6; // # monomials of degree 0..4
auto basis = [&](const Coord &s, std::array<double, NB> &b) {
int n = 0;
for (int deg = 0; deg <= MAXDEG; ++deg)
for (int i = deg; i >= 0; --i)
for (int j = deg - i; j >= 0; --j) {
const int kk = deg - i - j;
double v = 1.0;
for (int a = 0; a < i; ++a) v *= s.x;
for (int a = 0; a < j; ++a) v *= s.y;
for (int a = 0; a < kk; ++a) v *= s.z;
b[n++] = v;
}
};
auto s1_crystal = [&](const Reflection &r) {
const Coord s1lab = geom.LabCoord(r.predicted_x, r.predicted_y).Normalize();
const double phi = gon.GetAngle_deg(r.image_number) * 3.14159265358979323846 / 180.0;
return RotMatrix(static_cast<float>(-phi), axis) * s1lab;
};
for (int iter = 0; iter < n_iter; ++iter) {
const auto ref = MergeAll(exp, fulls, false);
std::map<HKLKey, float> refI;
for (const auto &m : ref) refI[keygen(m)] = m.I;
Eigen::MatrixXd AtA = Eigen::MatrixXd::Zero(NB, NB);
Eigen::VectorXd Atb = Eigen::VectorXd::Zero(NB);
std::array<double, NB> b{};
for (const auto &oc : fulls)
for (const auto &r : oc.reflections) {
if (!r.observed || !std::isfinite(r.image_scale_corr) || r.image_scale_corr <= 0.0f) continue;
const double Iscaled = static_cast<double>(r.I) * r.image_scale_corr;
const double sig = static_cast<double>(r.sigma) * r.image_scale_corr;
if (!(Iscaled > 0.0) || !(sig > 0.0)) continue;
const auto it = refI.find(keygen(r));
if (it == refI.end() || !(it->second > 0.0f)) continue;
basis(s1_crystal(r), b);
const double y = std::log(Iscaled / it->second);
const double w = std::min(100.0, (Iscaled / sig) * (Iscaled / sig)); // strong reflections define the surface
for (int a = 0; a < NB; ++a) {
Atb(a) += w * b[a] * y;
for (int c = 0; c < NB; ++c) AtA(a, c) += w * b[a] * b[c];
}
}
const double lambda = 1e-2 * AtA.diagonal().mean(); // ridge: x^2+y^2+z^2=1 makes the basis rank-deficient
for (int a = 0; a < NB; ++a) AtA(a, a) += lambda;
const Eigen::VectorXd c = AtA.ldlt().solve(Atb);
double sumsq = 0.0; size_t n_app = 0;
for (auto &oc : fulls)
for (auto &r : oc.reflections) {
if (!std::isfinite(r.image_scale_corr) || r.image_scale_corr <= 0.0f) continue;
basis(s1_crystal(r), b);
double surf = 0.0;
for (int a = 0; a < NB; ++a) surf += c(a) * b[a];
r.image_scale_corr = static_cast<float>(r.image_scale_corr / std::exp(surf));
sumsq += surf * surf; ++n_app;
}
logger.Info("Absorption surface iter {}/{}: {} fulls, rms(log A)={:.3f}",
iter + 1, n_iter, n_app, std::sqrt(sumsq / std::max<size_t>(n_app, 1)));
}
}
// Smooth the per-frame scale G across frames before the rot3d combine. ScaleOnTheFly fits each
// frame's G independently, so the few partials of one rocking event get inconsistent scales when
// weight-summed; a centered moving average of log(G) over a small odd frame window removes that
@@ -489,6 +572,10 @@ ProcessResult JFJochProcess::Run(JFJochProcessObserver *observer) {
phase("Scaling fulls (XDS order)");
ScaleFulls(experiment_, combined, static_cast<int>(config_.scaling_iter), config_.nthreads, logger);
}
if (rot3d && experiment_.GetScalingSettings().GetAbsorptionIter() > 0) {
phase("Absorption surface");
AbsorptionSurface(experiment_, combined, experiment_.GetScalingSettings().GetAbsorptionIter(), logger);
}
const std::vector<IntegrationOutcome> &merge_input =
rot3d ? combined : indexer->GetIntegrationOutcome();