Files
Jungfraujoch/reader/JFJochCBFReader.h
T
leonarski_fandClaude Opus 5 391736425f miniCBF: read the compressed file through a buffer the caller keeps
Slurp() returned a fresh std::vector per call, so every frame allocated the
whole compressed file - 18 MB on a 16 Mpx detector - and value-initialised it
before the read overwrote every byte. Measured on one such frame that is 9.2 ms
against 5.4 ms into a buffer that is already there.

ReadInto() now takes the scratch, and the raw image carries it, so a worker
reading a sweep reads every file into the same bytes. Slurp() fills a buffer
instead of returning one, which is also what makes the resize cost nothing when
the next file is the same size as the last.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-09 20:14:04 +02:00

56 lines
2.4 KiB
C++

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#pragma once
#include <string>
#include <vector>
#include "JFJochReader.h"
#include "MiniCBF.h"
// Reads a rotation sweep straight from a directory of PILATUS miniCBF files - the form most
// facilities still archive - with no conversion step and no libcbf.
//
// The sweep's geometry comes from the first file's header; the rotation angle of each image comes
// from its own header, which costs only the bytes up to the binary separator. Images are decoded on
// demand, one per call, so any number of workers can read at once - there is no global lock as there
// is on the HDF5 path, HDF5 not being thread-safe.
//
// A raw CBF carries no analysis results, so this reader has no spots, no reflections and no snapshots;
// the dataset it builds is the geometry, the mask and nothing else, exactly as a plain DECTRIS file
// with no /entry/MX would give.
class JFJochCBFReader : public JFJochReader {
std::vector<std::string> files_;
std::shared_ptr<JFJochReaderDataset> dataset_;
minicbf::Header header0_;
bool LoadImage_i(std::shared_ptr<JFJochReaderDataset> &dataset,
DataMessage &message,
std::vector<uint8_t> &buffer,
int64_t image_number,
bool update_dataset) override;
// Decodes one image into the caller's byte buffer (RawByteBuffer or std::vector<uint8_t>) and
// returns the image that points at it. The compressed file is read through scratch, which the
// caller keeps between frames.
template <class Buffer>
CompressedImage DecodeInto(int64_t image_number, Buffer &buffer, std::vector<uint8_t> &scratch) const;
public:
~JFJochCBFReader() override = default;
// True if the path names something this reader can open: a miniCBF file, or a directory holding
// at least one. Cheap - it reads a few kB at most.
static bool CanRead(const std::string &path);
// path is a directory of *.cbf, or one *.cbf inside the sweep to take the whole directory from.
void ReadFiles(const std::string &path);
[[nodiscard]] uint64_t GetNumberOfImages() const override;
void Close() override;
bool ReadRawImage(int64_t image_number, JFJochReaderRawImage &image) override;
[[nodiscard]] std::vector<SpotToSave> ReadSpots(int64_t image) const override;
};