Add nested tube array geometry (optical fibers)

doc/users_guide/data_structure.rst

@@ -13,7 +13,7 @@ The Ratpac data structure is defined in the `src/ds` directory and lists
 everything under the `RAT::DS` namespace. An instance of the data structure is
 defined in the `RAT::DS::Root` object. The data structure is tree-like, with each
 instance of `RAT::DS::Root` containing a list of `RAT::DS::MC` objects which contain
-the Monte Carl truth infomration, and a list of `RAT::DS::EV` objects which contain
+the Monte Carl truth information, and a list of `RAT::DS::EV` objects which contain
 the reconstructed event information (usually after going through a processor that
 simulates the detector response).
 

doc/users_guide/database.rst

@@ -63,7 +63,7 @@ Normally, tables and fields are all you have to think about, but RATDB also
 addresses an additional complication: overriding constants.  It is a common use
 case to have default values of constants, values which are only valid in
 certain time intervals and can change (like the optical properties of the
-scintilator), and user-specified values which are intended to override
+scintillator), and user-specified values which are intended to override
 everything.
 
 RATDB handles this by internally grouping tables into three ''planes''.  The
@@ -79,7 +79,7 @@ When an item is requested, RATDB will attempt to locate it in the user plane
 first, then the time plane, and finally the default plane.  Note that this is
 all handled in the background.  You simply request the index_of_refraction
 field in the MEDIA[acrylic] table, and RATDB figures out the appropriate plane
-from which to retreive the data.
+from which to retrieve the data.
 
 How do I load data into RATDB?
 ``````````````````````````````

doc/users_guide/geometry.rst

@@ -80,6 +80,7 @@ Allowed types:
  * tubearray - Array of tubes
  * lgarray - Array of tubes where one end has the PMT face cut out 
  * pmtarray - Array of PMTs
+ * nestedtubearray - Array of three nested tubes. Useful to simulate optical fibers
  * waterboxarray - Array of standard cubitainer water boxes
  * extpolyarray - Array of extruded polygonal solids
  * bubble - Collection of bubbles
@@ -147,6 +148,28 @@ PMTArray Fields:
 ``rescale_radius``      ``float`` (optional)        Assumes all PMTs are spherically arranged around the center of the mother volume and rescales their positions to a particular radius.  By default, no rescaling is done.
 ======================  ==========================  ===================
 
+NestedTubeArray Fields:
+
+======================  ==========================  ===================
+**Field**               **Type**                    **Description**
+======================  ==========================  ===================
+``pos_table``           ``string``                  Specifies the table containing position (and direction) arrays specifying how to place PMTs
+``core_r``           ``float``                  The radius of the core tube (mm)
+``inner_r``           ``float``                  The radius of the inner tube (mm)
+``outer_r``           ``float``                  The radius of the outer tube (mm)
+``material_core``           ``string``                  The material of the core tube
+``material_inner``           ``string``                  The material of the inner tube
+``material_outer``           ``string``                  The material of the outer tube
+``Dz``              ``float``                   Half-height of tube (mm)
+``phi_start``           ``float`` (optional)        Angle (deg) where tube segment starts.  Default is 0.0
+``phi_delta``           ``float`` (optional)        Angle span (deg) of tube segment.  Default is 360.0
+``start_idx``           ``int`` (optional)          Index to start building nested tubes in the ``NESTEDTUBEINFO`` table specified (inclusive, defaults to 0)
+``end_idx``             ``int`` (optional)          Index to stop building nested tubes in the ``NESTEDTUBEINFO`` table specified (inclusive, defaults to length-1)
+``orientation``         ``string``                  Method of determining nested tube direction.  "point" will aim all nested tubes at a point in space.  "manual" requires that the position table also contain dir_x, dir_y, and dir_z fields which define the direction vector for each PMT.
+``orient_point``        ``float[3]`` (optional)     Point (mm) in mother volume to aim all tubes toward.
+``rescale_radius``      ``float`` (optional)        Assumes all tubes are spherically arranged around the center of the mother volume and rescales their positions to a particular radius.  By default, no rescaling is done.
+======================  ==========================  ===================
+
 Creating a parameterized geometry
 `````````````````````````````````
 Using a ``DetectorFactory`` one can build a DB defined geometry on the fly

doc/users_guide/processes.rst

@@ -128,7 +128,7 @@ below.
 Wavelength Shifting
 ```````````````````
 There are a few ways of doing bulk wavelength shifting in RAT. The default
-behavior is for GLG4Scint to handle opticalphotons as well as charged
+behavior is for GLG4Scint to handle optical photons as well as charged
 particles. Alternatively, you can also let GLG4Scint handle the primary
 scintillation, then use Geant4's G4OpWLS process or the custom BNLOpWLSModel
 to do the reemission.

macros/vis_nestedTubeArrays.mac

