HS3Builder.h

Go to the documentation of this file.

/*
 * Project: RooFit
 * Authors:
 *   Jonas Rembser, CERN, Nov 2026
 *
 * Copyright (c) 2026, CERN
 *
 * Redistribution and use in source and binary forms,
 * with or without modification, are permitted according to the terms
 * listed in LICENSE (http://roofit.sourceforge.net/license.txt)
 */
 
#ifndef RooFit_HS3Builder_h
#define RooFit_HS3Builder_h
 
#include "HS3Document.h"
 
#include <RooArgSet.h>
 
#include <memory>
#include <string>
#include <vector>
 
class RooAbsArg;
class RooDataHist;
class RooJSONFactoryWSTool;
class RooRealVar;
 
namespace RooFit {
namespace JSONIO {
class Importer;
}
 
namespace HS3 {
 
/// Forward the warnings to the message service, and throw if there are errors.
void report(Diagnostics const &diagnostics);
 
/// Create the variables for the axes of binned data.
RooArgSet createObservables(std::vector<BinnedAxis> const &axes);
 
/// The axis of binned data for a variable.
BinnedAxis toBinnedAxis(RooRealVar const &var);
 
/// The name of an object, or the value of a literal constant.
NameOrNumber toNameOrNumber(RooAbsArg const &arg);
 
/// Create a RooDataHist with the contents and errors. If there are no errors, it doesn't store squared weights.
std::unique_ptr<RooDataHist> createDataHist(std::string const &name, RooArgSet const &vars,
                                            std::vector<double> const &contents, std::vector<double> const *errors);
 
/// Create the RooFit objects of a HistFactory distribution in the workspace of the tool. The constraint terms that no
/// modifier names are passed separately.
void buildHistFactoryDist(RooJSONFactoryWSTool &tool, std::string const &name, HistFactoryDist const &dist,
                          std::vector<DistributionRef> const *channelConstraints = nullptr);
 
/// Called by the exporter of a HistFactory distribution, which is then written by the tool. The constraint terms that
/// no modifier names are passed separately.
void setExportedObject(RooJSONFactoryWSTool &tool, HistFactoryDist dist,
                       std::vector<DistributionRef> channelConstraints);
 
/// Whether this is the importer that RooFit registers for HistFactory distributions, as opposed to the one of a user.
bool isBuiltinHistFactoryImporter(JSONIO::Importer const &importer);
 
/// What the built-in importer does with a HistFactory distribution, plus the constraint terms of the channel.
void importHistFactoryNode(RooJSONFactoryWSTool &tool, Detail::JSONNode const &node,
                           std::vector<DistributionRef> const *channelConstraints);
 
} // namespace HS3
} // namespace RooFit
 
#endif