From 958bf04efa0354aba16e7b0e0c2c3cdc1bc70c3a Mon Sep 17 00:00:00 2001
From: Steven Doran <78985334+S81D@users.noreply.github.com>
Date: Wed, 2 Oct 2024 10:03:22 -0500
Subject: [PATCH] Create README.md

README for the new RWM fitting tool
---
 UserTools/FitRWMWaveform/README.md | 35 ++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 UserTools/FitRWMWaveform/README.md

diff --git a/UserTools/FitRWMWaveform/README.md b/UserTools/FitRWMWaveform/README.md
new file mode 100644
index 000000000..798057458
--- /dev/null
+++ b/UserTools/FitRWMWaveform/README.md
@@ -0,0 +1,35 @@
+# FitRWMWaveform
+
+FitRWMWaveform tool takes the auxilliary channel waveforms saved in the Processed Data and peforms rising edge fitting to determine the rising edge time. 
+
+Currently the two auxillary waveforms are the Booster RF and the Booster RWM signals (https://github.com/ANNIEsoft/ToolAnalysis/blob/ff86893aa905652621594f8ac093be45f3bd13b5/configfiles/LoadGeometry/AuxChannels.csv#L5).
+
+Motivation for this tool and details of the waveform shape and fitting can be found here: https://annie-docdb.fnal.gov/cgi-bin/sso/ProcessDocumentAdd 
+
+## Data
+
+The tool will populate the following objects (all `double` datatype):
+
+### RWM fits
+* **RWMRisingStart**: Time where the RWM trace crosses predefined threshold
+* **RWMRisingEnd**: Time where RWM trace crosses below predefined threshold (at the end)
+* **RWMHalfRising**: Time where the RWM rising edge crosses 50% of its maximum above baseline.
+* **RWMFHWM**: FWHM of the RWM waveform (sorry for the typo).
+* **RWMFirstPeak**: After the rising edge of the RWM trace, there is often a sharp peak. This the time of this first peak.
+  
+### BRF fit
+* **BRFFirstPeak**: For the BRF waveform, fit of the first BRF pulse. 
+* **BRFAveragePeak** The average (or baseline) y-value (in ADC) of the signal across the entire window.
+* **BRFFirstPeakFit** Fit for the half-rising time of the first BRF pulse.
+
+
+## Configuration
+
+Configuration variables for FitRWMWaveform.
+
+```
+verbosityFitRWMWaveform 0             # verbosity level
+printToRootFile 1                     # 1 to print the RWM and BRF waveforms to an output root file, 0 for no printing
+maxPrintNumber 100                    # maximum number of waveforms to save to the output root file
+output_filename RWMBRFWaveforms.root  # name of the output root file
+```