@@ -0,0 +1,53 @@
+/glg4debug/glg4param omit_muon_processes  0.0
+/glg4debug/glg4param omit_hadronic_processes  0.0
+
+
+#set the detector parameters
+/rat/db/set DETECTOR experiment "Validation"
+/rat/db/set DETECTOR geo_file "Validation/NestedTubeArray.geo"
+
+# Colors
+/rat/db/set GEO[world] invisible 1
+/rat/db/set GEO[outer_vessel] invisible 1
+/rat/db/set GEO[outer_tank] invisible 1
+#/rat/db/set GEO[outer_vessel] color [0.1,0.1,0.6,0.95]
+#/rat/db/set GEO[outer_tank] color [0.42,0.47,0.57,0.3]
+#/rat/db/set GEO[fiber_1_inner] color [0.0,0.8,0.0,0.10]
+
+/run/initialize
+
+/tracking/storeTrajectory 1
+
+##### Visualization ##########################
+
+/vis/open OGLSQt
+/vis/scene/create
+/vis/scene/add/trajectories rich smooth
+/tracking/storeTrajectory 1
+/tracking/FillPointCont 1
+/vis/scene/add/volume
+/vis/scene/add/hits
+/vis/sceneHandler/attach
+/vis/viewer/set/upVector 0.0 0.0 1.0
+/vis/viewer/set/viewpointThetaPhi -90 135 
+/vis/viewer/set/style s
+/vis/viewer/flush
+
+/rat/proc count
+/rat/procset update 10
+
+
+#add ntuple tracking
+/rat/proc outntuple
+/rat/procset include_tracking 1
+/rat/procset include_mcparticles 1
+/rat/procset include_pmthits 1
+/rat/procset include_untriggered_events 1
+/rat/physics/setOpWLS g4
+##### GENERATORS #################
+/generator/add combo pbomb:point:poisson
+/generator/vtx/set 10 430 # 10000 photons, 430nm
+/generator/pos/set 0.0 0.0 0.0
+
+##### RUN ###########
+/run/beamOn 1

ratdb/Validation/NestedTubeArray.geo

@@ -0,0 +1,170 @@
+{
+  name: "GEO",
+  index: "world",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "",
+  type: "box",
+  size: [20000.0,20000.0,20000.0],
+  material: "mirror",
+}
+
+{
+  name: "GEO",
+  index: "outer_vessel",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "world",
+  type: "box",
+  size: [10.0,10.0,10.0],
+  position: [0.0, 0.0, 0.0],
+  rotation: [0.0, 0.0, 0.0],
+  material: "aluminum",
+  color: [0.02,0.2,0.2,0.03],
+}
+
+{
+  name: "GEO",
+  index: "outer_tank",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "outer_vessel",
+  type: "box",
+  size: [9.0,9.0,9.0],
+  position: [0.0, 0.0, 0.0],
+  rotation: [0.0, 0.0, 0.0],
+  material: "mirror",
+  #color: [0.02,0.2,0.2,0.1],
+}
+
+// here we place nested tubes manually
+{
+  name: "GEO",
+  index: "fiber_0_outer",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "outer_tank",
+  type: "tube",
+  r_max: 0.5,
+  size_z: 49.5,
+  position: [-5.0, 0.0, -5.0],
+  rotation: [-90.0, 0.0, 0.0],
+  material: "aluminum",
+  color: [0.0,0.8,0.0,0.01],
+}
+
+{
+  name: "GEO",
+  index: "fiber_0_inner",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "fiber_0_outer",
+  type: "tube",
+  r_max: 0.485,
+  size_z: 49.5,
+  position: [0.0, 0.0, 0.0],
+  rotation: [0.0, 0.0, 0.0],
+  material: "glass",
+  color: [0.0,0.8,0.0,0.05],
+}
+
+{
+  name: "GEO",
+  index: "fiber_0_core",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "fiber_0_inner",
+  type: "tube",
+  r_max: 0.47,
+  size_z: 49.5,
+  position: [0.0, 0.0, 0.0],
+  rotation: [0.0, 0.0, 0.0],
+  material: "mirror",
+  color: [0.0,0.8,0.0,0.1],
+}
+{
+  name: "GEO",
+  index: "fiber_1_outer",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "outer_tank",
+  type: "tube",
+  r_max: 0.5,
+  size_z: 29.5,
+  position: [-5.0, 0.0, 5.0],
+  rotation: [-90.0, 0.0, 0.0],
+  material: "aluminum",
+  color: [0.0,0.8,0.0,0.01],
+}
+
+{
+  name: "GEO",
+  index: "fiber_1_inner",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "fiber_1_outer",
+  type: "tube",
+  r_max: 0.485,
+  size_z: 29.5,
+  position: [0.0, 0.0, 0.0],
+  rotation: [0.0, 0.0, 0.0],
+  material: "glass",
+  color: [0.0,0.8,0.0,0.05],
+}
+
+{
+  name: "GEO",
+  index: "fiber_1_core",
+  valid_begin: [0, 0],
+  valid_end: [0, 0],
+  mother: "fiber_1_inner",
+  type: "tube",
+  r_max: 0.47,
+  size_z: 29.5,
+  position: [0.0, 0.0, 0.0],
+  rotation: [0.0, 0.0, 0.0],
+  material: "mirror",
+  color: [0.0,0.8,0.0,0.1],
+}
+// manual nested tubes ends here
+
+// this table is the information
+// about where to place the nested tubes
+// in the array
+{
+name: "cable_pos",
+valid_begin: [0],
+valid_end: [0],
+x: [5, 5]
+y: [0, 0],
+z: [5, -5],
+dir_x: [0, 0],
+dir_y: [1, 1],
+dir_z: [0, 0],
+Dz: [49.5, 29.5]
+}
+
+// this is the definition of the
+// nested tube 'properties'
+// note that we reference the pos_table
+// by name, also the pos_table
+// doesn't have to be in the .geo file
+{
+name: "GEO",
+index: "fibers",
+enable: 1,
+valid_begin: [0, 0],
+valid_end: [0, 0],
+mother: "outer_tank",
+type: "nestedtubearray",
+core_r: 0.47,
+inner_r: 0.485,
+outer_r: 0.5,
+pos_table: "cable_pos",
+orientation: "manual",
+material_outer: "aluminum",
+material_inner: "glass",
+material_core: "mirror",
+#drawstyle: "solid",
+color: [0.8,0.0,0.0,0.8]
+}

