Merge branch 'develop' into feature/acastill_deconvolution_database

Author: nathanielerowe

sbndcode/JobConfigurations/base/cafmakerjob_sbnd_data_base.fcl

@@ -125,8 +125,11 @@ physics:
 # change tools in sbn to have 2D TPC sim/sp input
 physics.producers.pandoraShowerRazzle.SimChannelLabel: "sptpc2d:gauss"
 physics.producers.pandoraTrackDazzle.SimChannelLabel: "sptpc2d:gauss"
-
 physics.producers.cnnid.WireLabel: "sptpc2d:gauss"
+# uncomment below lines to use DNN ROI SP for Razzle/Dazzle/CNNID
+#physics.producers.pandoraShowerRazzle.SimChannelLabel: "sptpc2d:dnnsp"
+#physics.producers.pandoraTrackDazzle.SimChannelLabel: "sptpc2d:dnnsp"
+#physics.producers.cnnid.WireLabel: "sptpc2d:dnnsp"
 
 ### Calorimetry for data
 physics.producers.cnnid.PointIdAlg.CalorimetryAlg: @local::sbnd_calorimetryalgdata

sbndcode/JobConfigurations/standard/caf/cafmakerjob_sbnd.fcl

@@ -127,6 +127,8 @@ physics:
 physics.producers.pandoraShowerRazzle.SimChannelLabel: "simtpc2d:simpleSC"
 physics.producers.pandoraTrackDazzle.SimChannelLabel: "simtpc2d:simpleSC"
 physics.producers.cnnid.WireLabel: "simtpc2d:gauss"
+# uncomment below line for to use DNN ROI SP for CNNID scores
+#physics.producers.cnnid.WireLabel: "simtpc2d:dnnsp"
 
 physics.producers.vertexCharge.CaloAlg: @local::sbnd_calorimetryalgmc
 physics.producers.vertexStub.CaloAlg: @local::sbnd_calorimetryalgmc

sbndcode/JobConfigurations/standard/reco/reco1_data.fcl

@@ -35,3 +35,12 @@ physics.ana: [superadata]
 outputs.out1.SelectEvents: [ "reco1" ]
 
 physics.producers.gaushit.CalDataModuleLabel: "sptpc2d:gauss"
+
+# uncomment below 4 lines to run DNN ROI finding SP
+#physics.producers.sptpc2d.wcls_main.outputers: ["wclsFrameSaver:spsaver" , "wclsFrameSaver:dnnsaver"]
+#physics.producers.sptpc2d.wcls_main.structs.use_dnnroi: true
+#physics.producers.sptpc2d.wcls_main.structs.nchunks: 2 # should match training config
+#physics.producers.sptpc2d.wcls_main.structs.tick_per_slice: 4 # should match training config
+
+# uncomment below line to run DNN ROI finding SP for reco
+#physics.producers.gaushit.CalDataModuleLabel: "sptpc2d:dnnsp"

sbndcode/JobConfigurations/standard/standard_detsim_sbnd.fcl

@@ -92,3 +92,9 @@ outputs:
                     ]
   }
 }
+
+# uncomment below 4 lines to run DNN ROI finding SP
+# physics.producers.simtpc2d.wcls_main.outputers: ["wclsDepoFluxWriter:postdrift", "wclsFrameSaver:spsaver", "wclsFrameSaver:dnnsaver"] # "wclsFrameSaver:simdigits" <- by default, do not save RawDigits. Uncomment this line to save RawDigits and set
+# physics.producers.simtpc2d.wcls_main.structs.use_dnnroi: true
+# physics.producers.simtpc2d.wcls_main.structs.nchunks: 2 # should match training config
+# physics.producers.simtpc2d.wcls_main.structs.tick_per_slice: 4 # should match training config

sbndcode/JobConfigurations/standard/standard_reco1_sbnd.fcl

