1HISTTOWORKSPACE(1)          General Commands Manual         HISTTOWORKSPACE(1)
2
3
4

NAME

6       hist2workspace  - utility to create RooFit/RooStats workspace from his‐
7       tograms
8

SYNOPSIS

10       hist2workspace [option] input.xml
11

DESCRIPTION

13       hist2workspace is a utility to create  RooFit/RooStats  workspace  from
14       histograms
15

OPTIONS

17       -standard_form default model, which creates an extended PDF that inter‐
18       polates between RooHistFuncs.  This is much faster for models with many
19       bins and uses significantly less memory.
20       -number_counting_form  this  was  the  original  model in 5.28 (without
21       patches). It uses a Poisson for each bin of the  histogram.   This  can
22       become slow and memory intensive when there are many bins.
23

Prepare working area

25       The  ROOT  release ships with a script prepareHistFactory in the $ROOT‐
26       SYS/bin directory that prepares a working area.  It creates a results/,
27       data/, and config/ directory.  It also copies the HistFactorySchema.dtd
28       and example XML files into the  config/  directory.   Additionally,  it
29       copies a root file into the data/ directory for use with the examples.
30

HistFactorySchema.dtd

32       This  file is located in $ROOTSYS/etc/ specifies the XML schema.  It is
33       typically placed in the config/ directory of a  working  area  together
34       with  the top-level XML file and the individual channel XML files.  The
35       user should not modify this file.
36       The HistFactorySchema.dtd is commented to specify exactly  the  meaning
37       of the various options.
38
39
40

Top-Level XML File

42       (see  for example $ROOTSYS/tutorials/histfactory/example.xml) This file
43       is edited by the user.  It specifies
44        - A top level 'Combination' that is composed of:
45           - several 'Channels', which are described in separate XML files.
46           - several 'Measurements' (corresponding to a full fit of the model)
47       each of which specifies
48             - a name for this measurement to be used in tables and files
49             -  what  is the luminosity associated to the measurement in pico‐
50       barns
51             - which bins of the histogram should be used
52             - what is the relative uncertainty on the luminosity
53             - what is (are) the parameter(s) of interest that  will  be  mea‐
54       sured
55             - which parameters should be fixed/floating (eg. nuisance parame‐
56       ters)
57             - which type  of  constriants  are  desired       -  Gaussian  by
58       default      - Gamma, LogNormal, and Uniform are also supported
59             -  if  the tool should export the model only and skip the default
60       fit
61
62

Channel XML Files

64       (see  for  example  $ROOTSYS/tutorials/histfactory/example_channel.xml)
65       This file is edited by the user.  It specifies for each channel
66        - observed data
67          -  if  absent the tool will use the expectation, which is useful for
68       expected sensitivity
69        - several 'Samples' (eg. signal, bkg1, bkg2, ...), each of which has:
70          - a name
71          - if the sample is normalized by theory (eg N = L*sigma) or not (eg.
72       data driven)
73          - a nominal expectation histogram
74          -  a  named 'Normalization Factor' (which can be fixed or allowed to
75       float in a fit)
76          - several 'Overall Systematics' in normalization with:
77            - a name
78            - +/- 1 sigma variations (eg. 1.05 and 0.95 for a 5% uncertainty)
79          - several 'Histogram Systematics' in shape with:
80            - a name (which can be shared with the OverallSyst if correlated)
81            - +/- 1 sigma variational histograms
82

ORIGINAL AUTHORS

84              Kyle Cranmer , Akira Shibata , and Dominique Tardif
85
87       This library is free software; you can redistribute it and/or modify it
88       under  the  terms of the GNU Lesser General Public License as published
89       by the Free Software Foundation; either version 2.1 of the License,  or
90       (at your option) any later version.
91
92       This  library  is  distributed  in the hope that it will be useful, but
93       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
94       CHANTABILITY  or  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
95       General Public License for more details.
96
97       You should have received a  copy  of  the  GNU  Lesser  General  Public
98       License  along  with  this  library; if not, write to the Free Software
99       Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,  MA   02110-1301
100       USA
101
102
103
104
105                                   DEC. 2010                HISTTOWORKSPACE(1)
Impressum