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>
80 lines
3.5 KiB
C++
80 lines
3.5 KiB
C++
// SPDX-FileCopyrightText: 2025 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
#pragma once
|
|
|
|
#include <cstdint>
|
|
|
|
enum class IndexingAlgorithmEnum {FFBIDX, FFT, FFTW, Auto, None};
|
|
// Flex = "let the pipeline decide": try several per-image refinements and keep whichever indexes the
|
|
// most spots (CLI -r flex; the legacy -r multi name is still accepted as an alias).
|
|
enum class GeomRefinementAlgorithmEnum {None, OrientationOnly, BeamCenter, Flex};
|
|
|
|
class IndexingSettings {
|
|
IndexingAlgorithmEnum algorithm;
|
|
int64_t fft_num_vectors = 16*1024;
|
|
float fft_max_unit_cell_A = 500.0;
|
|
float fft_min_unit_cell_A = 10.0;
|
|
float fft_max_angle_deg = 150.0;
|
|
float fft_min_angle_deg = 30.0;
|
|
float fft_high_resolution_A = 2.0;
|
|
float indexing_tolerance = 0.1;
|
|
float max_angle_from_ewald_deg = 2.0;
|
|
float unit_cell_dist_tolerance_vs_reference = 0.05; // relative
|
|
static constexpr float unit_cell_angle_tolerance_deg = 5.0; // degree
|
|
int64_t indexing_threads = 4;
|
|
int64_t viable_cell_min_spots = 9;
|
|
|
|
int64_t max_extra_lattices = 2;
|
|
|
|
bool blocking_behavior = true;
|
|
bool index_ice_rings = false;
|
|
|
|
bool enable_rotation_indexing = false;
|
|
float rotation_indexing_min_angular_range_deg = 20.0;
|
|
float rotation_indexing_angular_stride_deg = 0.5;
|
|
|
|
GeomRefinementAlgorithmEnum refinement = GeomRefinementAlgorithmEnum::BeamCenter;
|
|
public:
|
|
IndexingSettings();
|
|
|
|
IndexingSettings& ViableCellMinSpots(int64_t input);
|
|
IndexingSettings& Algorithm(IndexingAlgorithmEnum input);
|
|
IndexingSettings& FFT_MaxUnitCell_A(float input);
|
|
IndexingSettings& FFT_MinUnitCell_A(float input);
|
|
IndexingSettings& FFT_MaxAngle_deg(float input);
|
|
IndexingSettings& FFT_MinAngle_deg(float input);
|
|
IndexingSettings& FFT_NumVectors(int64_t input);
|
|
IndexingSettings& FFT_HighResolution_A(float input);
|
|
IndexingSettings& Tolerance(float input);
|
|
IndexingSettings& IndexingThreads(int64_t input);
|
|
IndexingSettings& UnitCellDistTolerance(float input);
|
|
IndexingSettings& GeomRefinementAlgorithm(GeomRefinementAlgorithmEnum input);
|
|
IndexingSettings& IndexIceRings(bool input);
|
|
IndexingSettings& RotationIndexing(bool input);
|
|
IndexingSettings& RotationIndexingMinAngularRange_deg(float input);
|
|
IndexingSettings& RotationIndexingAngularStride_deg(float input);
|
|
IndexingSettings& BlockingBehavior(bool input);
|
|
IndexingSettings& MaxExtraLattices(int64_t input);
|
|
|
|
[[nodiscard]] int64_t GetViableCellMinSpots() const;
|
|
[[nodiscard]] IndexingAlgorithmEnum GetAlgorithm() const;
|
|
[[nodiscard]] GeomRefinementAlgorithmEnum GetGeomRefinementAlgorithm() const;
|
|
[[nodiscard]] float GetFFT_MaxUnitCell_A() const;
|
|
[[nodiscard]] float GetFFT_MinUnitCell_A() const;
|
|
[[nodiscard]] int64_t GetFFT_NumVectors() const;
|
|
[[nodiscard]] float GetFFT_HighResolution_A() const;
|
|
[[nodiscard]] float GetTolerance() const;
|
|
[[nodiscard]] float GetFFT_MinAngle_deg() const;
|
|
[[nodiscard]] float GetFFT_MaxAngle_deg() const;
|
|
[[nodiscard]] int64_t GetIndexingThreads() const;
|
|
[[nodiscard]] float GetUnitCellDistTolerance() const;
|
|
[[nodiscard]] float GetUnitCellAngleTolerance_deg() const;
|
|
[[nodiscard]] bool GetIndexIceRings() const;
|
|
[[nodiscard]] bool GetRotationIndexing() const;
|
|
[[nodiscard]] float GetRotationIndexingMinAngularRange_deg() const;
|
|
[[nodiscard]] float GetRotationIndexingAngularStride_deg() const;
|
|
[[nodiscard]] bool GetBlockingBehavior() const;
|
|
[[nodiscard]] int64_t GetMaxExtraLattices() const;
|
|
};
|