@@ -35,3 +35,6 @@ physics.end_paths:      [ @sequence::physics.end_paths, ana ]
 #outputs table overrides
 outputs.out1.dataTier:       "reconstructed"
 outputs.out1.outputCommands:  [@sequence::outputs.out1.outputCommands, @sequence::sbnd_reco1_drops]
+
+# uncomment below line to run DNN ROI finding SP for reco -- must have run DNN ROI finding in detsim stage
+#physics.producers.gaushit.CalDataModuleLabel: "simtpc2d:dnnsp"

sbndcode/WireCell/cfg/pgrapher/experiment/sbnd/dnnroi.jsonnet

@@ -0,0 +1,112 @@
+// This produces a function to configure DNN-ROI for one APA given
+// anode and torch service (ts) objects.
+// 
+// The prefix is prepended to all internal node names if uniqueness
+// beyond anode ID is needed.  The output_scale allows for an ad-hoc
+// scaling of dnnroi output.  The U and W planes will go through
+// dnnroi while hte W plane will be shunted.  What comes out will be a
+// unified frame with frame tag "dnnspN" where "N" is the anode ID.
+
+local wc = import "wirecell.jsonnet";
+local pg = import "pgraph.jsonnet";
+
+
+function (anode, ts_p0, ts_p1, prefix="dnnroi", output_scale=1.0, nticks=3428, tick_per_slice=4, nchunks=1)
+    local apaid = anode.data.ident;
+    local prename = prefix + std.toString(apaid);
+    local intags = ['loose_lf%d'%apaid, 'mp2_roi%d'%apaid,
+                     'mp3_roi%d'%apaid];
+
+    local dnnroi_u = pg.pnode({
+        type: "DNNROIFinding",
+        name: prename+"u",
+        data: {
+            anode: wc.tn(anode),
+            plane: 0,
+            intags: intags,
+            decon_charge_tag: "decon_charge%d" %apaid,
+            outtag: "dnnsp%du"%apaid,
+            input_scale: 0.00025, // 1/4000
+            output_scale: output_scale,
+            forward: wc.tn(ts_p0),
+            tick_per_slice: tick_per_slice,
+            nticks: nticks,
+            nchunks: nchunks
+        }
+    }, nin=1, nout=1, uses=[ts_p0, anode]);
+    local dnnroi_v = pg.pnode({
+        type: "DNNROIFinding",
+        name: prename+"v",
+        data: {
+            anode: wc.tn(anode),
+            plane: 1,
+            intags: intags,
+            decon_charge_tag: "decon_charge%d" %apaid,
+            outtag: "dnnsp%dv"%apaid,
+            input_scale: 0.00025, // 1/4000
+            output_scale: output_scale,
+            forward: wc.tn(ts_p1),
+            tick_per_slice: tick_per_slice,
+            nticks: nticks,
+            nchunks: nchunks
+        }
+    }, nin=1, nout=1, uses=[ts_p1, anode]);
+    local dnnroi_w = pg.pnode({
+        type: "PlaneSelector",
+        name: prename+"w",
+        data: {
+            anode: wc.tn(anode),
+            plane: 2,
+            tags: ["gauss%d"%apaid],
+            tag_rules: [{
+                frame: {".*":"DNNROIFinding"},
+                trace: {["gauss%d"%apaid]:"dnnsp%dw"%apaid},
+            }],
+        }
+    }, nin=1, nout=1, uses=[anode]);
+
+    local dnnpipes = [dnnroi_u, dnnroi_v, dnnroi_w];
+    local dnnfanout = pg.pnode({
+        type: "FrameFanout",
+        name: prename,
+        data: {
+            multiplicity: 3
+        }
+    }, nin=1, nout=3);
+
+    local dnnfanin = pg.pnode({
+        type: "FrameFanin",
+        name: prename,
+        data: {
+            multiplicity: 3,
+            tag_rules: [{
+                frame: {".*": "dnnsp%d%s" % [apaid,plane]},
+                trace: {".*": "dnnsp%d%s" % [apaid,plane]},
+            } for plane in ["u", "v", "w"]]
+        },
+    }, nin=3, nout=1);
+
+    local retagger = pg.pnode({
+      type: "Retagger",
+      name: 'dnnroi%d' % apaid,
+      data: {
+        // Note: retagger keeps tag_rules an array to be like frame fanin/fanout.
+        tag_rules: [{
+          // Retagger also handles "frame" and "trace" like fanin/fanout
+          // merge separately all traces like gaussN to gauss.
+          frame: {
+            ".*": "dnnsp%d" % apaid
+          },
+          merge: {
+            ".*": "dnnsp%d" % apaid
+          },
+        }],
+      },
+    }, nin=1, nout=1);
+    
+    pg.intern(innodes=[dnnfanout],
+              outnodes=[retagger],
+              centernodes=dnnpipes+[dnnfanin],
+              edges=[pg.edge(dnnfanout, dnnpipes[ind], ind, 0) for ind in [0,1,2]] +
+              [pg.edge(dnnpipes[ind], dnnfanin, 0, ind) for ind in [0,1,2]] +
+              [pg.edge(dnnfanin, retagger, 0, 0)])

