View source for Simulation using SIMC

'''Working on simc version taken from Github'''

---****************************************---


Description of different versions:

The "simc_gfortran" repository contains the 6GeV spectrometer models. The "simc_sos" repository also contains the 6GeV spectrometer models, but with the SOS quad replacing Q1. The "simc_spring16" and "simc_fall16" repositories contain models of the spectrometers as they were in Spring and Fall 2016, respectively.

------------------------------------------------------

Links to available repositories:

https://github.com/bschmookler/simc_gfortran

https://github.com/bschmookler/simc_sos

https://github.com/bschmookler/simc_spring16

https://github.com/bschmookler/simc_fall16


We've also made single-arm versions of all four, which can be found here:

https://github.com/JeffersonLab/halla-xem-analysis

------------------------------------------------------

---This is Barak Schmookler's activity Log---

Sep 28, 2015:

1) Created 'simc_gfortran' fork on GitHub

2) Cloned to GMp workdisk

Sep 29, 2015:

1) Changed Makefile for 64bit library compatibility 

2) Created "save_sep15" directory in "infiles" directory. Moved initial input files here. Began to create GMp input files in the "infiles" directory. Specifically I created a "point hydrogen" inclusive elastic input file and a 15cm long hydrogen inclusive elastic input file.

3) Copied correct forward and reconstruction maps (COSY) to hrsr and hrsl directories. Also copied .fox file used to generate said matrices and .fox file that can be used to plot rays (within COSY).

Sep 30, 2015:

1) Added input file option (col_flag) which allows one to choose an open, collimator, or sieve configuration. Previously this had to be done in the spectrometer code itself, and then recompiled. I currently only implemented the option for the HRSs (not for Hall C spectrometers).

Nov 4, 2015:

1) Added line to "enerloss_new" subroutine to print out the mode ('typeflag' in subroutine) when Eloss > Ekin. Also made to print values of Eloss and Ekin.

Nov 10, 2015:

1) Adjusted "run_simc" script to dump output to 'outfiles' directory 

Nov 21, 2015:

1) Implemented GMp target geometry. The GMp target will be used if "target%can" is set to 3.

Jan-Feb 2016:

1) Created version of SIMC ("simc_sos") where the normal Q1 on both hrs spectrometers is replaced by the SOS quad.

2) Created single-arm versions called "phase_space_hrs" and "phase_space_sos". This version has an option to dump all events into the ntuple. Multiple scattering and energy loss is not implemented.

3) Two external sieves have been implemented. One is called "GMp Sieve", which is the one that was used on the Right HRS during Spring 2016.

March 30, 2016:

1) Implemented number generation using a random state file. This is done so that random seed is different for different runs. In the standard SIMC, this option already existed. In the single arm version, I had to write some code.

2) Set extra_hydrogen input files to use flat raster pattern. In single-arm versions, only flat raster option is available. I've also dumped the raster values into the ntuple for all versions (already present for y direction.)

March 31, 2016:

1) Implemented material for multiple scattering in single-arm versions. I used the RHRS Spring 16 geometry. I also set a "beer can" target as the only option.

April 11, 2016:

1) For the scattered electron, made it so the forward-going ionization energy loss is protected with the "using_Eloss" flag. See lines 1611-1620 in simc.f.

2) Corrected line 1631 in simc.f to use the angle of the electron arm. Previously, it incorrectly used the angle of the proton arm.

3) In the single-arm version, corrected a formatting error when writing event loss information to the .hist file in the outfiles subdirectory.

4) In the single-arm version, made a rough calculation of reconstructed z-tar. The vertex resolution is now calculated (and printed) correctly.

5) In the "extreme_trip_thru_target" subroutine in target.f, the diameter of the "beer can" target was incorrect. See lines 387-403 and lines 539-553.

April 12, 2016:

1) Implemented "dump all events" option and event-loss flag/location for all versions. If one chooses to put all generated events into the Ntuple, a branch named "success" ("ok_spec") tells whether the event reached the hut and was reconstructed. The cross-sections/weights are calculated for every generated event. The information in the .hist file is not affected, however. The variables "x_stop", "y_stop", and "stopwhen" provide info on the events that are not successful. Reconstructed quantities will only be updated on a success; the event-loss variables ("x_stop","y_stop","stopwhen") will only be updated on a failure; so it's important to cut on the "success" branch. If the events are run through both spectrometers, the event is first run through the hadron spectrometer. So, only hadron arm event-loss information will be written if the event fails there. For GMp, we only run the events through the electron arm, but someone may want to change this at some point. (N.B. All of this is only implemented for HRS at the point).

April 25, 2016:

1) Dumped real and reconstructed ionization energy loss information for the incoming electron and scattered particles.

2) Corrected sign error in transformation from hall coordinate system to spectrometer coordinate system. See line 1421 for hadron and line 1646 for electron.

3) Dumped generated and reconstructed z-vertex into ntuple.

4) Made reconstructed energy loss calculations z-vertex dependent. When considering the incoming electron energy, I use the average reconstructed vertex of the electron and hadron. If the events are only run through one arm, I obviously only use that arm's reconstructed vertex.

May 4, 2016:

1) In single-arm version added option to read in generated events from a text file. Hat tip to Erez Cohen on this one. 

May 25, 2016:

