Jungfraujoch/rugnux/RugnuxOutputFiles.h

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only

#pragma once

#include <memory>
#include <string>

#include "Rugnux.h"
#include "ResultReport.h"

class FileWriter;

// The files of a run, written by the program that ran it - rugnux and the viewer - from what the analysis
// returned: the library itself writes none.

// <prefix><label>_process.h5: the per-image analysis of each output pass, as it is made
// (ProcessConfig::image_sink).
class ProcessFileSink : public RugnuxImageSink {
    std::string prefix_;
    std::unique_ptr<FileWriter> writer_;
public:
    explicit ProcessFileSink(std::string prefix);
    ~ProcessFileSink() override;
    void Start(const StartMessage &start, const std::string &label) override;
    void Write(const DataMessage &msg) override;
    void End(const EndMessage &end) override;
};

// Every file `result` holds, under `prefix` with the names rugnux gives them: the reflection files (.mtz,
// .cif, .hkl, the twin hypothesis' and the model's choice's), the unmerged observations, the maps and the
// placed models, _detector.jpg, _plot.txt, and the _process.h5 of a run that indexed nothing; the other
// cell's beside them where the doubled cell was merged too. `provenance` and `nthreads` are what the mmCIF
// is written with.
void WriteRugnuxOutputs(const ProcessResult &result, const std::string &prefix, const OutputProvenance &provenance,
                        size_t nthreads, Logger &logger);

// The reflection files of one merge at <prefix><suffix>: .mtz and .cif, and the .hkl where `hkl`.
void WriteMergedOutput(const MergedOutput &merged, const std::string &prefix, const OutputProvenance &provenance,
                       size_t nthreads, bool hkl);

// A model validation's map coefficients at `prefix`: _maps.mtz.
void WriteModelMaps(const ModelMaps &maps, const std::string &prefix, Logger &logger);

// <prefix>_plot.txt (PerImagePlotText).
void WritePerImagePlot(const std::string &prefix, const PerImagePlot &plot);

// Renders and writes <output_prefix>_report.txt, and returns the document it rendered (the CLI's
// closing summary reads it). Writes nothing when the prefix is empty (the "compute statistics,
// persist nothing" mode). Never throws: a run that produced good reflections must not be lost
// because a side file could not be written, so a failure is logged and swallowed.
ReportDocument WriteResultReport(const std::string &output_prefix,
                                 const std::string &input_file,
                                 const DiffractionExperiment &experiment,
                                 const ProcessResult &result,
                                 Logger &logger,
                                 const RunProvenance &provenance = {});