sbndcode/WireCell/cfg/pgrapher/experiment/sbnd/wcls-nf-sp-data.jsonnet

@@ -24,6 +24,11 @@
 local sigoutform = std.extVar('signal_output_form');  // eg "sparse" or "dense"
 local raw_input_label = std.extVar('raw_input_label');  // eg "daq"
 local use_paramresp = std.extVar('use_paramresp');  // eg "true" or "false"
+local use_dnnroi = std.extVar('use_dnnroi');
+local nchunks = std.extVar('nchunks');
+local tick_per_slice = std.extVar('tick_per_slice');
+local dnnroi_model_p0 = std.extVar('dnnroi_model_p0');
+local dnnroi_model_p1 = std.extVar('dnnroi_model_p1');
 
 local g = import 'pgraph.jsonnet';
 local f = import 'pgrapher/experiment/sbnd/funcs.jsonnet';
@@ -124,6 +129,22 @@ local wcls_output = {
       chanmaskmaps: ['bad'],
     },
   }, nin=1, nout=1, uses=[mega_anode]),
+
+  dnnsp_signals: g.pnode({
+    type: 'wclsFrameSaver',
+    name: 'dnnsaver',
+    data: {
+      anode: wc.tn(mega_anode),
+      digitize: false,  // true means save as RawDigit, else recob::Wire
+      frame_tags: ['dnnsp'],
+
+      // this may be needed to convert the decon charge [units:e-] to be consistent with the LArSoft default ?unit? e.g. decon charge * 0.005 --> "charge value" to GaussHitFinder
+      frame_scale: [0.02, 0.02, 0.02],
+      nticks: params.daq.nticks,
+
+      chanmaskmaps: ['dnnspbad'],
+    },
+  }, nin=1, nout=1, uses=[mega_anode]),
 };
 
 local base = import 'pgrapher/experiment/sbnd/chndb-base.jsonnet';
@@ -151,14 +172,85 @@ local nf_maker = import 'pgrapher/experiment/sbnd/nf-data.jsonnet'; //added Ewer
 local nf_pipes = [nf_maker(params, tools.anodes[n], chndb[n], n, name='nf%d' % n) for n in std.range(0, std.length(tools.anodes) - 1)];
 
 local sp_maker = import 'pgrapher/experiment/sbnd/sp.jsonnet';
