Jungfraujoch/image_analysis/image_preprocessing/ImagePreprocessor.h

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

#pragma once

#include <cstdint>
#include <cstddef>
#include "../common/CompressedImage.h"
#include "../common/DiffractionExperiment.h"
#include "../common/PixelMask.h"
#include "ImagePreprocessorBuffer.h"

struct alignas(8) ImageStatistics {
    unsigned long long error_pixel_count = 0;
    unsigned long long saturated_pixel_count = 0;
    unsigned long long masked_pixel_count = 0;
    long long max_value = INT64_MIN;
    long long min_value = INT64_MAX;
};

class ImagePreprocessor {
protected:
    const size_t npixels;
    const DiffractionExperiment &experiment;
    const int64_t saturation_limit;
public:
    ImagePreprocessor(const DiffractionExperiment &experiment);
    virtual ~ImagePreprocessor() = default;
    virtual ImageStatistics Analyze(ImagePreprocessorBuffer &processed_image, const uint8_t *decompressed_image, CompressedImageMode image_mode) = 0;
};