1) Put correct geometry for Left HRS and Right HRS for Spring 2016 run into a directory called "simc_spring16". Also, I included the correct material before spectrometer.

2) Created a single-arm version for Spring 2016 RHRS, called "phase_space_spring16".

June 23, 2016:

1) Put in vdc offsets from Analyzer database for Left HRS and Right HRS into mc_hrsr(l).f; as well as into detector hut subroutine.

2) In "phase_space_spring16", put correct material before spectrometer (assuming RHRS). I assume the target is shaped as a "beer can".

August 30, 2016:

1) When using benhar spectral function, previously the limits on missing momentum were not being set. So, a small change was made in dbase.f (see lines 509-510). Probably a better fix than this could be developed.

September 2, 2016:

1) Updated the Right HRS detector stack with the corrected material and detector positions. I noticed that the previous version of SIMC had the focal plane in a slightly incorrect position. So when I put the correct position in SIMC, I had to also use this correct position in COSY.

October 4, 2016:

1) For both HRS spectrometers, rotated the vacuum exit windows so that they lie in the horrizontal plane. This aperture does not seem to define the acceptance at all. So it's not a very important change.

October 23, 2016:

1) Updated the Left HRS detector stack with the corrected material and detector positions. Same comment on focal plane as for Right HRS.

2) Made the raster correction account for the average beam position.

October 28, 2016:

1) Created a simc_fall16" version, with updated hrs, detector hut, target info.

November 6, 2016:

1) Created a single-arm version for Spring 2016 RHRS, called "phase_space_fall16".

January 26, 2017:

1) Made option to run events through Left HRS in all 4 phase-space versions.

February 20, 2017:

1) Added ionization energy loss option for outgoing particle in all 4 phase-space versions. Also added some additional variables to output file.

February 23, 2017:

1) Made ionization energy loss sample from cernlib landau distribution. Calculation of average energy loss for electrons (as done in Hall A Analyzer) is also included, but commented out.

March 14, 2017:

1) Put (x,y,z) components of missing momentum into lab coordinate system.

2) Calculated scattered phi angle to handle events that cross the beam axis.

March 15, 2017:

1) Added front are back apertures for collimator box. This change affects both spectrometers in the simc_gfortran (phase_space_hrs) and simc_sos (phase_space_sos) versions. It affects the left spectrometer in the simc_spring16 (phase_space_spring16) version.

December 17, 2017:

1) Added separate energy loss option for generated and reconstructed events in single-arm version.

December 20, 2017:

1) Made aperture-check radius for SOS Q1 equal to through-pipe radius for spring16 and fall16 versions.

February 16, 2018:

1) Set initial x_tar value to be at spectrometer z=0 plane.

-----------------------------------------------------

To do (may be extended if necessary...):

1) Merge all (or most) of the different versions (probably won't happen for awhile). 

2) Add some information about the changes made to the .hist file in the outfiles directory. Can also do this for the single-arm version.

3) Add probe rail to dipole.

------------------------------------------------------

Notes:

1) When calculating "geometrical" jacobian, comments are wrong but calculation is right. (i.e. cos(dtheta) should be inverted and dtheta is not theta - theta0.)

2) When a spectrometer is not used, the y_tar variable is set to zero. The other 3 spectrometer variables (delta, x', y') are set to approximately the generated values. Only these 3 variables need to be within the limits to add to the written-out resolution and accumulated weight (as well as to calculate physics variables like p_miss), so this is acceptable. But I guess at some point someone may want to do something similar for the y_tar variable to aid check the reconstruction of the reaction vertex...and maybe for other reasons.

3) In the single arm version, the comments say that +xbeam is right (looking downstream), but it is actually left.

4) I was initially a little confused about the following... For extended multiple scatters (in the detector hut), the "project" subroutine is called as well as the "musc_ext" routine. This is because the "musc_ext" routine only accounts for the effect of multiple scattering; it does not do the drift itself.

------------------------------------------------------

Some documents concerning above changes:

1) Schematics of HRS spectrometer:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Spring16/HRS_Schematics.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Spring16/Right_HRS_GMP_Sp16.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Fall16/Right&Left_HRS_GMP_Fa16.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/HRS/65410-E-17010-00.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/HRS/65120-13221-00RevG.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/HRS/65120-13225-00RevA.pdf

2) Target Material, etc. for GMp experiment:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Spring16/HRS_Material_Sp16.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Fall16/HRS_Material_Fall16.pdf

3) HRS sieve designs:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Technical_Drawings/

4) Table of locations (relative the the VDC) of detectors in HRS detector stack:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Detector_Info/HRS_Detector_Positions_Sp16.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Detector_Info/HRS_Detector_Positions_Fall16.pdf
	
5) Information on HRS detector materials, thickness, etc.:
     
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Detector_Info/HRS_Detector_Stack_Info.pdf

6) Calculation of reaction z position:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/SIMC/ReactZ_Calc.pdf

7) Information on Ionization energy loss corrections:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Ionization_eloss/Ionization_eloss.pdf
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/Ionization_eloss/Ionization_eloss_supplement.pdf

8) General documentation written by Reynier Cruz Torres:
	
     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/SIMC/simc_extra.pdf

9) Information on calculation of phi scattering angle:

     http://hallaweb.jlab.org/12GeV/experiment/E12-07-108/Publications/Technical/Spectrometer/SIMC/phi_angle_calc.pdf

------------------------------------------------------