-local sp = sp_maker(params, tools, { sparse: sigoutform == 'sparse' });
+local sp_override = if use_dnnroi then {
+    sparse: true,
+    use_roi_debug_mode: true,
+    save_negtive_charge: true, // TODO: no negative charge in gauss, default is false
+    use_multi_plane_protection: true,
+    mp_tick_resolution: 4,
+    tight_lf_tag: "",
+    // loose_lf_tag: "",
+    cleanup_roi_tag: "",
+    break_roi_loop1_tag: "",
+    break_roi_loop2_tag: "",
+    shrink_roi_tag: "",
+    extend_roi_tag: "",
+    // m_decon_charge_tag: "",
+} else {
+    sparse: true,
+};
+//local sp = sp_maker(params, tools, { sparse: sigoutform == 'sparse' });
+local sp = sp_maker(params, tools, sp_override);
 local sp_pipes = [sp.make_sigproc(a) for a in tools.anodes];
+local dnnroi = import 'dnnroi.jsonnet';
+local ts_p0 = {
+    type: "TorchService",
+    name: "dnnroi_p0",
+    tick_per_slice: tick_per_slice, 
+    data: {
+        model: dnnroi_model_p0,
+        device: "cpu",
+        concurrency: 1,
+    },
+};
+
+local ts_p1 = {
+    type: "TorchService",
+    name: "dnnroi_p1",
+    tick_per_slice: tick_per_slice, 
+    data: {
+        model: dnnroi_model_p1,
+        device: "cpu",
+        concurrency: 1,
+    },
+};
 
 local magoutput = 'sbnd-data-check.root';
 local magnify = import 'pgrapher/experiment/sbnd/magnify-sinks.jsonnet';
 local sinks = magnify(tools, magoutput);
 
