Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooJSONFactoryWSTool::Config Struct Reference

Definition at line 58 of file RooJSONFactoryWSTool.h.

Public Attributes

bool allowExportInvalidNames = true
 
bool allowExportSharedVariates = false
 HS3 requires the terms of a likelihood and the components of a combined distribution to have distinct variates, e.g.
 
bool allowSanitizeNames = true
 
bool exportArrayDist = true
 
bool exportConstraintData = false
 
bool identifyLegacyBinWidthFactors = true
 Identify constant factors of HistFactory samples that are used like the inverse bin width of HistFactory before ROOT 6.26 by their structure, and don't write them, since histfactory_dist implies them.
 
bool importConstraintsAsChannels = false
 EXPERIMENTAL: how auxiliary measurements that are components of a combined distribution (a constraint term paired with the data set of its observed values, as RooFit writes them with exportConstraintData) are read.
 
bool renameCombinedObservables = false
 HS3 requires the components of a combined distribution to have distinct variates, e.g.
 

#include <RooFitHS3/RooJSONFactoryWSTool.h>

Member Data Documentation

◆ allowExportInvalidNames

bool RooJSONFactoryWSTool::Config::allowExportInvalidNames = true

Definition at line 59 of file RooJSONFactoryWSTool.h.

◆ allowExportSharedVariates

bool RooJSONFactoryWSTool::Config::allowExportSharedVariates = false

HS3 requires the terms of a likelihood and the components of a combined distribution to have distinct variates, e.g.

"mass_SR" and "mass_CR" for the observables of two channels instead of one "mass". By default, the export fails otherwise. If true, the document is written anyway, with a warning for every shared variate. It is not valid HS3 and can't be read back before the variates are renamed, e.g. by hand in the JSON.

Definition at line 77 of file RooJSONFactoryWSTool.h.

◆ allowSanitizeNames

bool RooJSONFactoryWSTool::Config::allowSanitizeNames = true

Definition at line 60 of file RooJSONFactoryWSTool.h.

◆ exportArrayDist

bool RooJSONFactoryWSTool::Config::exportArrayDist = true

Definition at line 82 of file RooJSONFactoryWSTool.h.

◆ exportConstraintData

bool RooJSONFactoryWSTool::Config::exportConstraintData = false

Definition at line 88 of file RooJSONFactoryWSTool.h.

◆ identifyLegacyBinWidthFactors

bool RooJSONFactoryWSTool::Config::identifyLegacyBinWidthFactors = true

Identify constant factors of HistFactory samples that are used like the inverse bin width of HistFactory before ROOT 6.26 by their structure, and don't write them, since histfactory_dist implies them.

Turn this off if a workspace has such factors that are not meant as bin widths: they are then written as normfactors.

Definition at line 64 of file RooJSONFactoryWSTool.h.

◆ importConstraintsAsChannels

bool RooJSONFactoryWSTool::Config::importConstraintsAsChannels = false

EXPERIMENTAL: how auxiliary measurements that are components of a combined distribution (a constraint term paired with the data set of its observed values, as RooFit writes them with exportConstraintData) are read.

If false, they become constraint terms of the model as in HistFactory, with global observables set to the observed values; RooFit recognizes the components that it wrote like this by a mark in the "misc" section of the document. If true, or without that mark, they stay components of the RooSimultaneous, with their data set of one entry in the combined data set, so that the RooSimultaneous is the sampling distribution of all measurements. This option and the form of the resulting workspace may still change.

Definition at line 96 of file RooJSONFactoryWSTool.h.

◆ renameCombinedObservables

bool RooJSONFactoryWSTool::Config::renameCombinedObservables = false

HS3 requires the components of a combined distribution to have distinct variates, e.g.

"mass_SR" and "mass_CR" instead of one "mass". If enabled, the observables of every combined data set are renamed on export to "obs_<key>" (the labels of the key joined by "_"), or "obs_<key>_<observable>" if a component has several observables; the components of the matching RooSimultaneous are written with the renamed observables (functions depending on them get the suffix "_<key>"). This allows exporting workspaces whose components share an observable. Off by default: without it, such workspaces can't be exported.

Definition at line 71 of file RooJSONFactoryWSTool.h.

Collaboration diagram for RooJSONFactoryWSTool::Config:
[legend]

The documentation for this struct was generated from the following file: