BmnAlignDefines.h

Go to the documentation of this file.

/*
    BM@N alignment routine
    BM@N experiment at NICA complex, JINR, 2025
 
    Department: Math & Soft Group of HEP lab
    Author:     Igor Polev, polev@jinr.ru
 
    Global defines for alignment task
*/
 
#ifndef BMN_ALIGN_DEFINES_H
#define BMN_ALIGN_DEFINES_H
 
#include "Math/SMatrix.h"
#include "Math/SVector.h"
#include "RtypesCore.h"
 
// main configuration parameters
#define BMN_MODULE_COUNT 22   // total number of FSD+GEM alignable detector elements (run 8)
#define BMN_CORRECTIONS {"dX", "dY", "dZ"}
#define BMN_GLOBAL_PARAMS_PD 3     // global alignment parameters per detector
#define BMN_LOCAL_PARAMS_PT 4      // local alignment parameters per track
#define BMN_MIN_HITS_PER_TRACK 5   // minimum alowed number of hits in track
#define BMN_MAX_CHI2_PER_NDF 5.0   // maximum allowed chi2 per hit in track
#define BMN_MIN_HITS_PORTION 0.1   // minimum portion of even part of tracks that must hit detector
 
// TODO: avoid variables in this header
constexpr static Int_t BMN_GLPARAMS_TOTAL{BMN_MODULE_COUNT * BMN_GLOBAL_PARAMS_PD};
 
#define BMN_SVD_LOW 10.0           // threshold for SVD values visualization
#define BMN_ALMOST_ZERO 1.0E-12    // approximate zero value for hard tests
#define BMN_CLOSE_TO_ZERO 1.0E-6   // approximate zero for (soft) tests of numerical solution
#define BMN_DRAW_TRACKS_CNT 20     // number of random tracks to draw
 
#define BMN_MAX_HIT_RAM_SIZE 8589934592   // 8GB RAM limit
#define BMN_MIN_TRACKS_PER_THREAD 1000    // multi-threading chunks
#define BMN_TRACKS_READ_PORTION 100000    // UI
#define BMN_THREAD_TRACKS_TICK 40000      // UI
 
// alignment algorithm parameters
#define BMN_MIN_ACTIVE_DETECTORS 1   // minimum number of active detectors to continue alignment
#define BMN_MIN_REL_PROGRESS 0.001   // relative tolerance for MSE convergence
#define BMN_REL_PROGRESS_GOOD 0.05   // relative iteration progress to turn off regularization
#define BMN_MIN_REGULAR_ITERS 3      // minimum number of sequential iterations with egularization
#define BMN_MAX_REGULAR_RETRY 10     // maximum number of retries with regularization turned on
#define BMN_1D_STEP_TOLERANCE 0.01   // absolute tolerance for 1D minimizer
#define BMN_BRENT_GRID_SIZE 4        // number of points in Brent preliminary grid
#define BMN_LM_ITERATIONS_MIN 3      // minimum number of Levenberg–Marquardt iterations (at least 2 required)
#define BMN_LM_ITERATIONS_MAX \
    10                          // maximum number of Levenberg–Marquardt iterations
                                // (at least BMN_LM_ITERATIONS_MIN + 1)
#define BMN_LM_MULT_STEP 10.0   // multiplier for Levenberg–Marquardt factor
 
// alignment algorithm test parameters
#define BMN_TEST_MODULE_COUNT 16
#define BMN_TEST_AVERAGE_DX 0.0208   // taken from real data 0.0208
#define BMN_TEST_AVERAGE_DY 0.1234   // taken from real data 0.1234
#define BMN_TEST_ALPHA1_SIGMA 1.0
#define BMN_TEST_ALPHA2_MIN -1.0   // not really physical value
#define BMN_TEST_ALPHA2_MAX 1.0    // not really physical value
#define BMN_ALIGN_PARAM_TOLERENCE 0.1
 
#define BMN_RESIDUALS_BINS 201
#define BMN_RESIDUALS_RANGE_X 0.2
#define BMN_RESIDUALS_RANGE_Y 1.0
#define BMN_RESIDUALS_MAX 1000.0
 
// fixed-size matrix types aliases
 
typedef ROOT::Math::SVector<Double_t, 2> SVect2;   // used in DEBUG only right now
typedef ROOT::Math::SVector<Double_t, 3> SVect3;
typedef ROOT::Math::SVector<Double_t, BMN_LOCAL_PARAMS_PT> SVectLC;
typedef ROOT::Math::SVector<Double_t, BMN_GLOBAL_PARAMS_PD> SVectGL;
typedef ROOT::Math::SVector<Double_t, BMN_GLPARAMS_TOTAL> SVectGLT;
 
typedef ROOT::Math::SMatrix<Double_t, 3, 3> SMatr3x3;
typedef ROOT::Math::SMatrix<Double_t, BMN_LOCAL_PARAMS_PT, BMN_LOCAL_PARAMS_PT> SMatrLC;
typedef ROOT::Math::SMatrix<Double_t, BMN_GLOBAL_PARAMS_PD, BMN_GLOBAL_PARAMS_PD> SMatrGL;
typedef ROOT::Math::SMatrix<Double_t, BMN_GLPARAMS_TOTAL, BMN_GLPARAMS_TOTAL> SMatrC;
typedef ROOT::Math::SMatrix<Double_t, BMN_GLPARAMS_TOTAL, BMN_LOCAL_PARAMS_PT> SMatrG;
typedef ROOT::Math::SMatrix<Double_t, BMN_GLOBAL_PARAMS_PD, BMN_LOCAL_PARAMS_PT> SMatrGP;
 
enum CoordIdx
{
    iX = 0,
    iY = 1,
    iZ = 2
};
 
enum LocalParamsIdx
{
    iX0 = 0,
    iX1 = 1,
    iY0 = 2,
    iY1 = 3
};
 
// using global random generator for reproducibility purposes
// TODO: try to avoid static variables in this header
#include "TRandom3.h"
static TRandom3 BMN_RND{0};
 
#endif