Jungfraujoch/image_analysis/spot_finding/StrongPixelSet.h

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

#pragma once

#include "../../common/DiffractionExperiment.h"
#include "../../common/DiffractionSpot.h"
#include "../../fpga/pcie_driver/jfjoch_fpga.h" // DeviceOutput
#include "SpotFindingSettings.h"

struct strong_pixel {
    uint16_t col;
    uint16_t line;
    int32_t counts;
};

class StrongPixelSet {
    std::vector<strong_pixel> pixels;
    std::vector<uint32_t> L;

    static const constexpr size_t max_strong_pixel_per_module = 4000;
    static const constexpr uint32_t xpixel = RAW_MODULE_COLS;
    static const constexpr uint32_t ypixel = RAW_MODULE_LINES;

    uint32_t strong_pixel_count;

    uint32_t find_root(uint32_t e);
    uint32_t make_union(uint32_t e1, uint32_t e2);
    // Labels the strong pixels and returns the components that pass BOTH the size bound and
    // SpotShapeAccepted. min-pix is deliberately not applied here (see FindComponentsImage).
    std::vector<DiffractionSpot> sparseccl(const SpotFindingSettings &settings);
public:
    void ReadFPGAOutput(const DiffractionExperiment& experiment,
                        const DeviceOutput& output);

    StrongPixelSet();
    // Pixels MUST arrive in raster order - line ascending, and column ascending within a line. The
    // component search walks the previous line with a forward-only cursor and would miss neighbours
    // handed to it out of order. Both callers satisfy this by construction, each scanning a bitmap in
    // ascending flat index: ImageSpotFinder::ExtractComponentsHost over the image, ReadFPGAOutput over
    // a module (whose row length is a multiple of 32, so no word straddles two lines).
    void AddStrongPixel(uint16_t col, uint16_t line, int32_t photons = 1);
    void FindSpots(const DiffractionExperiment &experiment, const SpotFindingSettings &settings, std::vector<DiffractionSpot> &spots,
                                uint16_t module_number);
    // Every connected component of at most max-pix pixels. min-pix is deliberately NOT applied: it is
    // the only spot setting that changes between the passes of the per-image min-pix search, so one
    // connected-component search serves all of them (see ImageSpotFinder::ExtractComponents).
    // The caller is responsible for not handing over more than StrongPixelLimit pixels.
    void FindComponentsImage(const SpotFindingSettings &settings, std::vector<DiffractionSpot> &spots);
    uint32_t GetStrongPixelCount() const;
};