-local nfsp_pipes = [
+local fanout = function (name, multiplicity=2)
+  g.pnode({
+    type: 'FrameFanout',
+    name: name,
+    data: {
+        multiplicity: multiplicity
+    },
+  }, nin=1, nout=multiplicity);
+
+local sp_fans = [fanout("sp_fan_%d" % n) for n in std.range(0, std.length(tools.anodes) - 1)];
+local dnnroi_pipes = [ dnnroi(tools.anodes[n], ts_p0, ts_p1, output_scale=1, nchunks=nchunks) for n in std.range(0, std.length(tools.anodes) - 1) ];
+local nfsp_pipes = if use_dnnroi then 
+[
+  g.intern(
+    innodes=[chsel_pipes[n]],
+    outnodes=[dnnroi_pipes[n],sinks.decon_pipe[n]],
+    centernodes=[nf_pipes[n], sp_pipes[n], sp_fans[n], sinks.decon_pipe[n]],
+    edges=[
+      g.edge(chsel_pipes[n], nf_pipes[n], 0, 0),
+      g.edge(nf_pipes[n], sp_pipes[n], 0, 0),
+      g.edge(sp_pipes[n], sp_fans[n], 0, 0),
+      g.edge(sp_fans[n], dnnroi_pipes[n], 0, 0),
+      g.edge(sp_fans[n], sinks.decon_pipe[n], 1, 0),
+    ],
+    iports=chsel_pipes[n].iports,
+    oports=dnnroi_pipes[n].oports+sinks.decon_pipe[n].oports,
+    name='nfsp_pipe_%d' % n,
+  )
+  for n in std.range(0, std.length(tools.anodes) - 1)
+]
+else
+[
   g.pipeline([
                chsel_pipes[n],
                //sinks.orig_pipe[n],
@@ -177,8 +269,9 @@ local nfsp_pipes = [
 
 local fanpipe = f.fanpipe('FrameFanout', nfsp_pipes, 'FrameFanin', 'sn_mag_nf');
 
-local retagger = g.pnode({
+local retagger = function(name) g.pnode({
   type: 'Retagger',
+  name: name,
   data: {
     // Note: retagger keeps tag_rules an array to be like frame fanin/fanout.
     tag_rules: [{
@@ -190,16 +283,89 @@ local retagger = g.pnode({
       merge: {
         'gauss\\d': 'gauss',
         'wiener\\d': 'wiener',
+        'dnnsp\\d': 'dnnsp',
       },
     }],
   },
 }, nin=1, nout=1);
 
-local sink = g.pnode({ type: 'DumpFrames' }, nin=1, nout=0);
+local retag_dnnroi = retagger("retag_dnnroi");
+local retag_sp = retagger("retag_sp");
 
 
-// local graph = g.pipeline([wcls_input.adc_digits, rootfile_creation_frames, fanpipe, retagger, wcls_output.sp_signals, sink]);
-local graph = g.pipeline([wcls_input.adc_digits, fanpipe, retagger, wcls_output.sp_signals, sink]);
+local sink = function(name) g.pnode({ type: 'DumpFrames', name: name }, nin=1, nout=0);
+local sink_dnnroi = sink("sink_dnnroi");
+local sink_sp = sink("sink_sp");
+
+local fanout_apa = g.pnode({
+    type: 'FrameFanout',
+    name: 'fanout_apa',
+    data: {
+        multiplicity: std.length(tools.anodes),
+        "tag_rules": [
+            {
+               "frame": {
+                  ".*": "orig%d" % n
+               },
+               "trace": { }
+            }
+            for n in std.range(0, std.length(tools.anodes) - 1)
+        ]
+        }},
+    nin=1, nout=std.length(tools.anodes));
+local framefanin = function(name) g.pnode({
+    type: 'FrameFanin', 
+    name: name,
+    data: {
+        multiplicity: std.length(tools.anodes),
+
+         "tag_rules": [
+            {     
+                "frame": {
+                  ".*": "framefanin"
+                },
+                trace: {
+                  ['dnnsp%d' % n]: ['dnnsp%d' % n],
+                  ['gauss%d' % n]: ['gauss%d' % n],
+                  ['wiener%d' % n]: ['wiener%d' % n],
+                  ['threshold%d' % n]: ['threshold%d' % n],
+                },
+            }
+            for n in std.range(0, std.length(tools.anodes) - 1)
+         ],    
+         "tags": [ ]
+    },
+}, nin=std.length(tools.anodes), nout=1);
+local fanin_apa_dnnroi = framefanin('fanin_apa_dnnroi');
+local fanin_apa_sp = framefanin('fanin_apa_sp');
+
+local graph = if use_dnnroi then
+ g.intern(
+  innodes=[wcls_input.adc_digits],
+  outnodes=[],
+  centernodes=nfsp_pipes+[fanout_apa, retag_dnnroi, retag_sp, fanin_apa_dnnroi, fanin_apa_sp, wcls_output.sp_signals, wcls_output.dnnsp_signals, sink_dnnroi, sink_sp],
+  edges=[
+    g.edge(wcls_input.adc_digits, fanout_apa, 0, 0),
+    g.edge(fanout_apa, nfsp_pipes[0], 0, 0),
+    g.edge(fanout_apa, nfsp_pipes[1], 1, 0),
+    g.edge(nfsp_pipes[0], fanin_apa_dnnroi, 0, 0),
+    g.edge(nfsp_pipes[1], fanin_apa_dnnroi, 0, 1),
+    g.edge(fanin_apa_dnnroi, retag_dnnroi, 0, 0),
+    g.edge(retag_dnnroi, wcls_output.dnnsp_signals, 0, 0),
+    g.edge(wcls_output.dnnsp_signals, sink_dnnroi, 0, 0),
+    g.edge(nfsp_pipes[0], fanin_apa_sp, 1, 0),
+    g.edge(nfsp_pipes[1], fanin_apa_sp, 1, 1),
+    g.edge(fanin_apa_sp, retag_sp, 0, 0),
+    g.edge(retag_sp, wcls_output.sp_signals, 0, 0),
+    g.edge(wcls_output.sp_signals, sink_sp, 0, 0),
+  ]
+)
+else
+g.pipeline([wcls_input.adc_digits, 
+fanpipe, 
+retag_sp, 
+wcls_output.sp_signals, 
+sink_sp]);
 
 local app = {
   type: 'TbbFlow',
@@ -210,3 +376,4 @@ local app = {
 
 // Finally, the configuration sequence
 g.uses(graph) + [app]
+