~ubuntu-branches/ubuntu/quantal/rivet/quantal

« back to all changes in this revision

Viewing changes to debian/rivet-rescale.1

  • Committer: Package Import Robot
  • Author(s): Lifeng Sun
  • Date: 2012-06-04 00:23:54 UTC
  • Revision ID: package-import@ubuntu.com-20120604002354-hqdcr26y74z0z4qy
Tags: 1.8.0-1
Initial release (Closes: #636983)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH RIVET-RESCALE "1" "June 2012" "Rivet" "User Commands"
 
2
.SH NAME
 
3
rivet\-rescale \- Rescale histos in observable\-file of AIDAFILE to
 
4
the area of the corresponding histos in REFDATAPATH
 
5
.SH SYNOPSIS
 
6
.B rivet-rescale
 
7
[\fI-r <REFDATAPATH>\fR] [\fI-O <observable-file>\fR] [\fI-b <bindef> \fR[\fI-b \fR...]] \fI<AIDAFILE> \fR[\fI<OUTFILE>\fR]
 
8
.SH DESCRIPTION
 
9
Rescale histos in observable\-file of AIDAFILE to the area of the
 
10
corresponding histos in REFDATAPATH. REFDATAPATH can either be
 
11
a single AIDA\-file or a directory containing AIDA\-files. By default
 
12
the standard Rivet reference files are used.
 
13
.PP
 
14
Observable definitions of the form
 
15
/CDF_2000_S4155203/d01\-x01\-y01  1.0
 
16
can be used to specify an absolute normalisation (1.0, here) for a
 
17
histogram rather than using the reference histo. If the \fB\-\-multiply\fR
 
18
switch is used, the ref histo area will be scaled by the given factor
 
19
to give the target normalisation.
 
20
.PP
 
21
You can also define bins to chop out in the observable\-file in the
 
22
same way as in chop_bins:
 
23
/CDF_2000_S4155203/d01\-x01\-y01:0:35  1.0
 
24
This will chop the bins with Z\-pT > 35 GeV and obtain a rescaling factor
 
25
from that restricted bin range: note that the output histograms will
 
26
be rescaled but *unchopped*.
 
27
.PP
 
28
Only one bin definition can be used for each histogram, so the last bindef
 
29
specified for that histo path will be the one which is applied. The bindefs
 
30
are constructed in order from those in the obsfile, and then those given on
 
31
the command line with the \fB\-b\fR flag, like this:
 
32
.HP
 
33
\fB\-b\fR "/CDF_2000_S4155203/d01\-x01\-y01:5:135 2.0"
 
34
.SH OPTIONS
 
35
.TP
 
36
\fB\-h\fR, \fB\-\-help\fR
 
37
show this help message and exit
 
38
.TP
 
39
\fB\-O\fR OBSFILE, \fB\-\-obsfile\fR=\fIOBSFILE\fR
 
40
Specify a file with histograms (and bin ranges) that
 
41
are to be normalised.
 
42
.TP
 
43
\fB\-b\fR BINRANGES, \fB\-\-bins\fR=\fIBINRANGES\fR
 
44
Specify a histogram and bin range that is to be used.
 
45
The format is `AIDAPATH:start:stop'.
 
46
.TP
 
47
\fB\-r\fR REFDIR, \fB\-\-refdir\fR=\fIREFDIR\fR
 
48
File of folder with reference histos
 
49
.TP
 
50
\fB\-a\fR
 
51
Produce AIDA output rather than FLAT
 
52
.TP
 
53
\fB\-f\fR
 
54
Produce FLAT output rather than AIDA
 
55
.TP
 
56
\fB\-\-multiply\fR
 
57
Rescale histos using weight given as factor rather
 
58
than new area
 
59
.TP
 
60
\fB\-i\fR, \fB\-\-in\-place\fR
 
61
Overwrite input file rather than making inputrescaled.aida
 
62
.TP
 
63
\fB\-\-fast\fR
 
64
Try loading only reference files from refpath that
 
65
match analyses in input\-file
 
66
.SH EXAMPLES
 
67
.TP
 
68
rivet\-rescale out.aida
 
69
This will return the histos in out.aida, scaled to match the overall
 
70
normalisations of the Rivet ref data.
 
71
.TP
 
72
rivet\-rescale \fB\-O\fR observables.obs out.aida
 
73
This will return the histos in out.aida, scaled by the bin definitions
 
74
specified in observables.obs (and using the Rivet ref data again)
 
75
.TP
 
76
rivet\-rescale \fB\-r\fR path/to/CDF_2000_S4155203.aida \fB\-b\fR "/CDF_2000_S4155203/d01\-x01\-y01:2:5" out.aida
 
77
For this Z\-boson pT\-distribution, the normalisation to the provided ref
 
78
data file is only applied between 2 < x < 5 GeV.
 
79
.SH AUTHOR
 
80
This manual page was written by Lifeng Sun <lifongsun@gmail.com> for the Debian system (but may be used by others).