Jungfraujoch/common/Definitions.h

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

#pragma once

#include "../fpga/pcie_driver/jfjoch_fpga.h"

#include <cstdint>
#include <cstddef>
#include <chrono>
#include <array>
#include <cmath>

constexpr float WVL_1A_IN_KEV = 12.39854f;

constexpr size_t CONVERTED_MODULE_LINES = 514;
constexpr size_t CONVERTED_MODULE_COLS = 1030;
constexpr size_t CONVERTED_MODULE_SIZE = CONVERTED_MODULE_LINES * CONVERTED_MODULE_COLS;
constexpr size_t JUNGFRAU_PACKET_SIZE_BYTES = 8192;

constexpr int MAX_IMAGE_NUMBER = 2*1024*1024;

constexpr std::chrono::nanoseconds MIN_COUNT_TIME = std::chrono::microseconds(3);
constexpr std::chrono::nanoseconds MIN_STORAGE_CELL_DELAY = std::chrono::nanoseconds(2100);
constexpr std::chrono::nanoseconds MIN_FRAME_TIME_JUNGFRAU_HALF_SPEED = std::chrono::microseconds(1000);
constexpr std::chrono::nanoseconds MIN_FRAME_TIME_JUNGFRAU_FULL_SPEED = std::chrono::microseconds(470);
constexpr std::chrono::nanoseconds MIN_FRAME_TIME_EIGER = std::chrono::microseconds(250);
constexpr std::chrono::nanoseconds MAX_COUNT_TIME_JUNGFRAU = std::chrono::microseconds(2000);
constexpr std::chrono::nanoseconds FRAME_TIME_PEDE_G1G2 = std::chrono::microseconds(10*1000);

constexpr std::chrono::nanoseconds PSI_JUNGFRAU_READOUT_TIME = std::chrono::microseconds(20);
constexpr std::chrono::nanoseconds PSI_EIGER_READOUT_TIME = std::chrono::microseconds(20);
constexpr std::chrono::nanoseconds DARK_MASK_FRAME_TIME = std::chrono::milliseconds(10);

constexpr float MIN_ENERGY_KEV = 0.001;
constexpr float MAX_ENERGY_KEV = 500.0;

constexpr float DEFAULT_G0_FACTOR = 41.0f;
constexpr float DEFAULT_G1_FACTOR = -1.439f;
constexpr float DEFAULT_G2_FACTOR = -0.1145f;
constexpr float DEFAULT_HG0_FACTOR = 100.0f;

constexpr int MAX_SPOT_COUNT = 64 * 1024;

constexpr uint32_t MASK_PEDESTAL_G0_RMS_LIMIT = (1U<<4);

constexpr size_t PEDESTAL_MIN_IMAGE_COUNT = 128;
constexpr uint16_t PEDESTAL_WRONG = (UINT16_MAX);
constexpr size_t PEDESTAL_G0_WRONG_GAIN_ALLOWED_COUNT = 2;

constexpr size_t MESSAGE_SIZE_FOR_START_END = (256*1024*1024); // pessimistic highest value
constexpr float LAB6_CELL_A = 4.156468f;

// Ice ring resolution taken from:
// Moreau, Atakisi, Thorne, Acta Cryst D77, 2021, 540,554
// https://journals.iucr.org/d/issues/2021/04/00/tz5104/index.html

constexpr std::array<float, 11> ICE_RING_RES_A = {3.895, 3.661, 3.438, 2.667, 2.249, 2.068, 1.947, 1.916, 1.882, 1.719, 1.522};

// True when resolution d (Angstrom) sits within half_width of a hexagonal-ice powder ring, in the
// q = 2*pi/d units the spot-finder uses (ice_ring_width_Q_recipA). Used to drop ice-contaminated
// reflections from scaling/merging when ice-ring handling is enabled.
inline bool IsOnIceRing(float d_A, float half_width_q_recipA) {
    if (!(d_A > 0.0f))
        return false;
    constexpr float two_pi = 6.283185307f;
    const float q = two_pi / d_A;
    for (const float ice_d : ICE_RING_RES_A)
        if (std::fabs(q - two_pi / ice_d) < half_width_q_recipA)
            return true;
    return false;
}

// Index into ICE_RING_RES_A of the hexagonal-ice ring resolution d sits on (within half_width in
// q = 2*pi/d), or -1 if none. Used to look up that ring's per-image strength for the merge gate.
inline int IceRingIndex(float d_A, float half_width_q_recipA) {
    if (!(d_A > 0.0f))
        return -1;
    constexpr float two_pi = 6.283185307f;
    const float q = two_pi / d_A;
    for (size_t i = 0; i < ICE_RING_RES_A.size(); ++i)
        if (std::fabs(q - two_pi / ICE_RING_RES_A[i]) < half_width_q_recipA)
            return static_cast<int>(i);
    return -1;
}