Files
Jungfraujoch/reader/JFJochReaderImage.h
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

88 lines
3.1 KiB
C++

// SPDX-FileCopyrightText: 2025 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#pragma once
#include <vector>
#include <unordered_set>
#include <map>
#include <mutex>
#include <optional>
#include "../common/TopPixels.h"
#include "JFJochReaderDataset.h"
#include "../common/CrystalLattice.h"
#include "../common/Histogram.h"
// Markers stored in place of an intensity. They occupy the bottom of the int32 range and
// INT32_MAX at the top, so anything in between is a real count. Add a marker at the BOTTOM and move
// MIN_REAL_PXL_VALUE with it - several places classify a pixel by range rather than by equality,
// and they all test against MIN_REAL_PXL_VALUE.
constexpr static int32_t ERROR_PXL_VALUE = INT32_MIN;
constexpr static int32_t GAP_PXL_VALUE = INT32_MIN + 1;
constexpr static int32_t BEAM_STOP_PXL_VALUE = INT32_MIN + 2;
constexpr static int32_t MIN_REAL_PXL_VALUE = INT32_MIN + 3;
constexpr static int32_t SATURATED_PXL_VALUE = INT32_MAX;
struct JFJochReaderRawImage {
std::vector<uint8_t> image_buffer;
CompressedImage image;
};
class JFJochReaderImage {
std::shared_ptr<const JFJochReaderDataset> dataset;
std::vector<int32_t> image; // Image in the reader must be 32-bit signed, uncompressed
DataMessage message;
std::unordered_set<int64_t> saturated_pixel;
std::unordered_set<int64_t> error_pixel;
std::vector<std::pair<int32_t, int32_t>> valid_pixel;
// Fast stats without storing/sorting all valid pixels
int32_t valid_min = 0;
int32_t valid_max = 0;
size_t valid_count = 0;
bool has_valid = false;
// For overlay: track top pixels with a tiny O(K) structure; export to vector for UI
TopPixels top_pixels_acc{20};
std::vector<std::pair<int32_t, int32_t>> top_pixels;
// This histogram operates in square root of count from 0 to 10^20
Histogram count_histogram{100000};
constexpr static float auto_foreground_range = 99.0f;
int32_t auto_foreground;
void CalcAutoContrast();
template <class T>
void ProcessInputImage(const void* image, size_t npixel, int64_t sat_value, int64_t special_value);
void ProcessInputImage(const CompressedImage& image);
public:
JFJochReaderImage(const DataMessage &msg, const std::shared_ptr<const JFJochReaderDataset> &dataset);
JFJochReaderImage(const JFJochReaderImage &other);
const DataMessage &ImageData() const;
DataMessage &ImageData();
const std::vector<int32_t> &Image() const;
const std::unordered_set<int64_t> &SaturatedPixels() const;
const std::unordered_set<int64_t> &ErrorPixels() const;
const JFJochReaderDataset &Dataset() const;
std::optional<std::pair<int32_t, int32_t>> ValidMinMax() const;
const std::vector<std::pair<int32_t, int32_t>> &GetTopPixels() const;
void AddImage(const JFJochReaderImage& other);
std::vector<float> GetAzInt1D() const;
std::vector<float> GetAzInt1D_BinToQ() const;
std::shared_ptr<JFJochReaderDataset> CreateMutableDataset();
int32_t GetAutoContrastValue() const;
std::vector<float> GetHistogram() const;
};