M3::DiagMCMCModule Class Reference

Module for performing diagnostic analysis on MCMC chains. More...

#include <CLI/Modules/DiagMCMCModule.hpp>

Inheritance diagram for M3::DiagMCMCModule:

Collaboration diagram for M3::DiagMCMCModule:

Public Member Functions
virtual	~DiagMCMCModule ()
	Destructor. More...
MaCh3ArgumentParser *	get_parser () override
	Get the argument parser for this module. More...
int	Run () override
	Execute the MCMC diagnostics. More...
Public Member Functions inherited from M3::PluginBase
virtual	~PluginBase ()=default
Public Member Functions inherited from M3::IPlugin
virtual	~IPlugin ()=default

Additional Inherited Members
Protected Attributes inherited from M3::PluginBase
std::unique_ptr< MaCh3ArgumentParser >	m_parser
	Argument parser for this plugin. More...

Detailed Description

Module for performing diagnostic analysis on MCMC chains.

This module provides diagnostics such as convergence tests, autocorrelation analysis, and batch means calculations to assess the quality of MCMC samples.

Definition at line 14 of file DiagMCMCModule.hpp.

Constructor & Destructor Documentation

~DiagMCMCModule()

M3::DiagMCMCModule::~DiagMCMCModule ( )

virtualdefault

Destructor.

Member Function Documentation

get_parser()

MaCh3ArgumentParser * M3::DiagMCMCModule::get_parser ( )

overridevirtual

Get the argument parser for this module.

Returns

Pointer to the configured MaCh3ArgumentParser

Implements M3::IPlugin.

Definition at line 16 of file DiagMCMCModule.cpp.

                                                 {
    m_parser = std::make_unique<MaCh3ArgumentParser>("diag", "1.0", argparse::default_arguments::help);
    m_parser->add_description("Tool for MCMC diagnostic like autocorrelations.");
    m_parser->add_argument("mcmc-output")
      .help("MCMC chain root file.")
      .metavar("MCMC_CHAIN")
      .required();
    m_parser->add_argument("config")
      .help("Config file.")
      .metavar("CONFIG")
      .required();
    return m_parser.get();
  }

Run()

int M3::DiagMCMCModule::Run ( )

overridevirtual

Execute the MCMC diagnostics.

Main function creating MCMCProcessor and calling MCMC Diagnostic.

Returns

Exit code (0 on success)

Parameters

inputFile	MCMC Chain
config	Config file with settings

Implements M3::IPlugin.

Definition at line 34 of file DiagMCMCModule.cpp.

                          {
    SetMaCh3LoggerFormat();
    MACH3LOG_INFO("Producing single fit output");
    std::string inputFile = m_parser->get<std::string>("mcmc-output");
    std::string config = m_parser->get<std::string>("config");
 
    MACH3LOG_INFO("File for study: {}", inputFile);
 
    YAML::Node Settings = M3OpenConfig(config);
 
    // Make the processor
    auto Processor = std::make_unique<MCMCProcessor>(inputFile);
    Processor->SetOutputSuffix("_MCMC_Diag");
    //KS:Turn off plotting detector and some other setting
    Processor->SetExcludedTypes(GetFromManager<std::vector<std::string>>(Settings["DiagMCMC"]["ExcludedTypes"], {}, __FILE__, __LINE__));
    Processor->SetExcludedNames(GetFromManager<std::vector<std::string>>(Settings["DiagMCMC"]["ExcludedNames"], {}, __FILE__, __LINE__));
    Processor->SetExcludedGroups(GetFromManager<std::vector<std::string>>(Settings["DiagMCMC"]["ExcludedGroups"], {}, __FILE__, __LINE__));
    Processor->SetPlotRelativeToPrior(GetFromManager<bool>(Settings["DiagMCMC"]["PlotRelativeToPrior"], false, __FILE__, __LINE__));
    //KS: Use 20 batches for batched means
    Processor->SetnBatches(GetFromManager<int>(Settings["DiagMCMC"]["nBatches"], 20, __FILE__, __LINE__));
    Processor->SetnLags(GetFromManager<int>(Settings["DiagMCMC"]["nLags"], 25000, __FILE__, __LINE__));
    Processor->SetPrintToPDF(GetFromManager<bool>(Settings["PrintToPDF"], true, __FILE__, __LINE__));
    Processor->Initialise();
    if(Settings["MaxEntries"]) {
        Processor->SetEntries(Get<int>(Settings["MaxEntries"], __FILE__, __LINE__));
    }
    //KS: finally call main method
    Processor->DiagMCMC();
 
    return 0;
  }

---

The documentation for this class was generated from the following files:

• CLI/Modules/DiagMCMCModule.hpp
• CLI/Modules/DiagMCMCModule.cpp