8 : inputFile(file), pca(true) {
14 if (threshold < 0 || threshold >= 1) {
16 MACH3LOG_INFO(
"Principal component analysis but given the threshold for the principal components to be less than 0, or greater than (or equal to) 1. This will not work");
19 MACH3LOG_INFO(
"Am instead calling the usual non-PCA constructor...");
49 MACH3LOG_ERROR(
"Adaption has been enabled and now trying to enable PCA. Right now both configuration don't work with each other");
53 PCAObj = std::make_unique<PCAHandler>();
55 if(FirstPCAdpar == -999 || LastPCAdpar == -999) {
56 if(FirstPCAdpar == -999 && LastPCAdpar == -999) {
61 MACH3LOG_ERROR(
"You must either leave FirstPCAdpar and LastPCAdpar at -999 or set them both to something");
76 TFile *infile =
new TFile(file.c_str(),
"READ");
77 if (infile->IsZombie()) {
78 MACH3LOG_ERROR(
"Could not open input covariance ROOT file {} !!!", file);
83 TMatrixDSym *CovMat =
static_cast<TMatrixDSym*
>(infile->Get(name.c_str()));
86 MACH3LOG_ERROR(
"Could not find covariance matrix name {} in file {}", name, file);
87 MACH3LOG_ERROR(
"Are you really sure {} exists in the file?", name);
97 for (
int iThread = 0; iThread < nThreads; iThread++) {
120 bool CircEnabled =
false;
121 bool FlipEnabled =
false;
123 if (param[
"CircularBounds"]) {
127 if (param[
"FlipParameter"]) {
131 if (!CircEnabled && !FlipEnabled) {
139 MACH3LOG_INFO(
"Enabling CircularBounds for parameter {} with range [{}, {}]",
145 MACH3LOG_ERROR(
"Circular bounds [{}, {}] for parameter {} exceed physical bounds [{}, {}]",
154 MACH3LOG_ERROR(
"This is not supported, CircularPrior only works with flat prior");
162 FlipParameterPoint.push_back(Get<double>(param[
"FlipParameter"], __FILE__, __LINE__));
163 MACH3LOG_INFO(
"Enabling Flipping for parameter {} with value {}",
168 if (CircEnabled && FlipEnabled) {
170 MACH3LOG_ERROR(
"FlipParameter value {} for parameter {} is outside the CircularBounds [{}, {}]",
181 const double min_flip = std::min(flipped_low, flipped_high);
182 const double max_flip = std::max(flipped_low, flipped_high);
184 if (min_flip < low || max_flip > high) {
185 MACH3LOG_ERROR(
"Flipping about point {} for parameter {} would leave circular bounds [{}, {}]",
196 if (cov ==
nullptr) {
197 MACH3LOG_ERROR(
"Could not find covariance matrix you provided to {}", __func__ );
202 invCovMatrix =
static_cast<TMatrixDSym *
>(cov->Clone());
223 _fNames = std::vector<std::string>(SizeVec);
227 _fError = std::vector<double>(SizeVec, 1.0);
228 _fCurrVal = std::vector<double>(SizeVec, 0.0);
229 _fPropVal = std::vector<M3::float_t>(SizeVec, 0.0);
230 _fLowBound = std::vector<double>(SizeVec, -999.99);
231 _fUpBound = std::vector<double>(SizeVec, 999.99);
240 for(
int i = 0; i < SizeVec; i++) {
248 for(
int i = 0; i < SizeVec; i++) {
250 for (
int j = 0; j < SizeVec; j++) {
263 MACH3LOG_DEBUG(
"Over-riding {}: _fPropVal ({}), _fCurrVal ({}), _fPreFitValue ({}) to ({})",
277 std::vector<double> props(
_fNumPar);
291 #pragma GCC diagnostic push
292 #pragma GCC diagnostic ignored "-Wuseless-cast"
296 if (__builtin_expect(!
pca, 1)) {
298 #pragma omp parallel for
300 for (
int i = 0; i <
_fNumPar; ++i) {
315 MACH3LOG_WARN(
"Tried {} times to throw parameter {} but failed",
throws, i);
334 #pragma GCC diagnostic pop
344 #pragma GCC diagnostic push
345 #pragma GCC diagnostic ignored "-Wuseless-cast"
350 for (
int i = 0; i <
_fNumPar; ++i) {
356 const double sigma = sqrt((*
covMatrix)(i,i));
357 double throwrange = sigma;
358 if (paramrange < sigma) throwrange = paramrange;
365 MACH3LOG_WARN(
"Tried {} times to throw parameter {} but failed",
throws, i);
376 #pragma GCC diagnostic pop
447 #pragma omp parallel for
449 for (
int i = 0; i <
_fNumPar; ++i) {
462 #pragma omp parallel for
464 for (
int i = 0; i <
PCAObj->GetNumberPCAedParameters(); ++i)
467 if (
PCAObj->IsParameterFixedPCA(i)) {
486 #pragma omp parallel for
488 for (
int i = 0; i <
_fNumPar; ++i) {
490 #pragma GCC diagnostic push
491 #pragma GCC diagnostic ignored "-Wuseless-cast"
493 #pragma GCC diagnostic pop
507 #pragma omp parallel for
509 for (
int i = 0; i <
_fNumPar; ++i) {
522 #pragma GCC diagnostic push
523 #pragma GCC diagnostic ignored "-Wuseless-cast"
530 }
else if (
_fPropVal[index] < LowBound) {
542 #pragma GCC diagnostic pop
548 for (
int i = 0; i <
_fNumPar; i++) {
562 MACH3LOG_INFO(
"{:<30} {:<10} {:<10} {:<10}",
"Name",
"Prior",
"Current",
"Proposed");
563 for (
int i = 0; i <
_fNumPar; ++i) {
577 #pragma omp parallel for reduction(+:logL)
589 for (
int j = 0; j <= i; ++j) {
592 double scale = (i != j) ? 1. : 0.5;
604 for (
int i = 0; i <
_fNumPar; ++i) {
628 #pragma GCC diagnostic push
629 #pragma GCC diagnostic ignored "-Wuseless-cast"
633 for (
int i = 0; i <
_fNumPar; i++) {
638 if (pars.size() !=
static_cast<size_t>(
_fNumPar)) {
642 int parsSize = int(pars.size());
643 for (
int i = 0; i < parsSize; i++) {
645 if(std::isnan(pars[i])) {
656 PCAObj->TransferToParam();
658 #pragma GCC diagnostic pop
665 for (
int i = 0; i <
_fNumPar; ++i) {
675 for (
int i = 0; i <
_fNumPar; ++i) {
688 MACH3LOG_ERROR(
"You are trying so set StepScale to 0 or negative this will not work");
694 const double SuggestedScale = 2.38/std::sqrt(
_fNumPar);
695 if(std::fabs(scale - SuggestedScale)/SuggestedScale > 1) {
696 MACH3LOG_WARN(
"Defined Global StepScale is {}, while suggested suggested {}", scale, SuggestedScale);
798 MACH3LOG_WARN(
"I couldn't find parameter with name {}, therefore will not fix it", name);
809 MACH3LOG_WARN(
"I couldn't find parameter with name {}, therefore don't know if it fixed", name);
835 if (
static_cast<int>(stepscale.size()) !=
_fNumPar)
837 MACH3LOG_WARN(
"Stepscale vector not equal to number of parameters. Quitting..");
838 MACH3LOG_WARN(
"Size of argument vector: {}", stepscale.size());
843 for (
int iParam = 0 ; iParam <
_fNumPar; iParam++) {
852 MACH3LOG_INFO(
"============================================================");
854 for (
int iParam = 0; iParam <
_fNumPar; iParam++) {
857 MACH3LOG_INFO(
"============================================================");
875 std::vector<double> stepScales(
_fNumPar, 1.0);
884 MACH3LOG_ERROR(
"Parameter skip adapt flags not set, cannot set individual step scales for skipped parameters.");
893 MACH3LOG_DEBUG(
"Updating individual step scales for non-adapting parameters to cancel global step scale change.");
902 if (cov ==
nullptr) {
903 MACH3LOG_ERROR(
"Could not find covariance matrix you provided to {}", __func__);
907 if (
covMatrix->GetNrows() != cov->GetNrows()) {
908 MACH3LOG_ERROR(
"Matrix given for throw Matrix is not the same size as the covariance matrix stored in object!");
914 throwMatrix =
static_cast<TMatrixDSym*
>(cov->Clone());
922 #pragma omp parallel for collapse(2)
934 TMatrixDSym
const &subcov) {
936 if ((last_index - first_index) >= subcov.GetNrows()) {
937 MACH3LOG_ERROR(
"Trying to SetSubThrowMatrix into range: ({},{}) with a "
938 "submatrix with only {} rows {}",
939 first_index, last_index, subcov.GetNrows(), __func__);
943 TMatrixDSym *current_ThrowMatrix =
945 for (
int i = first_index; i <= last_index; ++i) {
946 for (
int j = first_index; j <= last_index; ++j) {
947 current_ThrowMatrix->operator()(i, j) =
948 subcov(i - first_index, j - first_index);
953 delete current_ThrowMatrix;
969 MACH3LOG_ERROR(
"PCA has been enabled and now trying to enable Adaption. Right now both configuration don't work with each other");
973 MACH3LOG_ERROR(
"Adaptive Handler has already been initialise can't do it again so skipping.");
983 std::vector<std::string> params_to_skip = GetFromManager<std::vector<std::string>>(adapt_manager[
"AdaptionOptions"][
"Covariance"][
matrixName][
"ParametersToSkip"], {});
987 for (
const auto& name : params_to_skip) {
997 double max_correlation = 0.01;
998 for (
int i = 0; i <
_fNumPar; ++i) {
999 for (
int j = 0; j <= i; ++j) {
1003 if(std::fabs(corr) > max_correlation) {
1004 MACH3LOG_ERROR(
"Correlation between skipped parameter {} ({}) and non-skipped parameter {} ({}) is {:.6e}, above the allowed threshold of {:.6e}.",
1033 if(GetFromManager<bool>(adapt_manager[
"AdaptionOptions"][
"Covariance"][
matrixName][
"UseExternalMatrix"],
false, __FILE__ , __LINE__)) {
1035 auto external_file_name = GetFromManager<std::string>(adapt_manager[
"AdaptionOptions"][
"Covariance"][
matrixName][
"ExternalMatrixFileName"],
"", __FILE__ , __LINE__);
1036 auto external_matrix_name = GetFromManager<std::string>(adapt_manager[
"AdaptionOptions"][
"Covariance"][
matrixName][
"ExternalMatrixName"],
"", __FILE__ , __LINE__);
1037 auto external_mean_name = GetFromManager<std::string>(adapt_manager[
"AdaptionOptions"][
"Covariance"][
matrixName][
"ExternalMeansName"],
"", __FILE__ , __LINE__);
1047 MACH3LOG_INFO(
"Successfully Set External Throw Matrix Stored in {}", external_file_name);
1050 if (!success)
return;
1095 TMatrixDSym* update_matrix =
static_cast<TMatrixDSym*
>(
AdaptiveHandler->GetAdaptiveCovariance()->Clone());
1117 TMatrixDSym* cov_trans = cov;
1119 TMatrixDSym cov_sym = 0.5*(*cov+*cov_trans);
1122 TDecompSVD cov_sym_svd=TDecompSVD(cov_sym);
1123 if(!cov_sym_svd.Decompose()){
1124 MACH3LOG_WARN(
"Cannot do SVD on input matrix, trying MakePosDef() first!");
1128 TMatrixD cov_sym_v = cov_sym_svd.GetV();
1129 TMatrixD cov_sym_vt = cov_sym_v;
1132 TVectorD cov_sym_sigvect = cov_sym_svd.GetSig();
1134 const Int_t nCols = cov_sym_v.GetNcols();
1135 TMatrixDSym cov_sym_sig(nCols);
1136 TMatrixDDiag cov_sym_sig_diag(cov_sym_sig);
1137 cov_sym_sig_diag=cov_sym_sigvect;
1140 TMatrixDSym cov_sym_polar = cov_sym_sig.SimilarityT(cov_sym_vt);
1143 TMatrixDSym cov_closest_approx = 0.5*(cov_sym+cov_sym_polar);
1148 *cov = cov_closest_approx;
1158 hMatrix->SetDirectory(
nullptr);
1161 hMatrix->SetBinContent(i+1, i+1, 1.);
1167 #pragma omp parallel for
1171 for(
int j = 0; j <= i; j++)
1174 hMatrix->SetBinContent(i+1, j+1, Corr);
1175 hMatrix->SetBinContent(j+1, i+1, Corr);
1195 for (YAML::Node param : copyNode[
"Systematics"])
1202 std::ofstream fout(
"Modified_Matrix.yaml");
1211 if(
Tunes ==
nullptr) {
1212 MACH3LOG_ERROR(
"Tunes haven't been initialised, which are being loaded from YAML, have you used some deprecated constructor");
1215 auto Values =
Tunes->GetTune(TuneName);
1222 std::vector<double>& BranchValues,
1224 const std::vector<std::string>& FancyNames) {
1232 if(FancyNames.size() != 0){
1237 bool matched =
false;
1238 for (
size_t iPar = 0; iPar < FancyNames.size(); ++iPar) {
1241 PosteriorFile->SetBranchStatus(
BranchNames[i].c_str(),
true);
1242 PosteriorFile->SetBranchAddress(
BranchNames[i].c_str(), &BranchValues[i]);
1255 if (!PosteriorFile->GetBranch(
BranchNames[i].c_str())) {
1259 PosteriorFile->SetBranchStatus(
BranchNames[i].c_str(),
true);
1260 PosteriorFile->SetBranchAddress(
BranchNames[i].c_str(), &BranchValues[i]);
#define _noexcept_
KS: noexcept can help with performance but is terrible for debugging, this is meant to help easy way ...
#define MACH3LOG_CRITICAL
std::vector< TString > BranchNames
Type Get(const YAML::Node &node, const std::string File, const int Line)
Get content of config file.
Custom exception class used throughout MaCh3.
std::vector< int > CircularBoundsIndex
Indices of parameters with circular bounds.
int GetNumParams() const
Get total number of parameters.
std::vector< bool > param_skip_adapt_flags
Flags telling if parameter should be skipped during adaption.
void ToggleFixParameter(const int i)
Toggle fixing parameter at prior values.
bool use_adaptive
Are we using AMCMC?
void SetFixAllParameters()
Set all parameters to be fixed at prior values.
virtual void ProposeStep()
Generate a new proposed state.
TH2D * GetCorrelationMatrix() const
KS: Convert covariance matrix to correlation matrix and return TH2D which can be used for fancy plott...
double * randParams
Random number taken from gaussian around prior error used for corr_throw.
void SetName(const std::string &name)
Set matrix name.
double ** throwMatrixCholDecomp
Throw matrix that is being used in the fit, much faster as TMatrixDSym cache miss.
void SetStepScale(const double scale, const bool verbose=true)
Set global step scale for covariance object.
virtual ~ParameterHandlerBase()
Destructor.
TMatrixDSym * invCovMatrix
The inverse covariance matrix.
void SetCovMatrix(TMatrixDSym *cov)
Set covariance matrix.
std::string GetParName(const int i) const
Get name of parameter.
std::vector< double > GetProposed() const
Get vector of all proposed parameter values.
void SetFlatPrior(const int i, const bool eL)
Set if parameter should have flat prior or not.
std::vector< int > FlipParameterIndex
Indices of parameters with flip symmetry.
void AcceptStep() _noexcept_
Accepted this step.
virtual double GetLikelihood()
Return CalcLikelihood if some params were thrown out of boundary return LARGE_LOGL
std::unique_ptr< AdaptiveMCMCHandler > AdaptiveHandler
Struct containing information about adaption.
std::vector< M3::float_t > _fPropVal
Proposed value of the parameter.
std::unique_ptr< ParameterTunes > Tunes
Struct containing information about adaption.
void InitialiseAdaption(const YAML::Node &adapt_manager)
Initialise adaptive MCMC.
TMatrixDSym * throwMatrix
Matrix which we use for step proposal before Cholesky decomposition (not actually used for step propo...
double _fGlobalStepScale
Global step scale applied to all params in this class.
int GetParIndex(const std::string &name) const
Get index based on name.
void ReserveMemory(const int size)
Initialise vectors with parameters information.
std::vector< std::string > _fFancyNames
Fancy name for example rather than param_0 it is MAQE, useful for human reading.
bool doSpecialStepProposal
Check if any of special step proposal were enabled.
std::vector< bool > _fFlatPrior
Whether to apply flat prior or not.
void ThrowParameters()
Throw the parameters according to the covariance matrix. This shouldn't be used in MCMC code ase it c...
double _fGlobalStepScaleInitial
Backup of _fGlobalStepScale for parameters which are skipped during adaption.
std::string matrixName
Name of cov matrix.
void MakeClosestPosDef(TMatrixDSym *cov)
HW: Finds closest possible positive definite matrix in Frobenius Norm ||.||_frob Where ||X||_frob=sqr...
void RandomConfiguration()
Randomly throw the parameters in their 1 sigma range.
TMatrixDSym * GetCovMatrix() const
Return covariance matrix.
std::vector< double > FlipParameterPoint
Central points around which parameters are flipped.
void UpdateAdaptiveCovariance()
Method to update adaptive MCMC .
void SetThrowMatrix(TMatrixDSym *cov)
Use new throw matrix, used in adaptive MCMC.
std::string GetParFancyName(const int i) const
Get fancy name of the Parameter.
std::vector< double > _fError
Prior error on the parameter.
void SetFreeAllParameters()
Set all parameters to be treated as free.
void SetFixParameter(const int i)
Set parameter to be fixed at prior value.
void SetParameters(const std::vector< double > &pars={})
Set parameter values using vector, it has to have same size as covariance class.
YAML::Node _fYAMLDoc
Stores config describing systematics.
bool IsParameterFixed(const int i) const
Is parameter fixed or not.
void MatchMaCh3OutputBranches(TTree *PosteriorFile, std::vector< double > &BranchValues, std::vector< std::string > &BranchNames, const std::vector< std::string > &FancyNames={})
Matches branches in a TTree to parameters in a systematic handler.
void UpdateThrowMatrix(TMatrixDSym *cov)
Replaces old throw matrix with new one.
void CircularParBounds(const int i, const double LowBound, const double UpBound)
HW :: This method is a tad hacky but modular arithmetic gives me a headache.
void SetBranches(TTree &tree, const bool SaveProposal=false)
set branches for output file
void SaveUpdatedMatrixConfig()
KS: After step scale, prefit etc. value were modified save this modified config.
void InitFromFile(const std::string &name, const std::string &file)
Initialisation of the class using matrix from root file.
void ResetIndivStepScale()
Adaptive Step Tuning Stuff.
std::unique_ptr< PCAHandler > PCAObj
Struct containing information about PCA.
int _fNumPar
Number of systematic parameters.
double CalcLikelihood() const _noexcept_
Calc penalty term based on inverted covariance matrix.
void FlipParameterValue(const int index, const double FlipPoint)
KS: Flip parameter around given value, for example mass ordering around 0.
void ConstructPCA(const double eigen_threshold, int FirstPCAdpar, int LastPCAdpar)
CW: Calculate eigen values, prepare transition matrices and remove param based on defined threshold.
std::vector< double > _fIndivStepScaleInitial
Backup of _fIndivStepScale for parameters which are skipped during adaption.
std::vector< double > _fLowBound
Lowest physical bound, parameter will not be able to go beyond it.
std::vector< double > _fCurrVal
Current value of the parameter.
std::vector< std::vector< double > > InvertCovMatrix
KS: Same as above but much faster as TMatrixDSym cache miss.
TMatrixDSym * covMatrix
The covariance matrix.
std::vector< double > _fPreFitValue
Parameter value dictated by the prior model. Based on it penalty term is calculated.
void Randomize() _noexcept_
"Randomize" the parameters in the covariance class for the proposed step. Used the proposal kernel an...
void PrintIndivStepScale() const
Print step scale for each parameter.
std::vector< std::string > _fNames
ETA _fNames is set automatically in the covariance class to be something like param_i,...
std::vector< std::pair< double, double > > CircularBoundsValues
Circular bounds for each parameter (lower, upper)
void EnableSpecialProposal(const YAML::Node ¶m, const int Index)
Enable special proposal.
double * corr_throw
Result of multiplication of Cholesky matrix and randParams.
bool GetFlatPrior(const int i) const
Get if param has flat prior or not.
std::string GetName() const
Get name of covariance.
void SetParCurrProp(const int i, const double val)
Set current parameter value.
void SetFreeParameter(const int i)
Set parameter to be treated as free.
std::vector< double > _fUpBound
Upper physical bound, parameter will not be able to go beyond it.
void SetSingleParameter(const int parNo, const double parVal)
Set value of single param to a given value.
double GetParInit(const int i) const
Get prior parameter value.
void SetPar(const int i, const double val)
Set all the covariance matrix parameters to a user-defined value.
void SetIndivStepScale(const int ParameterIndex, const double StepScale)
DB Function to set fIndivStepScale from a vector (Can be used from execs and inside covariance constr...
void SetIndivStepScaleForSkippedAdaptParams()
Set individual step scale for parameters which are skipped during adaption to initial values.
double GetDiagonalError(const int i) const
Get diagonal error for ith parameter.
ParameterHandlerBase()=default
void SetSubThrowMatrix(int first_index, int last_index, TMatrixDSym const &subcov)
void SetTune(const std::string &TuneName)
KS: Set proposed parameter values vector to be base on tune values, for example set proposed values t...
bool pca
perform PCA or not
std::vector< double > _fIndivStepScale
Individual step scale used by MCMC algorithm.
std::vector< std::unique_ptr< TRandom3 > > random_number
KS: Set Random numbers for each thread so each thread has different seed.
void PrintPreFitValues() const
Print prior value for every parameter.
void MakePosDef(TMatrixDSym *cov=nullptr)
Make matrix positive definite by adding small values to diagonal, necessary for inverting matrix.
void SpecialStepProposal()
Perform Special Step Proposal.
void PrintPreFitCurrPropValues() const
Print prior, current and proposed value for each parameter.
int PrintLength
KS: This is used when printing parameters, sometimes we have super long parameters name,...
void CorrelateSteps() _noexcept_
Use Cholesky throw matrix for better step proposal.
int CheckBounds() const _noexcept_
Check if parameters were proposed outside physical boundary.
void ToggleFixAllParameters()
Toggle fixing parameters at prior values.
std::string FormatDouble(const double value, const int precision)
Convert double into string for precision, useful for playing with yaml if you don't want to have in c...
constexpr static const double _LARGE_LOGL_
Large Likelihood is used it parameter go out of physical boundary, this indicates in MCMC that such s...
void MatrixVectorMulti(double *_restrict_ VecMulti, double **_restrict_ matrix, const double *_restrict_ vector, const int n)
KS: Custom function to perform multiplication of matrix and vector with multithreading.
int GetThreadIndex()
thread index inside parallel loop
double MatrixVectorMultiSingle(double **_restrict_ matrix, const double *_restrict_ vector, const int Length, const int i)
KS: Custom function to perform multiplication of matrix and single element which is thread safe.
void MakeMatrixPosDef(TMatrixDSym *cov)
Makes sure that matrix is positive-definite by adding a small number to on-diagonal elements.
constexpr static const int _BAD_INT_
Default value used for int initialisation.
int GetNThreads()
number of threads which we need for example for TRandom3
std::vector< std::vector< double > > GetCholeskyDecomposedMatrix(const TMatrixDSym &matrix, const std::string &matrixName)
Computes Cholesky decomposition of a symmetric positive definite matrix using custom function which c...