Changes between Version 15 and Version 16 of HowToAddSample

Timestamp:

Jan 5, 2017, 3:45:14 PM (7 years ago)

Author:

Clarence Wret

Comment:

--

HowToAddSample

@@ -49 +49 @@
 === Naming the sample ===
 
-Some automatic processing is done on loading up the sample. Most of these are simple string comparisons, but do place responsibility on the user.
+Some automatic processing is done on loading up the samples to set up generator scaling factors, chi2 calculations and so on. These are simple string comparisons done in the base class constructors, but do '''place responsibility on the user'''.
 
-The structure is `Experiment_Measurement_Target_DataType_DimensionVar_Neutrino`.
+The structure is '''`Experiment_Measurement_Target_DataType_DimensionVar_Neutrino`''':
 
-`Experiment` is the experiment (for us T2K)
-`Measurement` is a suitable name for the cross-section (for us CC1pi+)
-`Target` is the interaction target (for us H,,2,,O)
-`DataType` is essentially the measurement type which so far is an event rate (`Evt`) or a cross-section (`XSec`)
-`DimensionVar` is 1D or 2D followed by a suitable name for the dependent variable, e.g. `1Dpmu`
+ * `Experiment` is the experiment (for us T2K)
+ * `Measurement` is a suitable name for the cross-section (for us CC1pip)
+ * `Target` is the interaction target (for us H2O)
+ * `DataType` is the measurement type, either `Evt` for an event rate measurement or `XSec` for a cross-section measurement (for us `XSec`)
+ * `DimensionVar` is 1D or 2D followed by a suitable name for the dependent variable (for us `1Dpmu`)
+ * `Neutrino` is the neutrino type (for us `nu`)
+
+Out of these, string comparisons are only made on `DataType` and `DimensionVar`. The others are simply there to adhere to some standard and keep samples tidy.
+
+Following the above convention, we end up with `T2K_CC1pip_H2O_XSec_1Dpmu_nu` which I'm happy with: there is no question about what the class describes and there is no way of confusing it with other measurements.
 
 === Placing the sample ===