src/core/include/RAT/Gsim.hh

@@ -10,6 +10,7 @@
 #include <G4UserRunAction.hh>
 #include <G4UserTrackingAction.hh>
 #include <RAT/DS/PMTInfo.hh>
+#include <RAT/DS/NestedTubeInfo.hh>
 #include <RAT/DS/Root.hh>
 #include <RAT/DS/Run.hh>
 #include <RAT/EventInfo.hh>
@@ -86,6 +87,8 @@ class Gsim : public Producer, G4UserRunAction, G4UserEventAction, G4UserTracking
   std::vector<RAT::PMTTime *> fPMTTime;      //< PMT transit time/delay calculator (indexed by modeltype)
   std::vector<RAT::PMTCharge *> fPMTCharge;  //< PMT single-pe charge calculator (indexed by modeltype)
 
+  RAT::DS::NestedTubeInfo *fNestedTubeInfo;
+
   RAT::DS::Run *run;
   int runID;
   TTimeStamp utc;

src/core/src/Gsim.cc

@@ -30,6 +30,7 @@
 #include <RAT/PDFPMTCharge.hh>
 #include <RAT/PDFPMTTime.hh>
 #include <RAT/PMTFactoryBase.hh>
+#include <RAT/GeoNestedSolidArrayFactoryBase.hh>
 #include <RAT/PhysicsList.hh>
 #include <RAT/PrimaryVertexInformation.hh>
 #include <RAT/ProcBlock.hh>
@@ -179,6 +180,7 @@ void Gsim::BeginOfRunAction(const G4Run * /*aRun*/) {
 
   run = DS::RunStore::GetRun(runID);
   fPMTInfo = run->GetPMTInfo();
+  fNestedTubeInfo = run->GetNestedTubeInfo();
 
   for (size_t i = 0; i < fPMTTime.size(); i++) {
     delete fPMTTime[i];
@@ -421,6 +423,7 @@ void Gsim::MakeRun(int _runID) {
   run->SetType((unsigned)lrun->GetI("runtype"));
   run->SetStartTime(utc);
   run->SetPMTInfo(&PMTFactoryBase::GetPMTInfo());
+  run->SetNestedTubeInfo(&GeoNestedSolidArrayFactoryBase::GetNestedTubeInfo());
 
   DS::RunStore::AddNewRun(run);
 }

src/ds/CMakeLists.txt

@@ -37,6 +37,7 @@ root_generate_dictionary(G__RATDict
         RAT/DS/RunStore.hh
         RAT/DS/Run.hh
         RAT/DS/PMTInfo.hh
+        RAT/DS/NestedTubeInfo.hh
         RAT/DS/MCTrack.hh
         RAT/DS/MCTrackStep.hh
         RAT/DS/Calib.hh

src/ds/include/RAT/DS/LinkDef.hh

@@ -2,6 +2,7 @@
 
 #pragma link C++ class RAT::DS::Root + ;
 #pragma link C++ class RAT::DS::PMTInfo + ;
+#pragma link C++ class RAT::DS::NestedTubeInfo + ;
 
 #pragma link C++ class RAT::DS::MC + ;
 #pragma link C++ class RAT::DS::MCParticle + ;