Changes between Version 34 and Version 35 of HowToAddSample

Timestamp:

Jan 6, 2017, 1:13:51 PM (8 years ago)

Author:

Clarence Wret

Comment:

--

HowToAddSample

@@ -109 +109 @@
 = Coding up a sample =
 
-Now that we have the rough structure set-up, we can finally start writing some code! :)
+Now that we have the rough structure set-up, we can finally start writing some code.
 
 
@@ -116 +116 @@
 In the case of our T2K CC1pi+ H,,2,,O data, we're dealing with 1D distributions. They should therefore inherit from the `Measurement1D` base class, as mentioned  [#point_base earlier]. The `Measurement1D` class is implemented in `src/FitBase/Measurement1D.cxx`.
 
-
-We will also require a `constructor` and `destructor` for the class, and we'll need to overload `MeasurementBase` methods which define the dependent variable(s) (p,,mu,, in our case) and what our signal is (CC interaction with one muon and one positive pion with no other pions or mesons and any number of nucleons in our case). The `MeasurementBase` functions which we need to overload are `MeasurementBase::isSignal(FitEvent *event)` and `MeasurementBase::FillEventVariables(FitEvent *event)`. 
+NUISANCE requires a `constructor` and `destructor` for the class, and we'll need to overload `MeasurementBase` methods which define the dependent variable(s) (p,,mu,, in our case) and what our signal is (CC interaction with one muon and one positive pion with no other pions or mesons and any number of nucleons in our case). The `MeasurementBase` functions which we need to overload are `MeasurementBase::isSignal(FitEvent *event)` and `MeasurementBase::FillEventVariables(FitEvent *event)`. 
 
 The `FitEvent` class is an object which contains information about one single event: all the particles, their kinematics and their status after the interaction, the interaction channel which produced the final state, possible secondary interactions, the interaction target, and so on.  The `FitEvent` class is implemented in `src/FitBase/FitEvent.cxx` and essentially the generator-independent common event format which NUISANCE uses for the generator events.
 
-Our header file then looks something like:
+[=!point_signal]
+We see that the `src/T2K` directory contains `T2K_SignalDef.cxx`. This extends the `SignalDef` namespace which holds many of the signal definitions for the classes. If you're implementing multiple distributions for the same measurement (e.g. dSig/dp,,mu,, and dSig/dcosmu) we recommend adding the signal definition to the namespace rather than directly in the `isSignal(FitEvent *event)` function in the class implementation. We'll talk about implementing a signal definition [#point_signaldef later].
+
+Our header file now looks like:
 
 {{{
@@ -144 +146 @@
 }}}
 
-where we've copied the constructor arguments from some other class we're using as a template.
-
-== 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.
+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].
+
+
+== Making the constructor == [=#point_const]
+
+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`.
+
+The arguments to `Measurement1D::SetupMeasurement` are:
 
  * inputfile: the location of the input file containing generated events
@@ -192 +197 @@
 == Specifying the event-level dependent variable(s) ==
 
+[=#point_signaldef]
 == Specifying a signal definition ==