Changes between Version 36 and Version 37 of HowToAddSample

Timestamp:

Jan 6, 2017, 1:39:29 PM (8 years ago)

Author:

Clarence Wret

Comment:

--

HowToAddSample

@@ -146 +146 @@
 }}}
 
-where we've copied the constructor arguments from some other class we're using as a template. I'll mention why this structure [#point_const below].
+where we've copied the constructor arguments from some other class we're using as a template. I'll elaborate more on this [#point_const below].
+
 
 [=#point_const]
 == Making the constructor ==
 
-NUISANCE loads samples through `FCN/SampleList.cxx` in the function `SampleUtils::LoadSample`, which makes a `std::list` of `MeasurementBase` pointers which it later loops over from executables.
-
-Most of the automated setting up is done in `Measurement1D::SetupMeasurement(std::string inputfile, std::string type, FitWeight *rw, std::string fakeDataFile)`, so it makes sense to have a class constructor which passes all of these on to `SetupMeasurement`.
+NUISANCE loads samples through `FCN/SampleList.cxx` in the function `SampleUtils::LoadSample`, which makes a `std::list` of `MeasurementBase` pointers which it later loops over from the executables.
+
+Most of the automated setting up of histograms, titles, and so on is done in `Measurement1D::SetupMeasurement(std::string inputfile, std::string type, FitWeight *rw, std::string fakeDataFile)`. It hence makes sense to have a class constructor which passes all of these on to `SetupMeasurement`.
 
 The arguments to `Measurement1D::SetupMeasurement` are:
 
- * inputfile: the location of the input file containing generated events
- * type: the type of comparison we want to make with this sample
- * rw: the reweighting engine which may or may not be used to reweight the sample
- * fakeDataFile: the location of a fake-data input file which is to be used as data instead of the actual data for fake-data studies
-
-
+ * `inputfile`: the location of the input file containing generated events
+ * `type`: the type of comparison we want to make with this sample
+ * `rw`: the reweighting engine which may or may not be used to reweight the sample
+ * `fakeDataFile`: the location of a fake-data input file which is to be used as data instead of the actual data for fake-data studies
+
+which currently all have to be passed. In reality, both `rw` and `fakeDataFile` do nothing in `SetupMeasurement` but are left for legacy reasons. We will likely change this soon!
+
+Looking at the base classes which we are inheriting our sample from (`Measurement1D` and `MeasurementBase`, both in `src/FitBase`), we minimally need to set:
+
+ * `std::string fName`: The name of the sample
+ * `std::string fPlotTitles`: The x and y axes of the sample
+ * `double EnuMin`: The minimum neutrino energy in the sample signal definition
+ * `double EnuMax`: The maximum neutrino energy in the sample signal definition
+ * `TH1D *fDataHist`: The data histogram scanned from the provided input
+ * `TH1D *fMCHist`: The generator histogram binning with same units as `fDataHist`
+ * `TH1D *fMCStat`: The generator histogram without any scaling (i.e. N,,events,,)
+ * `TH1D *fMCFine`: The generator histogram with same units as `fDataHist` but finer binning
+ * `TH1 **fMCHist_PDF`: The mode-by-mode generator histograms
+ * `TMatrixDSym *fFullCovar`: The covariance matrix
+ * `TMatrixDSym *covar`: The inverted covariance matrix (bad naming, sorry!)
+ * `double fScaleFactor`: The scaling factor we need to go from a event rate 
+
+
+We can set most of these by calling helper functions in `Measurement1D`, such as
+
+ * `Measurement1D::SetupMeasurement`: checks the naming of the sample and sets up the protected/private members, sets up the input generator processing for the sample, sets the fit options
+ * `Measurement1D::SetDataValues`: sets the data histogram from a given file
+ * `Measurement1D::SetCovarMatrix`: sets up the covariance matrices needed to calculate likelihoods
+ * `Measurement1D::SetupDefaultHist`: sets all the generator histograms and their auxillary histograms (e.g. mode-by-mode generator histograms)
+
+or similar functions (e.g. `Measurement1D::SetDataFromFile` instead of `Measurement1D::SetDataValues`).