From 16344a303ea4b489ad4a551457a54ce6cadf1796 Mon Sep 17 00:00:00 2001 From: Sarah Gaiser Date: Tue, 18 Apr 2023 16:33:22 -0700 Subject: [PATCH 1/8] modified gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 254e982cd0..a3b9e65387 100644 --- a/.gitignore +++ b/.gitignore @@ -41,6 +41,8 @@ deps.txt scratch/ bin/ target/ +html/ +latex/ # editor swap files From a8fa8ad1a3e7533d339f33cbe4fbab79ed39e3c3 Mon Sep 17 00:00:00 2001 From: sgaiser Date: Fri, 2 Dec 2022 17:02:14 -0800 Subject: [PATCH 2/8] add tanLambda cuts --- .../hps/recon/tracking/gbl/GBLOutputDriver.java | 17 ++++++++++++++++- .../tracking/gbl/SimpleGBLTrajAliDriver.java | 13 +++++++++---- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java b/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java index 55715becfa..f11dd44d80 100644 --- a/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java +++ b/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java @@ -80,6 +80,9 @@ public class GBLOutputDriver extends Driver { private double minPhi = -999.9; private double maxPhi = 999.9; + + private double minTanL = 0.015; + private double maxTanL = 999.9; private int nHits = 6; @@ -108,6 +111,15 @@ public void setMaxPhi (double val) { maxPhi = val; } + public void setMinTanL (double val) { + minTanL = val; + } + + public void setMaxTanL (double val) { + maxTanL = val; + } + + //Override the Z of the target. public void setBsZ (double input) { bsZ = input; @@ -227,7 +239,10 @@ public void process(EventHeader event) { //System.out.println("Track passed momentum"); TrackState trackState = trk.getTrackStates().get(0); - if (Math.abs(trackState.getTanLambda()) < 0.015) + if (Math.abs(trackState.getTanLambda()) < minTanL) + continue; + + if (Math.abs(trackState.getTanLambda()) > maxTanL) continue; if (Math.abs(trackState.getPhi()) < minPhi) diff --git a/tracking/src/main/java/org/hps/recon/tracking/gbl/SimpleGBLTrajAliDriver.java b/tracking/src/main/java/org/hps/recon/tracking/gbl/SimpleGBLTrajAliDriver.java index 33097a66db..fe79b625bf 100644 --- a/tracking/src/main/java/org/hps/recon/tracking/gbl/SimpleGBLTrajAliDriver.java +++ b/tracking/src/main/java/org/hps/recon/tracking/gbl/SimpleGBLTrajAliDriver.java @@ -148,7 +148,8 @@ public class SimpleGBLTrajAliDriver extends Driver { private double momC = 4.55; private double minMom = -999; private double maxMom = 999; - private double maxtanL = -999; + private double minTanL = 0; + private double maxTanL = 999.9; private double minPhi = -999; private double maxPhi = 999; private int nHitsCut = 4; @@ -353,8 +354,12 @@ public void setMinMom(double val) { minMom = val; } - public void setMaxtanL(double val) { - maxtanL = val; + public void setMaxTanL(double val) { + maxTanL = val; + } + + public void setMinTanL(double val) { + minTanL = val; } public void setMinPhi(double val) { @@ -564,7 +569,7 @@ protected void process(EventHeader event) { continue; } - if (Math.abs(tanLambda) < maxtanL) { + if (Math.abs(tanLambda) < minTanL || Math.abs(tanLambda) > maxTanL) { continue; } From 24ae08b7a08244b3c22b4efdb0ef2e68678e5df0 Mon Sep 17 00:00:00 2001 From: Sarah Gaiser Date: Wed, 22 Mar 2023 15:16:41 -0700 Subject: [PATCH 3/8] formatting --- .../recon/tracking/gbl/GBLOutputDriver.java | 518 +++++++++--------- 1 file changed, 244 insertions(+), 274 deletions(-) diff --git a/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java b/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java index f11dd44d80..19380e4da2 100644 --- a/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java +++ b/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java @@ -45,12 +45,14 @@ * Make post-GBL plots needed for alignment. */ public class GBLOutputDriver extends Driver { + + public static Logger LOGGER = Logger.getLogger(GBLOutputDriver.class.getName()); private AIDA aidaGBL; // era public private String outputPlots = "GBLplots_ali.root"; private String trackCollectionName = "GBLTracks"; private String trackResidualsRelColName = "TrackResidualsGBLRelations"; - private String dataRelationCollection = GBLKinkData.DATA_RELATION_COLLECTION; + private String dataRelationCollection = GBLKinkData.DATA_RELATION_COLLECTION; // not used later on? private List sensors = new ArrayList(); private double bfield; public boolean debug = false; @@ -58,21 +60,21 @@ public class GBLOutputDriver extends Driver { String kinkFolder = "/gbl_kinks/"; String epullFolder = "/err_pulls/"; String trkpFolder = "/trk_params/"; - String trkpDetailFolder="/trk_detail/"; - String resFolder="/res/"; - String hitFolder="/hit/"; + String trkpDetailFolder = "/trk_detail/"; + String resFolder = "/res/"; + String hitFolder = "/hit/"; private boolean b_doGBLkinks = true; private boolean b_doGBLresiduals = true; private boolean b_doDetailPlots = false; - //This should be moved to the GBL Refitter!!! - //The field map for extrapolation + // This should be moved to the GBL Refitter!!! + // The field map for extrapolation private FieldMap bFieldMap; - //The location of the extrapolation + // The location of the extrapolation private double bsZ = 0.; - //Spacing between top and bottom in the 2D histos + // Spacing between top and bottom in the 2D histos private int mod = 5; private double minMom = 1.; @@ -146,7 +148,7 @@ public void setOutputPlotsFilename(String fname) { } public void setTrackCollectionName(String val) { - trackCollectionName=val; + trackCollectionName = val; } @@ -162,8 +164,7 @@ protected void detectorChanged(Detector detector) { sensors.add(s); } } - - + Hep3Vector fieldInTracker = TrackUtils.getBField(detector); this.bfield = Math.abs(fieldInTracker.y()); @@ -182,15 +183,16 @@ public void process(EventHeader event) { System.out.print(trk.getTrackerHits().size()+" "); } System.out.println(); - */ + */ + // Determine track type: GBL or Kalman int TrackType = 0; if (trackCollectionName.contains("Kalman") || trackCollectionName.contains("KF")) { TrackType = 1; - //System.out.println("PF:: DEBUG :: Found Kalman Tracks in the event"); + LOGGER.info("PF: Found Kalman Tracks in the event"); } - //System.out.println("Running on "+trackCollectionName); + LOGGER.info("Running on " + trackCollectionName); //RelationalTable trackMatchTable = null; //trackMatchTable = new BaseRelationalTable(RelationalTable.Mode.ONE_TO_ONE, RelationalTable.Weighting.UNWEIGHTED); @@ -205,28 +207,22 @@ public void process(EventHeader event) { RelationalTable hitToRotated = TrackUtils.getHitToRotatedTable(event); for (Track trk : tracks) { - - //Some Track selection - - //System.out.println("Track loop"); - + // Some Track selection + + // Remove tracks with chi2 > chi2Cut if (trk.getChi2() > chi2Cut) continue; - - //System.out.println("Track passed chi2"); + LOGGER.info("Track passed chi2"); - //Remove tracks with less than 10 hits + // Remove tracks with less than 10 hits if ((TrackType == 0 && trk.getTrackerHits().size() < nHits) || (TrackType == 1 && trk.getTrackerHits().size() < 2*nHits)) { - System.out.println("WARNING:: "+trk.getClass().getSimpleName() - +" got to GBLOutputDriver with "+trk.getTrackerHits().size()+" hits" - +" which is below the cut that should have been already applied."); + LOGGER.warning(trk.getClass().getSimpleName() + " got to GBLOutputDriver with " + trk.getTrackerHits().size() + " hits" + + " which is below the cut that should have been already applied."); continue; } - - - //System.out.println("Track passed hits"); + LOGGER.info("Track passed nHits"); Hep3Vector momentum = new BasicHep3Vector(trk.getTrackStates().get(0).getMomentum()); @@ -236,7 +232,7 @@ public void process(EventHeader event) { if (momentum.magnitude() > maxMom) continue; - //System.out.println("Track passed momentum"); + LOGGER.info("Track passed momentum"); TrackState trackState = trk.getTrackStates().get(0); if (Math.abs(trackState.getTanLambda()) < minTanL) @@ -245,26 +241,26 @@ public void process(EventHeader event) { if (Math.abs(trackState.getTanLambda()) > maxTanL) continue; + LOGGER.info("Track passed tanLambda"); + if (Math.abs(trackState.getPhi()) < minPhi) continue; if (Math.abs(trackState.getPhi()) > maxPhi) continue; - //System.out.println("Track passed tanLambda"); + LOGGER.info("Track passed phi"); GenericObject gblKink = GBLKinkData.getKinkData(event, trk); - //if (gblKink == null) { - //System.out.println("Failed finding gblKink object"); - //System.out.println("Looked for: "+GBLKinkData.DATA_RELATION_COLLECTION); - //System.out.println("Event has "+GBLKinkData.DATA_RELATION_COLLECTION+" "+event.hasCollection(LCRelation.class, GBLKinkData.DATA_RELATION_COLLECTION)); - //} - - + // if (gblKink == null) { + // System.out.println("Failed finding gblKink object"); + // System.out.println("Looked for: "+GBLKinkData.DATA_RELATION_COLLECTION); + // System.out.println("Event has "+GBLKinkData.DATA_RELATION_COLLECTION+" "+event.hasCollection(LCRelation.class, GBLKinkData.DATA_RELATION_COLLECTION)); + // } - //Track matchedTrack = (Track) trackMatchTable.from(trk); + // Track matchedTrack = (Track) trackMatchTable.from(trk); Map sensorHits = new HashMap(); Map sensorNums = new HashMap(); List hitsOnTrack = new ArrayList(); @@ -278,33 +274,29 @@ public void process(EventHeader event) { if (sensor != null) { sensorHits.put(sensor, hit); sensorNums.put(sensor, i); - if (debug) - System.out.printf("adding sensor %d \n", i); + LOGGER.info("Adding sensor " + i + "\n"); } if (debug && sensor == null) - System.out.printf("TrackerHit null sensor %s \n", hit.toString()); + LOGGER.info("TrackerHit null sensor " + hit.toString() + "\n"); + i++; - } - //THIS IS TEMPORARY AND NEEDED FOR FIXING THE LOOP ON THE SENSORS ON TRACK FOR KALMAN TRACKS - if (hitsOnTrack.size() == 0) { for (TrackerHit hit : trk.getTrackerHits()) { HpsSiSensor sensor = ((HpsSiSensor) ((RawTrackerHit) hit.getRawHits().get(0)).getDetectorElement()); if (sensor != null) { sensorHits.put(sensor, hit); sensorNums.put(sensor, i); - if (debug) - System.out.printf("adding sensor %d \n", i); + LOGGER.info("Adding sensor " + i + " \n"); } if (debug && sensor == null) - System.out.printf("TrackerHit null sensor %s \n", hit.toString()); - i++; - + LOGGER.info("TrackerHit null sensor " + hit.toString() + " \n"); + + i++; } } @@ -313,7 +305,7 @@ public void process(EventHeader event) { if (b_doGBLresiduals) doGBLresiduals(trk, sensorHits,event); - //doMTresiduals(matchedTrack, sensorHits); + // doMTresiduals(matchedTrack, sensorHits); if (b_doGBLkinks) doGBLkinks(trk,gblKink, sensorNums); } @@ -322,12 +314,12 @@ public void process(EventHeader event) { private void doGBLkinks(Track trk, GenericObject kink, Map sensorNums) { if (kink == null) { - System.out.println("WARNING::Kink object is null"); + LOGGER.warning("Kink object is null"); return; } - String vol = "_top"; + String vol = "_top"; // unused variable int spacing = 0; if (trk.getTrackStates().get(0).getTanLambda() < 0) { vol = "_bottom"; @@ -339,18 +331,18 @@ private void doGBLkinks(Track trk, GenericObject kink, Map double phi = kink.getDoubleVal(index); float lambda = kink.getFloatVal(index); - //(2019) For top 0-20, for bottom 25-45 - aidaGBL.histogram2D(kinkFolder+"lambda_kink_mod").fill(sensor.getMillepedeId()+spacing,lambda); - aidaGBL.profile1D(kinkFolder+"lambda_kink_mod_p").fill(sensor.getMillepedeId()+spacing,lambda); - aidaGBL.histogram2D(kinkFolder+"phi_kink_mod").fill(sensor.getMillepedeId()+spacing,phi); - aidaGBL.profile1D(kinkFolder+"phi_kink_mod_p").fill(sensor.getMillepedeId()+spacing,phi); + // (2019) For top 0-20, for bottom 25-45 + aidaGBL.histogram2D(kinkFolder+"lambda_kink_mod").fill(sensor.getMillepedeId() + spacing,lambda); + aidaGBL.profile1D(kinkFolder+"lambda_kink_mod_p").fill(sensor.getMillepedeId() + spacing,lambda); + aidaGBL.histogram2D(kinkFolder+"phi_kink_mod").fill(sensor.getMillepedeId() + spacing,phi); + aidaGBL.profile1D(kinkFolder+"phi_kink_mod_p").fill(sensor.getMillepedeId() + spacing,phi); aidaGBL.histogram1D(kinkFolder+"lambda_kink_" + sensor.getName()).fill(lambda); aidaGBL.histogram1D(kinkFolder+"phi_kink_" + sensor.getName()).fill(phi); } } - private void doMTresiduals(Track trk, Map sensorHits) { + private void doMTresiduals(Track trk, Map sensorHits) { // currently not used TrackState trackState = trk.getTrackStates().get(0); for (HpsSiSensor sensor : sensorHits.keySet()) { Hep3Vector extrapPos = TrackStateUtils.getLocationAtSensor(trackState, sensor, bfield); @@ -358,32 +350,29 @@ private void doMTresiduals(Track trk, Map sensorHits) { if (hitPos == null || extrapPos == null) return; Hep3Vector diff = VecOp.sub(extrapPos, hitPos); - if (debug) - System.out.printf("MextrapPos %s MhitPos %s \n Mdiff %s ", extrapPos.toString(), hitPos.toString(), diff.toString()); + LOGGER.info("MextrapPos " + extrapPos.toString() + " MhitPos " + hitPos.toString() + " \n Mdiff " + diff.toString()); ITransform3D trans = sensor.getGeometry().getGlobalToLocal(); trans.rotate(diff); - aidaGBL.histogram1D(resFolder+"residual_before_GBL_" + sensor.getName()).fill(diff.x()); - if (debug) - System.out.printf("MdiffSensor %s \n", diff.toString()); - + aidaGBL.histogram1D(resFolder + "residual_before_GBL_" + sensor.getName()).fill(diff.x()); + LOGGER.info("MdiffSensor " + diff.toString() + " \n"); } } private void FillGBLTrackPlot(String str, String isTop, String charge, double val) { - aidaGBL.histogram1D(str+isTop).fill(val); - aidaGBL.histogram1D(str+isTop+charge).fill(val); + aidaGBL.histogram1D(str + isTop).fill(val); + aidaGBL.histogram1D(str + isTop + charge).fill(val); } private void FillGBLTrackPlot(String str, String isTop, String charge, double valX, double valY) { - aidaGBL.histogram2D(str+isTop).fill(valX,valY); - aidaGBL.histogram2D(str+isTop+charge).fill(valX,valY); + aidaGBL.histogram2D(str + isTop).fill(valX, valY); + aidaGBL.histogram2D(str + isTop + charge).fill(valX, valY); } private void FillGBLTrackPlot(String str, String isTop, String charge, double valX, double valY, double valZ) { - aidaGBL.histogram3D(str+isTop).fill(valX,valY,valZ); - aidaGBL.histogram3D(str+isTop+charge).fill(valX,valY,valZ); + aidaGBL.histogram3D(str + isTop).fill(valX, valY, valZ); + aidaGBL.histogram3D(str + isTop + charge).fill(valX, valY, valZ); } @@ -419,34 +408,34 @@ private void doBasicGBLtrack(Track trk, Map sensorHits) double trackp = new BasicHep3Vector(trackState.getMomentum()).magnitude(); - FillGBLTrackPlot(trkpFolder+"d0",isTop,charge,trackState.getD0()); - FillGBLTrackPlot(trkpFolder+"z0",isTop,charge,trackState.getZ0()); - FillGBLTrackPlot(trkpFolder+"phi",isTop,charge,trackState.getPhi()); - FillGBLTrackPlot(trkpFolder+"tanLambda",isTop,charge,trackState.getTanLambda()); - FillGBLTrackPlot(trkpFolder+"p",isTop,charge,trackp); - if (trk.getTrackerHits().size()==7) - FillGBLTrackPlot(trkpFolder+"p7h",isTop,charge,trackp); - if (trk.getTrackerHits().size()==6) - FillGBLTrackPlot(trkpFolder+"p6h",isTop,charge,trackp); - if (trk.getTrackerHits().size()==5) - FillGBLTrackPlot(trkpFolder+"p5h",isTop,charge,trackp); + FillGBLTrackPlot(trkpFolder + "d0", isTop, charge, trackState.getD0()); + FillGBLTrackPlot(trkpFolder + "z0", isTop, charge, trackState.getZ0()); + FillGBLTrackPlot(trkpFolder + "phi", isTop, charge, trackState.getPhi()); + FillGBLTrackPlot(trkpFolder + "tanLambda", isTop, charge, trackState.getTanLambda()); + FillGBLTrackPlot(trkpFolder + "p", isTop, charge, trackp); + if (trk.getTrackerHits().size() == 7) + FillGBLTrackPlot(trkpFolder + "p7h", isTop, charge, trackp); + if (trk.getTrackerHits().size() == 6) + FillGBLTrackPlot(trkpFolder + "p6h", isTop, charge, trackp); + if (trk.getTrackerHits().size() == 5) + FillGBLTrackPlot(trkpFolder + "p5h", isTop, charge, trackp); if (TrackUtils.isHoleTrack(trk)) - FillGBLTrackPlot(trkpFolder+"p_hole",isTop,charge,trackp); + FillGBLTrackPlot(trkpFolder + "p_hole", isTop, charge, trackp); else - FillGBLTrackPlot(trkpFolder+"p_slot",isTop,charge,trackp); + FillGBLTrackPlot(trkpFolder + "p_slot", isTop, charge, trackp); - //Momentum maps - FillGBLTrackPlot(trkpFolder+"p_vs_phi",isTop,charge,trackState.getPhi(),trackp); - FillGBLTrackPlot(trkpFolder+"p_vs_tanLambda",isTop,charge,trackState.getTanLambda(),trackp); - FillGBLTrackPlot(trkpFolder+"p_vs_phi_tanLambda",isTop,charge,trackState.getPhi(),trackState.getTanLambda(),trackp); + // Momentum maps + FillGBLTrackPlot(trkpFolder + "p_vs_phi", isTop, charge, trackState.getPhi(), trackp); + FillGBLTrackPlot(trkpFolder + "p_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackp); + FillGBLTrackPlot(trkpFolder + "p_vs_phi_tanLambda", isTop, charge, trackState.getPhi(), trackState.getTanLambda(), trackp); double tanLambda = trackState.getTanLambda(); - double cosLambda = 1. / (Math.sqrt(1+tanLambda*tanLambda)); + double cosLambda = 1. / (Math.sqrt(1 + tanLambda * tanLambda)); - FillGBLTrackPlot(trkpFolder+"pT_vs_phi",isTop,charge,trackState.getPhi(),trackp*cosLambda); - FillGBLTrackPlot(trkpFolder+"pT_vs_tanLambda",isTop,charge,trackState.getTanLambda(),trackp*cosLambda); + FillGBLTrackPlot(trkpFolder + "pT_vs_phi", isTop, charge, trackState.getPhi(), trackp * cosLambda); + FillGBLTrackPlot(trkpFolder + "pT_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackp * cosLambda); //if (trk.getTrackerHits().size()==6) @@ -456,8 +445,8 @@ private void doBasicGBLtrack(Track trk, Map sensorHits) // FillGBLTrackPlot(trkpFolder+"p_MissingLastLayer",isTop,charge,trackp); - FillGBLTrackPlot(trkpFolder+"Chi2",isTop,charge,trk.getChi2()); - FillGBLTrackPlot(trkpFolder+"Chi2_vs_p",isTop,charge,trackp,trk.getChi2()); + FillGBLTrackPlot(trkpFolder + "Chi2", isTop, charge, trk.getChi2()); + FillGBLTrackPlot(trkpFolder + "Chi2_vs_p", isTop, charge, trackp, trk.getChi2()); // deduce multiplication factor for ST-started GBL tracks int nhits = trk.getTrackerHits().size(); @@ -466,76 +455,75 @@ private void doBasicGBLtrack(Track trk, Map sensorHits) // one so we have to double that count for an equal comparison nhits *= 2; } - aidaGBL.histogram1D(trkpFolder+"nHits" + isTop).fill(nhits); - aidaGBL.histogram1D(trkpFolder+"nHits" + isTop+charge).fill(nhits); + aidaGBL.histogram1D(trkpFolder + "nHits" + isTop).fill(nhits); + aidaGBL.histogram1D(trkpFolder + "nHits" + isTop + charge).fill(nhits); Hep3Vector beamspot = CoordinateTransformations.transformVectorToDetector(TrackUtils.extrapolateHelixToXPlane(trackState, 0)); - if (debug) - System.out.printf("beamspot %s transformed %s \n", beamspot.toString()); - FillGBLTrackPlot(trkpFolder+"trk_extr_or_x",isTop,charge,beamspot.x()); - FillGBLTrackPlot(trkpFolder+"trk_extr_or_y",isTop,charge,beamspot.y()); + LOGGER.info("beamspot " + beamspot.toString()); + FillGBLTrackPlot(trkpFolder + "trk_extr_or_x", isTop, charge, beamspot.x()); + FillGBLTrackPlot(trkpFolder + "trk_extr_or_y", isTop, charge, beamspot.y()); //Extrapolation to assumed tgt pos - helix - Hep3Vector trkTgt = CoordinateTransformations.transformVectorToDetector(TrackUtils.extrapolateHelixToXPlane(trackState,bsZ)); - FillGBLTrackPlot(trkpFolder+"trk_extr_bs_x",isTop,charge,trkTgt.x()); - FillGBLTrackPlot(trkpFolder+"trk_extr_bs_y",isTop,charge,trkTgt.y()); + Hep3Vector trkTgt = CoordinateTransformations.transformVectorToDetector(TrackUtils.extrapolateHelixToXPlane(trackState, bsZ)); + FillGBLTrackPlot(trkpFolder + "trk_extr_bs_x", isTop, charge, trkTgt.x()); + FillGBLTrackPlot(trkpFolder + "trk_extr_bs_y", isTop, charge, trkTgt.y()); //Transform z to the beamspot plane //Get the PathToPlane - BaseTrackState ts_bs = TrackUtils.getTrackExtrapAtVtxSurfRK(trackState,bFieldMap,0.,bsZ); + BaseTrackState ts_bs = TrackUtils.getTrackExtrapAtVtxSurfRK(trackState, bFieldMap, 0., bsZ); //Get the track parameters wrt the beamline using helix - double [] beamLine = new double [] {bsZ,0}; + double [] beamLine = new double [] {bsZ, 0}; double [] helixParametersAtBS = TrackUtils.getParametersAtNewRefPoint(beamLine, trackState); - FillGBLTrackPlot(trkpFolder+"trk_extr_bs_x_rk",isTop,charge,ts_bs.getReferencePoint()[1]); - FillGBLTrackPlot(trkpFolder+"trk_extr_bs_y_rk",isTop,charge,ts_bs.getReferencePoint()[2]); + FillGBLTrackPlot(trkpFolder + "trk_extr_bs_x_rk", isTop, charge, ts_bs.getReferencePoint()[1]); + FillGBLTrackPlot(trkpFolder + "trk_extr_bs_y_rk", isTop, charge, ts_bs.getReferencePoint()[2]); //Ill defined - should be defined wrt bsX and bsY - FillGBLTrackPlot(trkpFolder+"d0_vs_bs_rk",isTop,charge,ts_bs.getD0()); - FillGBLTrackPlot(trkpFolder+"d0_vs_bs_extrap",isTop,charge,helixParametersAtBS[BaseTrack.D0]); + FillGBLTrackPlot(trkpFolder + "d0_vs_bs_rk", isTop, charge, ts_bs.getD0()); + FillGBLTrackPlot(trkpFolder + "d0_vs_bs_extrap", isTop, charge, helixParametersAtBS[BaseTrack.D0]); - double s = HelixUtils.PathToXPlane(TrackUtils.getHTF(trackState),bsZ,0.,0).get(0); - FillGBLTrackPlot(trkpFolder+"z0_vs_bs",isTop,charge,trackState.getZ0() + s*trackState.getTanLambda()); - FillGBLTrackPlot(trkpFolder+"z0_vs_bs_rk",isTop,charge,ts_bs.getZ0()); - FillGBLTrackPlot(trkpFolder+"z0_vs_bs_extrap",isTop,charge,helixParametersAtBS[BaseTrack.Z0]); + double s = HelixUtils.PathToXPlane(TrackUtils.getHTF(trackState), bsZ, 0., 0).get(0); + FillGBLTrackPlot(trkpFolder + "z0_vs_bs", isTop, charge, trackState.getZ0() + s*trackState.getTanLambda()); + FillGBLTrackPlot(trkpFolder + "z0_vs_bs_rk", isTop, charge, ts_bs.getZ0()); + FillGBLTrackPlot(trkpFolder + "z0_vs_bs_extrap", isTop, charge, helixParametersAtBS[BaseTrack.Z0]); - FillGBLTrackPlot(trkpFolder+"phi_vs_bs_extrap",isTop,charge,helixParametersAtBS[BaseTrack.PHI]); + FillGBLTrackPlot(trkpFolder + "phi_vs_bs_extrap", isTop, charge, helixParametersAtBS[BaseTrack.PHI]); //TH2D - Filling - FillGBLTrackPlot(trkpFolder+"d0_vs_phi",isTop,charge,trackState.getPhi(),trackState.getD0()); - FillGBLTrackPlot(trkpFolder+"d0_vs_tanLambda",isTop,charge,trackState.getTanLambda(),trackState.getD0()); - FillGBLTrackPlot(trkpFolder+"d0_vs_p",isTop,charge,trackp,trackState.getD0()); + FillGBLTrackPlot(trkpFolder + "d0_vs_phi", isTop, charge, trackState.getPhi(), trackState.getD0()); + FillGBLTrackPlot(trkpFolder + "d0_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackState.getD0()); + FillGBLTrackPlot(trkpFolder + "d0_vs_p", isTop, charge, trackp, trackState.getD0()); //Ill defined - should be defined wrt bsX and bsY - FillGBLTrackPlot(trkpFolder+"d0bs_vs_p",isTop,charge,trackp,helixParametersAtBS[BaseTrack.D0]); + FillGBLTrackPlot(trkpFolder + "d0bs_vs_p", isTop, charge, trackp, helixParametersAtBS[BaseTrack.D0]); - FillGBLTrackPlot(trkpFolder+"z0_vs_p",isTop,charge,trackp,trackState.getZ0()); - FillGBLTrackPlot(trkpFolder+"z0bs_vs_p",isTop,charge,trackp,ts_bs.getZ0()); + FillGBLTrackPlot(trkpFolder + "z0_vs_p", isTop, charge, trackp, trackState.getZ0()); + FillGBLTrackPlot(trkpFolder + "z0bs_vs_p", isTop, charge, trackp, ts_bs.getZ0()); //Interesting plot to get a sense where z-vtx is. //If z0 is referenced to the right BS z location, the slope of vs tanLambda is 0 - FillGBLTrackPlot(trkpFolder+"z0_vs_tanLambda",isTop,charge,trackState.getTanLambda(),trackState.getZ0()); - FillGBLTrackPlot(trkpFolder+"z0bs_vs_tanLambda",isTop,charge,trackState.getTanLambda(),ts_bs.getZ0()); + FillGBLTrackPlot(trkpFolder + "z0_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackState.getZ0()); + FillGBLTrackPlot(trkpFolder + "z0bs_vs_tanLambda", isTop,charge, trackState.getTanLambda(), ts_bs.getZ0()); if (b_doDetailPlots) { int ibins = 15; - double start= -12; + double start = -12; double end = -5; double step = (end-start) / (double)ibins; - for (int ibin = 0; ibin sensorHits) private void doGBLresiduals(Track trk, Map sensorHits, EventHeader event) { - Map sensorMPIDs = new HashMap(); + Map sensorMPIDs = new HashMap(); double trackTime = 0.; double trackTimeSD = 0.; for (HpsSiSensor sensor : sensorHits.keySet()) { //Also fill here the sensorMPIDs map - sensorMPIDs.put(sensor.getMillepedeId(),sensor); + sensorMPIDs.put(sensor.getMillepedeId(), sensor); ITransform3D trans = sensor.getGeometry().getGlobalToLocal(); // position of hit (track crossing the sensor before GBL extrapolation) @@ -574,7 +562,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, // after the transformation x and y in the sensor frame are reversed // This plot is ill defined. - aidaGBL.histogram2D(hitFolder+"hit_u_vs_v_sensor_frame_" + sensor.getName()).fill(hitTrackPosSensor.y(), hitTrackPosSensor.x()); + aidaGBL.histogram2D(hitFolder + "hit_u_vs_v_sensor_frame_" + sensor.getName()).fill(hitTrackPosSensor.y(), hitTrackPosSensor.x()); //aidaGBL.histogram2D("hit_u_vs_v_sensor_frame_" + sensor.getName()).fill(hitPos.y(), hitPos.x()); //aidaGBL.histogram2D("hit y vs x lab-frame " + sensor.getName()).fill(hitPos.y(), hitPos.x()); @@ -588,12 +576,12 @@ private void doGBLresiduals(Track trk, Map sensorHits, extrapPosSensor = new BasicHep3Vector(extrapPos.v()); trans.transform(extrapPosSensor); //aidaGBL.histogram2D("residual after GBL vs u predicted " + sensor.getName()).fill(extrapPosSensor.x(), res); - aidaGBL.histogram2D(hitFolder+"predicted_u_vs_v_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); + aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); // select track charge if(trk.getCharge()>0) { - aidaGBL.histogram2D(hitFolder+"predicted_u_vs_v_pos_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); + aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_pos_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); }else if(trk.getCharge()<0) { - aidaGBL.histogram2D(hitFolder+"predicted_u_vs_v_neg_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); + aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_neg_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); } // post-GBL residual @@ -601,9 +589,9 @@ private void doGBLresiduals(Track trk, Map sensorHits, Hep3Vector hitPosSensor = new BasicHep3Vector(hitPos.v()); trans.transform(hitPosSensor); Hep3Vector resSensor = VecOp.sub(hitPosSensor, extrapPosSensor); - aidaGBL.histogram2D(resFolder+"residual_after_GBL_vs_v_predicted_" + sensor.getName()).fill(extrapPosSensor.y(), resSensor.x()); - aidaGBL.histogram2D(resFolder+"residual_after_GBL_vs_u_hit_" + sensor.getName()).fill(hitPosSensor.x(), resSensor.x()); - aidaGBL.histogram1D(resFolder+"residual_after_GBL_" + sensor.getName()).fill(resSensor.x()); + aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_v_predicted_" + sensor.getName()).fill(extrapPosSensor.y(), resSensor.x()); + aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_u_hit_" + sensor.getName()).fill(hitPosSensor.x(), resSensor.x()); + aidaGBL.histogram1D(resFolder + "residual_after_GBL_" + sensor.getName()).fill(resSensor.x()); trackTime += sensorHits.get(sensor).getTime(); @@ -626,17 +614,14 @@ private void doGBLresiduals(Track trk, Map sensorHits, } }//loop on sensor hits - trackTime /= (float)sensorHits.size(); for (HpsSiSensor sensor : sensorHits.keySet()) { - trackTimeSD += Math.pow(trackTime - sensorHits.get(sensor).getTime(),2); + trackTimeSD += Math.pow(trackTime - sensorHits.get(sensor).getTime(), 2); } trackTimeSD = Math.sqrt(trackTimeSD / ((float) sensorHits.size() - 1.)); - - RelationalTable trackResidualsTable = null; if (event.hasCollection(LCRelation.class, trackResidualsRelColName)) { trackResidualsTable = new BaseRelationalTable(RelationalTable.Mode.ONE_TO_ONE, RelationalTable.Weighting.UNWEIGHTED); @@ -660,7 +645,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, //it's bias-unbias-bias-unbias-bias-unbias.... //TODO add in trackRes the number of hits on tracks ? - int nres = (trackRes.getNInt()-1); + int nres = (trackRes.getNInt() - 1); String vol = "_top"; if (trk.getTrackStates().get(0).getTanLambda() < 0) @@ -668,44 +653,42 @@ private void doGBLresiduals(Track trk, Map sensorHits, //get the bias first for (int i_hit =0; i_hit <= nres-1 ; i_hit+=2) { - if (trackRes.getIntVal(i_hit)!=-999) { - //System.out.println("PF::DEBUG:: "+ trackCollectionName+ " trackRes.getIntVal(i_hit) " + trackRes.getIntVal(i_hit)); + if (trackRes.getIntVal(i_hit) != -999) { + LOGGER.info("PF: "+ trackCollectionName+ " trackRes.getIntVal(i_hit) " + trackRes.getIntVal(i_hit)); String sensorName = (sensorMPIDs.get(trackRes.getIntVal(i_hit))).getName(); - if (debug) { - //System.out.printf("NHits %d MPID sensor:%d %s %d\n", nres,trackRes.getIntVal(i_hit), sensorName,i_hit); - //System.out.printf("Track residuals: %s %.5f %.5f\n",sensorName, trackRes.getDoubleVal(i_hit),trackRes.getFloatVal(i_hit)); - } + + LOGGER.info("NHits " + nres + " MPID sensor:" + trackRes.getIntVal(i_hit) + " " + sensorName + " " + i_hit); + LOGGER.info("Track residuals: " + sensorName + " " + trackRes.getDoubleVal(i_hit) + " " + trackRes.getFloatVal(i_hit)); + //General residuals Per volume - aidaGBL.histogram1D(resFolder+"bresidual_GBL"+vol).fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol).fill(trackRes.getDoubleVal(i_hit)); if (trackRes.getIntVal(i_hit) < 9) //L1L4 - aidaGBL.histogram1D(resFolder+"bresidual_GBL"+vol+"_L1L4").fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L1L4").fill(trackRes.getDoubleVal(i_hit)); else //L5L7 - aidaGBL.histogram1D(resFolder+"bresidual_GBL"+vol+"_L5L7").fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L5L7").fill(trackRes.getDoubleVal(i_hit)); //Top go from 0 to 20, bottom go from 25 to 45 int spacing = 0; if (vol == "_bottom") spacing = sensors.size() / 2 + mod; - aidaGBL.histogram2D(resFolder +"bresidual_GBL_mod").fill(trackRes.getIntVal(i_hit)+spacing,trackRes.getDoubleVal(i_hit)); - aidaGBL.profile1D(resFolder +"bresidual_GBL_mod_p").fill(trackRes.getIntVal(i_hit)+spacing,trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram2D(resFolder + "bresidual_GBL_mod").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); + aidaGBL.profile1D(resFolder + "bresidual_GBL_mod_p").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram1D(resFolder +"bresidual_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram1D(epullFolder+"breserror_GBL_" + sensorName).fill(trackRes.getFloatVal(i_hit)); - aidaGBL.histogram1D(epullFolder+"bres_pull_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit) / trackRes.getFloatVal(i_hit)); + aidaGBL.histogram1D(resFolder + "bresidual_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(epullFolder + "breserror_GBL_" + sensorName).fill(trackRes.getFloatVal(i_hit)); + aidaGBL.histogram1D(epullFolder + "bres_pull_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit) / trackRes.getFloatVal(i_hit)); } else { System.out.printf("Track refit failed? No biased residual for %d\n", i_hit); } } // get the unbias - for (int i_hit =1; i_hit <= nres-1 ; i_hit+=2) { - if (trackRes.getIntVal(i_hit)!=-999) { - - + for (int i_hit = 1; i_hit <= nres-1 ; i_hit+=2) { + if (trackRes.getIntVal(i_hit) != -999) { //Measured hit HpsSiSensor hps_sensor = sensorMPIDs.get(trackRes.getIntVal(i_hit)); Hep3Vector hitPosG = new BasicHep3Vector(sensorHits.get(hps_sensor).getPosition()); @@ -723,20 +706,18 @@ private void doGBLresiduals(Track trk, Map sensorHits, extrapPosSensor = new BasicHep3Vector(extrapPos.v()); g2l.transform(extrapPosSensor); - if (debug) { - System.out.printf("NHits %d MPID sensor:%d %s %d\n", nres,trackRes.getIntVal(i_hit), sensorName,i_hit); - System.out.printf("Track uresiduals: %s %.5f %.5f\n",sensorName, trackRes.getDoubleVal(i_hit),trackRes.getFloatVal(i_hit)); - } + LOGGER.info("NHits " + nres + " MPID sensor:" + trackRes.getIntVal(i_hit) + " " + sensorName + " " + i_hit); + LOGGER.info("Track uresiduals: " + sensorName + " " + trackRes.getDoubleVal(i_hit) + " " + trackRes.getFloatVal(i_hit)); //General residuals Per volume - aidaGBL.histogram1D(resFolder+"uresidual_GBL"+vol).fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol).fill(trackRes.getDoubleVal(i_hit)); if (trackRes.getIntVal(i_hit) < 9) //L1L4 - aidaGBL.histogram1D(resFolder+"uresidual_GBL"+vol+"_L1L4").fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L1L4").fill(trackRes.getDoubleVal(i_hit)); else //L5L7 - aidaGBL.histogram1D(resFolder+"uresidual_GBL"+vol+"_L5L7").fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L5L7").fill(trackRes.getDoubleVal(i_hit)); //Top go from 0 to 20, bottom go from 25 to 45 @@ -744,13 +725,13 @@ private void doGBLresiduals(Track trk, Map sensorHits, if (vol == "_bottom") spacing = sensors.size()/2 + mod; - aidaGBL.histogram2D(resFolder+"uresidual_GBL_mod").fill(trackRes.getIntVal(i_hit)+spacing,trackRes.getDoubleVal(i_hit)); - aidaGBL.profile1D(resFolder+"uresidual_GBL_mod_p").fill(trackRes.getIntVal(i_hit)+spacing,trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram1D(resFolder+"uresidual_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_u_hit_" + sensorName).fill(hitPosSensorG.x(),trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_v_pred_" + sensorName).fill(extrapPosSensor.y(),trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram1D(epullFolder+"ureserror_GBL_" + sensorName).fill(trackRes.getFloatVal(i_hit)); - aidaGBL.histogram1D(epullFolder+"ures_pull_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit) / trackRes.getFloatVal(i_hit)); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_mod").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); + aidaGBL.profile1D(resFolder + "uresidual_GBL_mod_p").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(resFolder + "uresidual_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_u_hit_" + sensorName).fill(hitPosSensorG.x(), trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_v_pred_" + sensorName).fill(extrapPosSensor.y(), trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram1D(epullFolder + "ureserror_GBL_" + sensorName).fill(trackRes.getFloatVal(i_hit)); + aidaGBL.histogram1D(epullFolder + "ures_pull_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit) / trackRes.getFloatVal(i_hit)); //Get the hit time double hitTime = sensorHits.get(hps_sensor).getTime(); @@ -760,17 +741,11 @@ private void doGBLresiduals(Track trk, Map sensorHits, double dT_hit_track = hitTime - trackTime; double dT_hit_sigma = (hitTime - trackTime) / trackTimeSD; - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_dT_hit_"+sensorName).fill(dT_hit_track,trackRes.getDoubleVal(i_hit)); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_dTs_hit_"+sensorName).fill(dT_hit_sigma,trackRes.getDoubleVal(i_hit)); - - - - + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_dT_hit_" + sensorName).fill(dT_hit_track, trackRes.getDoubleVal(i_hit)); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_dTs_hit_" + sensorName).fill(dT_hit_sigma, trackRes.getDoubleVal(i_hit)); } else { - if (debug){ - System.out.printf("Track refit failed? No biased residual for %d\n", i_hit); - } + LOGGER.info("Track refit failed? No unbiased residual for " + i_hit); } } }//doGBLresiduals @@ -807,34 +782,31 @@ private List findMissingLayer(Track trk) { private void setupPlots() { - - double xmax = 0.25; - double kxmax = 0.001; + double kxmax = 0.001; // unused variable int nbins = 250; List volumes = new ArrayList(); volumes.add("_top"); volumes.add("_bottom"); - int mod_2dplot_bins = sensors.size()+mod*2; + int mod_2dplot_bins = sensors.size() + mod*2; for (String vol : volumes) { - aidaGBL.histogram1D(resFolder+"bresidual_GBL"+vol,nbins, -xmax, xmax); - aidaGBL.histogram1D(resFolder+"uresidual_GBL"+vol,nbins, -xmax, xmax); - aidaGBL.histogram1D(resFolder+"bresidual_GBL"+vol+"_L1L4",nbins,-xmax,xmax); - aidaGBL.histogram1D(resFolder+"uresidual_GBL"+vol+"_L1L4",nbins,-xmax,xmax); - aidaGBL.histogram1D(resFolder+"bresidual_GBL"+vol+"_L5L7",nbins,-xmax,xmax); - aidaGBL.histogram1D(resFolder+"uresidual_GBL"+vol+"_L5L7",nbins,-xmax,xmax); + aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol, nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol, nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L1L4", nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L1L4", nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L5L7", nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L5L7", nbins, -xmax, xmax); } //res/kinks TH2D //5 empty bins to distinguish between top and bottom - - aidaGBL.histogram2D(resFolder+"bresidual_GBL_mod",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5, nbins, -xmax,xmax); - aidaGBL.profile1D(resFolder+"bresidual_GBL_mod_p",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_mod",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5, 400, -0.4,0.4); - aidaGBL.profile1D(resFolder+"uresidual_GBL_mod_p",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5); + aidaGBL.histogram2D(resFolder + "bresidual_GBL_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, nbins, -xmax, xmax); + aidaGBL.profile1D(resFolder + "bresidual_GBL_mod_p", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, 400, -0.4, 0.4); + aidaGBL.profile1D(resFolder + "uresidual_GBL_mod_p", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5); for (SiSensor sensor : sensors) { @@ -850,31 +822,31 @@ private void setupPlots() { if (l >= 6) xmax = 0.250; - aidaGBL.histogram1D(resFolder+"residual_after_GBL_" + sensor.getName(), nbins, -xmax, xmax); - aidaGBL.histogram1D(resFolder+"bresidual_GBL_" + sensor.getName(), nbins, -xmax, xmax); - aidaGBL.histogram1D(resFolder+"uresidual_GBL_" + sensor.getName(), nbins, -xmax, xmax); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_u_hit_" + sensor.getName(),100,-20.0,20.0,100,-0.1,0.1); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_v_pred_" + sensor.getName(),300,-60.0,60.0,100,-0.1,0.1); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_dT_hit_" + sensor.getName(),100,-10.0,10.0,100,-0.1,0.1); - aidaGBL.histogram2D(resFolder+"uresidual_GBL_vs_dTs_hit_" + sensor.getName(),100,-5.0,5.0,100,-0.1,0.1); - aidaGBL.histogram1D(epullFolder+"breserror_GBL_" + sensor.getName(), nbins, 0.0, 0.1); - aidaGBL.histogram1D(epullFolder+"ureserror_GBL_" + sensor.getName(), nbins, 0.0, 0.2); - aidaGBL.histogram1D(epullFolder+"bres_pull_GBL_" + sensor.getName(), nbins, -5, 5); - aidaGBL.histogram1D(epullFolder+"ures_pull_GBL_" + sensor.getName(), nbins, -5, 5); - - aidaGBL.histogram2D(resFolder+"residual_after_GBL_vs_u_hit_" + sensor.getName(), 100, -20.0, 20.0, 100, -0.04, 0.04); - aidaGBL.histogram2D(resFolder+"residual_after_GBL_vs_v_predicted_" + sensor.getName(), 100, -55.0, 55.0, 100, -0.04, 0.04); - aidaGBL.histogram2D(hitFolder+"hit_u_vs_v_sensor_frame_" + sensor.getName(), 300, -60.0, 60.0, 300, -25, 25); - aidaGBL.histogram2D(hitFolder+"predicted_u_vs_v_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); - aidaGBL.histogram2D(hitFolder+"predicted_u_vs_v_pos_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); - aidaGBL.histogram2D(hitFolder+"predicted_u_vs_v_neg_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); + aidaGBL.histogram1D(resFolder + "residual_after_GBL_" + sensor.getName(), nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "bresidual_GBL_" + sensor.getName(), nbins, -xmax, xmax); + aidaGBL.histogram1D(resFolder + "uresidual_GBL_" + sensor.getName(), nbins, -xmax, xmax); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_u_hit_" + sensor.getName(), 100,-20.0, 20.0, 100,-0.1, 0.1); + aidaGBL.histogram2D(resFolder +"uresidual_GBL_vs_v_pred_" + sensor.getName(), 300, -60.0, 60.0, 100,-0.1, 0.1); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_dT_hit_" + sensor.getName(), 100, -10.0, 10.0, 100,-0.1, 0.1); + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_dTs_hit_" + sensor.getName(), 100, -5.0, 5.0, 100, -0.1, 0.1); + aidaGBL.histogram1D(epullFolder + "breserror_GBL_" + sensor.getName(), nbins, 0.0, 0.1); + aidaGBL.histogram1D(epullFolder + "ureserror_GBL_" + sensor.getName(), nbins, 0.0, 0.2); + aidaGBL.histogram1D(epullFolder + "bres_pull_GBL_" + sensor.getName(), nbins, -5, 5); + aidaGBL.histogram1D(epullFolder + "ures_pull_GBL_" + sensor.getName(), nbins, -5, 5); + + aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_u_hit_" + sensor.getName(), 100, -20.0, 20.0, 100, -0.04, 0.04); + aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_v_predicted_" + sensor.getName(), 100, -55.0, 55.0, 100, -0.04, 0.04); + aidaGBL.histogram2D(hitFolder + "hit_u_vs_v_sensor_frame_" + sensor.getName(), 300, -60.0, 60.0, 300, -25, 25); + aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); + aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_pos_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); + aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_neg_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); xmax = 0.0006; - if(l==1){ + if(l == 1){ xmax = 0.0002; - }else if(l==2){ + }else if(l == 2){ xmax = 0.0005; - }else if(l==3 || l==4){ + }else if(l == 3 || l == 4){ xmax = 0.0006; }else if(l >= 5) { if (sens.isBottomLayer() && sens.isAxial()) @@ -882,14 +854,14 @@ private void setupPlots() { if (sens.isTopLayer() && !sens.isAxial()) xmax = 0.001; } - aidaGBL.histogram1D(kinkFolder+"lambda_kink_" + sensor.getName(), 250, -xmax, xmax); - aidaGBL.histogram1D(kinkFolder+"phi_kink_" + sensor.getName(), 250, -xmax, xmax); + aidaGBL.histogram1D(kinkFolder + "lambda_kink_" + sensor.getName(), 250, -xmax, xmax); + aidaGBL.histogram1D(kinkFolder + "phi_kink_" + sensor.getName(), 250, -xmax, xmax); } - aidaGBL.histogram2D(kinkFolder+"lambda_kink_mod",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5,nbins,-0.001,0.001); - aidaGBL.profile1D(kinkFolder+"lambda_kink_mod_p",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5); - aidaGBL.histogram2D(kinkFolder+"phi_kink_mod",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5 ,nbins,-0.001,0.001); - aidaGBL.profile1D(kinkFolder+"phi_kink_mod_p",mod_2dplot_bins,-0.5,mod_2dplot_bins-0.5); + aidaGBL.histogram2D(kinkFolder + "lambda_kink_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, nbins, -0.001, 0.001); + aidaGBL.profile1D(kinkFolder + "lambda_kink_mod_p", mod_2dplot_bins, -0.5,mod_2dplot_bins-0.5); + aidaGBL.histogram2D(kinkFolder + "phi_kink_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, nbins, -0.001, 0.001); + aidaGBL.profile1D(kinkFolder + "phi_kink_mod_p", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5); List charges = new ArrayList(); charges.add(""); @@ -903,62 +875,60 @@ private void setupPlots() { double pmax = 8.; double z0max = 1; - double d0max = 5; + double d0max = 5; // unused variable double z0bsmax = 0.2; for (String vol : volumes) { for (String charge : charges) { - - //TH1Ds - aidaGBL.histogram1D(trkpFolder+"d0"+vol+charge,nbins_t,-5.0,5.0); - aidaGBL.histogram1D(trkpFolder+"z0"+vol+charge,nbins_t,-1.3,1.3); - aidaGBL.histogram1D(trkpFolder+"phi"+vol+charge,nbins_t,-0.06,0.06); - aidaGBL.histogram1D(trkpFolder+"tanLambda"+vol+charge,nbins_t,-0.2,0.2); - aidaGBL.histogram1D(trkpFolder+"p"+vol+charge,nbins_p,0.,pmax); - aidaGBL.histogram1D(trkpFolder+"p7h"+vol+charge,nbins_p,0.,pmax); - aidaGBL.histogram1D(trkpFolder+"p6h"+vol+charge,nbins_p,0.,pmax); - aidaGBL.histogram1D(trkpFolder+"p5h"+vol+charge,nbins_p,0.,pmax); - aidaGBL.histogram1D(trkpFolder+"p_MissingLastLayer"+vol+charge,nbins_p,0.,pmax); - aidaGBL.histogram1D(trkpFolder+"p_hole"+vol+charge,nbins_p,0.,pmax); - aidaGBL.histogram1D(trkpFolder+"p_slot"+vol+charge,nbins_p,0.,pmax); + aidaGBL.histogram1D(trkpFolder + "d0" + vol + charge, nbins_t, -5.0, 5.0); + aidaGBL.histogram1D(trkpFolder + "z0" + vol + charge, nbins_t, -1.3, 1.3); + aidaGBL.histogram1D(trkpFolder + "phi" + vol + charge, nbins_t, -0.06, 0.06); + aidaGBL.histogram1D(trkpFolder + "tanLambda" + vol + charge, nbins_t, -0.2, 0.2); + aidaGBL.histogram1D(trkpFolder + "p" + vol + charge, nbins_p, 0., pmax); + aidaGBL.histogram1D(trkpFolder + "p7h" + vol + charge, nbins_p, 0., pmax); + aidaGBL.histogram1D(trkpFolder + "p6h" + vol + charge, nbins_p, 0., pmax); + aidaGBL.histogram1D(trkpFolder + "p5h" + vol + charge, nbins_p, 0., pmax); + aidaGBL.histogram1D(trkpFolder + "p_MissingLastLayer" + vol + charge, nbins_p, 0., pmax); + aidaGBL.histogram1D(trkpFolder + "p_hole" + vol + charge, nbins_p, 0., pmax); + aidaGBL.histogram1D(trkpFolder + "p_slot" + vol + charge, nbins_p, 0., pmax); - aidaGBL.histogram1D(trkpFolder+"Chi2"+vol+charge,nbins_t*2,0,200); - aidaGBL.histogram1D(trkpFolder+"nHits"+vol+charge,15,0,15); - aidaGBL.histogram1D(trkpFolder+"trk_extr_or_x"+vol+charge,nbins_t,-3,3); - aidaGBL.histogram1D(trkpFolder+"trk_extr_or_y"+vol+charge,nbins_t,-3,3); - aidaGBL.histogram1D(trkpFolder+"trk_extr_bs_x"+vol+charge, 2*nbins_t, -5, 5); - aidaGBL.histogram1D(trkpFolder+"trk_extr_bs_y"+vol+charge, 2*nbins_t, -5, 5); - aidaGBL.histogram1D(trkpFolder+"trk_extr_bs_x_rk"+vol+charge, 2*nbins_t, -5, 5); - aidaGBL.histogram1D(trkpFolder+"trk_extr_bs_y_rk"+vol+charge, 2*nbins_t, -3, 3); - aidaGBL.histogram1D(trkpFolder+"d0_vs_bs_rk"+vol+charge, 2*nbins_t, -5, 5); - aidaGBL.histogram1D(trkpFolder+"d0_vs_bs_extrap"+vol+charge, 2*nbins_t, -5, 5); - aidaGBL.histogram1D(trkpFolder+"z0_vs_bs_rk"+vol+charge, 2*nbins_t, -z0bsmax, z0bsmax); - aidaGBL.histogram1D(trkpFolder+"z0_vs_bs_extrap"+vol+charge, 2*nbins_t, -z0bsmax, z0bsmax); - aidaGBL.histogram1D(trkpFolder+"z0_vs_bs"+vol+charge, 2*nbins_t, -z0bsmax, z0bsmax); - aidaGBL.histogram1D(trkpFolder+"phi_vs_bs_extrap"+vol+charge,2*nbins_t, -0.06,0.06); + aidaGBL.histogram1D(trkpFolder + "Chi2" + vol + charge, nbins_t*2, 0, 200); + aidaGBL.histogram1D(trkpFolder + "nHits" + vol + charge, 15, 0, 15); + aidaGBL.histogram1D(trkpFolder + "trk_extr_or_x" + vol + charge, nbins_t, -3, 3); + aidaGBL.histogram1D(trkpFolder + "trk_extr_or_y" + vol + charge, nbins_t, -3, 3); + aidaGBL.histogram1D(trkpFolder + "trk_extr_bs_x" + vol + charge, 2*nbins_t, -5, 5); + aidaGBL.histogram1D(trkpFolder + "trk_extr_bs_y" + vol + charge, 2*nbins_t, -5, 5); + aidaGBL.histogram1D(trkpFolder + "trk_extr_bs_x_rk" + vol + charge, 2*nbins_t, -5, 5); + aidaGBL.histogram1D(trkpFolder + "trk_extr_bs_y_rk" + vol + charge, 2*nbins_t, -3, 3); + aidaGBL.histogram1D(trkpFolder + "d0_vs_bs_rk" + vol + charge, 2*nbins_t, -5, 5); + aidaGBL.histogram1D(trkpFolder + "d0_vs_bs_extrap" + vol + charge, 2*nbins_t, -5, 5); + aidaGBL.histogram1D(trkpFolder + "z0_vs_bs_rk" + vol + charge, 2*nbins_t, -z0bsmax, z0bsmax); + aidaGBL.histogram1D(trkpFolder + "z0_vs_bs_extrap" + vol + charge, 2*nbins_t, -z0bsmax, z0bsmax); + aidaGBL.histogram1D(trkpFolder + "z0_vs_bs" + vol + charge, 2*nbins_t, -z0bsmax, z0bsmax); + aidaGBL.histogram1D(trkpFolder + "phi_vs_bs_extrap" + vol + charge, 2*nbins_t, -0.06, 0.06); //TH2Ds - aidaGBL.histogram2D(trkpFolder+"d0_vs_phi"+vol+charge,nbins_t,-0.3,0.3,nbins_t,-5.0,5.0); - aidaGBL.histogram2D(trkpFolder+"Chi2_vs_p"+vol+charge,nbins_p,0.0,pmax,nbins_t*2,0,200); + aidaGBL.histogram2D(trkpFolder + "d0_vs_phi" + vol + charge, nbins_t, -0.3, 0.3, nbins_t, -5.0, 5.0); + aidaGBL.histogram2D(trkpFolder + "Chi2_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t*2, 0, 200); //aidaGBL.histogram2D("d0_vs_phi_bs"+vol+charge,nbins_t,-5.0,5.0,nbins_t,-0.3,0.3); - aidaGBL.histogram2D(trkpFolder+"d0_vs_tanLambda"+vol+charge,nbins_t,-0.2,0.2,nbins_t,-5.0,5.0); - aidaGBL.histogram2D(trkpFolder+"d0_vs_p"+vol+charge, nbins_p,0.0,pmax,nbins_t,-5.0,5.0); - aidaGBL.histogram2D(trkpFolder+"d0bs_vs_p"+vol+charge,nbins_p,0.0,pmax,nbins_t,-5.0,5.0); - aidaGBL.histogram2D(trkpFolder+"z0_vs_p"+vol+charge, nbins_p,0.0,pmax,nbins_t,-5.0,5.0); - aidaGBL.histogram2D(trkpFolder+"z0bs_vs_p"+vol+charge,nbins_p,0.0,pmax,nbins_t,-z0bsmax,z0bsmax); - aidaGBL.histogram2D(trkpFolder+"z0_vs_tanLambda"+vol+charge, nbins_t,-0.1,0.1,nbins_t,-z0max,z0max); - aidaGBL.histogram2D(trkpFolder+"z0bs_vs_tanLambda"+vol+charge,nbins_t,-0.1,0.1,nbins_t,-z0bsmax,z0bsmax); - - aidaGBL.histogram2D(trkpFolder+"p_Missing1Hit"+vol+charge,8,0,8,nbins_p,0.0,pmax); - aidaGBL.histogram2D(trkpFolder+"p_vs_phi"+vol+charge, nbins_t,-0.3,0.3, nbins_p,0.,pmax); - aidaGBL.histogram2D(trkpFolder+"p_vs_tanLambda"+vol+charge,nbins_t,-0.2,0.2,nbins_p,0.,pmax); - aidaGBL.histogram3D(trkpFolder+"p_vs_phi_tanLambda"+vol+charge, 50,-0.3,0.3,50,-0.2,0.2,100,0.,pmax); - - aidaGBL.histogram2D(trkpFolder+"pT_vs_phi"+vol+charge, nbins_t,-0.3,0.3, nbins_p,0.,pmax); - aidaGBL.histogram2D(trkpFolder+"pT_vs_tanLambda"+vol+charge,nbins_t,-0.2,0.2,nbins_p,0.,pmax); + aidaGBL.histogram2D(trkpFolder + "d0_vs_tanLambda" + vol + charge, nbins_t, -0.2, 0.2, nbins_t, -5.0, 5.0); + aidaGBL.histogram2D(trkpFolder + "d0_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t, -5.0, 5.0); + aidaGBL.histogram2D(trkpFolder + "d0bs_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t, -5.0, 5.0); + aidaGBL.histogram2D(trkpFolder + "z0_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t, -5.0, 5.0); + aidaGBL.histogram2D(trkpFolder + "z0bs_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t, -z0bsmax, z0bsmax); + aidaGBL.histogram2D(trkpFolder + "z0_vs_tanLambda" + vol + charge, nbins_t, -0.1, 0.1, nbins_t, -z0max, z0max); + aidaGBL.histogram2D(trkpFolder + "z0bs_vs_tanLambda" + vol + charge, nbins_t, -0.1, 0.1, nbins_t, -z0bsmax, z0bsmax); + + aidaGBL.histogram2D(trkpFolder + "p_Missing1Hit" + vol + charge, 8, 0, 8, nbins_p, 0.0, pmax); + aidaGBL.histogram2D(trkpFolder + "p_vs_phi" + vol + charge, nbins_t, -0.3, 0.3, nbins_p, 0., pmax); + aidaGBL.histogram2D(trkpFolder + "p_vs_tanLambda" + vol + charge, nbins_t, -0.2, 0.2, nbins_p, 0., pmax); + aidaGBL.histogram3D(trkpFolder + "p_vs_phi_tanLambda" + vol + charge, 50, -0.3, 0.3, 50, -0.2, 0.2, 100, 0., pmax); + + aidaGBL.histogram2D(trkpFolder + "pT_vs_phi" + vol + charge, nbins_t, -0.3, 0.3, nbins_p, 0., pmax); + aidaGBL.histogram2D(trkpFolder + "pT_vs_tanLambda" + vol + charge, nbins_t, -0.2, 0.2, nbins_p, 0., pmax); @@ -968,10 +938,10 @@ private void setupPlots() { double start= -12; double end = -5; double step = (end-start) / (double)ibins; - for (int ibin = 0; ibin Date: Wed, 22 Mar 2023 15:42:10 -0700 Subject: [PATCH 4/8] more formatting --- .../recon/tracking/gbl/GBLOutputDriver.java | 367 ++++++++---------- 1 file changed, 167 insertions(+), 200 deletions(-) diff --git a/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java b/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java index 19380e4da2..d71a827566 100644 --- a/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java +++ b/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLOutputDriver.java @@ -47,7 +47,7 @@ public class GBLOutputDriver extends Driver { public static Logger LOGGER = Logger.getLogger(GBLOutputDriver.class.getName()); - + private AIDA aidaGBL; // era public private String outputPlots = "GBLplots_ali.root"; private String trackCollectionName = "GBLTracks"; @@ -87,7 +87,6 @@ public class GBLOutputDriver extends Driver { private double maxTanL = 999.9; private int nHits = 6; - public void setDataRelationCollection (String val) { dataRelationCollection = val; @@ -96,7 +95,7 @@ public void setDataRelationCollection (String val) { public void setNHits (int val ) { nHits = val; } - + public void setMinMom (double val) { minMom = val; } @@ -121,8 +120,7 @@ public void setMaxTanL (double val) { maxTanL = val; } - - //Override the Z of the target. + // Override the Z of the target. public void setBsZ (double input) { bsZ = input; } @@ -130,7 +128,7 @@ public void setBsZ (double input) { public void setDoGBLresiduals (boolean input) { b_doGBLresiduals = input; } - + public void setDoGBLkinks (boolean input) { b_doGBLkinks = input; } @@ -194,14 +192,14 @@ public void process(EventHeader event) { LOGGER.info("Running on " + trackCollectionName); - //RelationalTable trackMatchTable = null; - //trackMatchTable = new BaseRelationalTable(RelationalTable.Mode.ONE_TO_ONE, RelationalTable.Weighting.UNWEIGHTED); - //List trackMatchRelation = event.get(LCRelation.class, "MatchedToGBLTrackRelations"); - //for (LCRelation relation : trackMatchRelation) { - // if (relation != null && relation.getFrom() != null && relation.getTo() != null) { - // trackMatchTable.add(relation.getFrom(), relation.getTo()); - // } - //} + // RelationalTable trackMatchTable = null; + // trackMatchTable = new BaseRelationalTable(RelationalTable.Mode.ONE_TO_ONE, RelationalTable.Weighting.UNWEIGHTED); + // List trackMatchRelation = event.get(LCRelation.class, "MatchedToGBLTrackRelations"); + // for (LCRelation relation : trackMatchRelation) { + // if (relation != null && relation.getFrom() != null && relation.getTo() != null) { + // trackMatchTable.add(relation.getFrom(), relation.getTo()); + // } + // } RelationalTable hitToStrips = TrackUtils.getHitToStripsTable(event); RelationalTable hitToRotated = TrackUtils.getHitToRotatedTable(event); @@ -225,22 +223,22 @@ public void process(EventHeader event) { LOGGER.info("Track passed nHits"); Hep3Vector momentum = new BasicHep3Vector(trk.getTrackStates().get(0).getMomentum()); - + if (momentum.magnitude() < minMom) continue; - + if (momentum.magnitude() > maxMom) continue; - + LOGGER.info("Track passed momentum"); - + TrackState trackState = trk.getTrackStates().get(0); if (Math.abs(trackState.getTanLambda()) < minTanL) continue; if (Math.abs(trackState.getTanLambda()) > maxTanL) continue; - + LOGGER.info("Track passed tanLambda"); if (Math.abs(trackState.getPhi()) < minPhi) @@ -248,17 +246,16 @@ public void process(EventHeader event) { if (Math.abs(trackState.getPhi()) > maxPhi) continue; - + LOGGER.info("Track passed phi"); - + GenericObject gblKink = GBLKinkData.getKinkData(event, trk); - + // if (gblKink == null) { // System.out.println("Failed finding gblKink object"); // System.out.println("Looked for: "+GBLKinkData.DATA_RELATION_COLLECTION); // System.out.println("Event has "+GBLKinkData.DATA_RELATION_COLLECTION+" "+event.hasCollection(LCRelation.class, GBLKinkData.DATA_RELATION_COLLECTION)); // } - // Track matchedTrack = (Track) trackMatchTable.from(trk); Map sensorHits = new HashMap(); @@ -267,7 +264,7 @@ public void process(EventHeader event) { if (hitToStrips != null && hitToRotated != null) hitsOnTrack = TrackUtils.getStripHits(trk, hitToStrips, hitToRotated); - + int i = 0; for (TrackerHit hit : hitsOnTrack) { HpsSiSensor sensor = ((HpsSiSensor) ((RawTrackerHit) hit.getRawHits().get(0)).getDetectorElement()); @@ -279,11 +276,11 @@ public void process(EventHeader event) { if (debug && sensor == null) LOGGER.info("TrackerHit null sensor " + hit.toString() + "\n"); - + i++; } - - //THIS IS TEMPORARY AND NEEDED FOR FIXING THE LOOP ON THE SENSORS ON TRACK FOR KALMAN TRACKS + + // THIS IS TEMPORARY AND NEEDED FOR FIXING THE LOOP ON THE SENSORS ON TRACK FOR KALMAN TRACKS if (hitsOnTrack.size() == 0) { for (TrackerHit hit : trk.getTrackerHits()) { HpsSiSensor sensor = ((HpsSiSensor) ((RawTrackerHit) hit.getRawHits().get(0)).getDetectorElement()); @@ -292,19 +289,18 @@ public void process(EventHeader event) { sensorNums.put(sensor, i); LOGGER.info("Adding sensor " + i + " \n"); } - + if (debug && sensor == null) LOGGER.info("TrackerHit null sensor " + hit.toString() + " \n"); - i++; + i++; } - } - + doBasicGBLtrack(trk,sensorHits); if (b_doGBLresiduals) doGBLresiduals(trk, sensorHits,event); - + // doMTresiduals(matchedTrack, sensorHits); if (b_doGBLkinks) doGBLkinks(trk,gblKink, sensorNums); @@ -312,12 +308,11 @@ public void process(EventHeader event) { } private void doGBLkinks(Track trk, GenericObject kink, Map sensorNums) { - + if (kink == null) { LOGGER.warning("Kink object is null"); return; } - String vol = "_top"; // unused variable int spacing = 0; @@ -325,12 +320,12 @@ private void doGBLkinks(Track trk, GenericObject kink, Map vol = "_bottom"; spacing = sensors.size() / 2 + mod; } - + for (HpsSiSensor sensor : sensorNums.keySet()) { int index = sensorNums.get(sensor); double phi = kink.getDoubleVal(index); float lambda = kink.getFloatVal(index); - + // (2019) For top 0-20, for bottom 25-45 aidaGBL.histogram2D(kinkFolder+"lambda_kink_mod").fill(sensor.getMillepedeId() + spacing,lambda); aidaGBL.profile1D(kinkFolder+"lambda_kink_mod_p").fill(sensor.getMillepedeId() + spacing,lambda); @@ -339,7 +334,6 @@ private void doGBLkinks(Track trk, GenericObject kink, Map aidaGBL.histogram1D(kinkFolder+"lambda_kink_" + sensor.getName()).fill(lambda); aidaGBL.histogram1D(kinkFolder+"phi_kink_" + sensor.getName()).fill(phi); } - } private void doMTresiduals(Track trk, Map sensorHits) { // currently not used @@ -359,7 +353,7 @@ private void doMTresiduals(Track trk, Map sensorHits) { LOGGER.info("MdiffSensor " + diff.toString() + " \n"); } } - + private void FillGBLTrackPlot(String str, String isTop, String charge, double val) { aidaGBL.histogram1D(str + isTop).fill(val); aidaGBL.histogram1D(str + isTop + charge).fill(val); @@ -374,40 +368,36 @@ private void FillGBLTrackPlot(String str, String isTop, String charge, double va aidaGBL.histogram3D(str + isTop).fill(valX, valY, valZ); aidaGBL.histogram3D(str + isTop + charge).fill(valX, valY, valZ); } - + private void doBasicGBLtrack(Track trk, MapsensorHits) { - private void doBasicGBLtrack(Track trk, Map sensorHits) { - TrackState trackState = trk.getTrackStates().get(0); String isTop = "_bottom"; - //if (trk.getTrackerHits().get(0).getPosition()[2] > 0) { - // isTop = "_top"; - //} + // if (trk.getTrackerHits().get(0).getPosition()[2] > 0) { + // isTop = "_top"; + // } - //if (trk.getType()==1 && trk.getTrackerHits().size() < 10) { - // return; - //} + // if (trk.getType()==1 && trk.getTrackerHits().size() < 10) { + // return; + // } + + // List missingHits; + // missingHits = findMissingLayer(trk); - //List missingHits; - //missingHits = findMissingLayer(trk); - if (trackState.getTanLambda() > 0) { isTop = "_top"; } - - //There is a sign flip in the charge + + // There is a sign flip in the charge String charge = "_pos"; - if (trk.getCharge()>0) + if (trk.getCharge() > 0) charge = "_neg"; - - - //Hep3Vector mom = new BasicHep3Vector(trackState.getMomentum()); - //System.out.println("Track momentum " + mom.toString()); + + // Hep3Vector mom = new BasicHep3Vector(trackState.getMomentum()); + // System.out.println("Track momentum " + mom.toString()); double trackp = new BasicHep3Vector(trackState.getMomentum()).magnitude(); - - + FillGBLTrackPlot(trkpFolder + "d0", isTop, charge, trackState.getD0()); FillGBLTrackPlot(trkpFolder + "z0", isTop, charge, trackState.getZ0()); FillGBLTrackPlot(trkpFolder + "phi", isTop, charge, trackState.getPhi()); @@ -419,32 +409,29 @@ private void doBasicGBLtrack(Track trk, Map sensorHits) FillGBLTrackPlot(trkpFolder + "p6h", isTop, charge, trackp); if (trk.getTrackerHits().size() == 5) FillGBLTrackPlot(trkpFolder + "p5h", isTop, charge, trackp); - + if (TrackUtils.isHoleTrack(trk)) FillGBLTrackPlot(trkpFolder + "p_hole", isTop, charge, trackp); else FillGBLTrackPlot(trkpFolder + "p_slot", isTop, charge, trackp); - - + // Momentum maps FillGBLTrackPlot(trkpFolder + "p_vs_phi", isTop, charge, trackState.getPhi(), trackp); FillGBLTrackPlot(trkpFolder + "p_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackp); FillGBLTrackPlot(trkpFolder + "p_vs_phi_tanLambda", isTop, charge, trackState.getPhi(), trackState.getTanLambda(), trackp); - + double tanLambda = trackState.getTanLambda(); double cosLambda = 1. / (Math.sqrt(1 + tanLambda * tanLambda)); - + FillGBLTrackPlot(trkpFolder + "pT_vs_phi", isTop, charge, trackState.getPhi(), trackp * cosLambda); FillGBLTrackPlot(trkpFolder + "pT_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackp * cosLambda); - - - //if (trk.getTrackerHits().size()==6) - // FillGBLTrackPlot(trkpFolder+"p_Missing1Hit",isTop,charge,missingHits.get(0),trackp); - - //if (missingHits.size()==1 && missingHits.get(0)==7) - // FillGBLTrackPlot(trkpFolder+"p_MissingLastLayer",isTop,charge,trackp); - - + + // if (trk.getTrackerHits().size()==6) + // FillGBLTrackPlot(trkpFolder+"p_Missing1Hit",isTop,charge,missingHits.get(0),trackp); + + // if (missingHits.size()==1 && missingHits.get(0)==7) + // FillGBLTrackPlot(trkpFolder+"p_MissingLastLayer",isTop,charge,trackp); + FillGBLTrackPlot(trkpFolder + "Chi2", isTop, charge, trk.getChi2()); FillGBLTrackPlot(trkpFolder + "Chi2_vs_p", isTop, charge, trackp, trk.getChi2()); @@ -462,61 +449,56 @@ private void doBasicGBLtrack(Track trk, Map sensorHits) LOGGER.info("beamspot " + beamspot.toString()); FillGBLTrackPlot(trkpFolder + "trk_extr_or_x", isTop, charge, beamspot.x()); FillGBLTrackPlot(trkpFolder + "trk_extr_or_y", isTop, charge, beamspot.y()); - - //Extrapolation to assumed tgt pos - helix + + // Extrapolation to assumed tgt pos - helix Hep3Vector trkTgt = CoordinateTransformations.transformVectorToDetector(TrackUtils.extrapolateHelixToXPlane(trackState, bsZ)); FillGBLTrackPlot(trkpFolder + "trk_extr_bs_x", isTop, charge, trkTgt.x()); FillGBLTrackPlot(trkpFolder + "trk_extr_bs_y", isTop, charge, trkTgt.y()); - - //Transform z to the beamspot plane - //Get the PathToPlane - + + // Transform z to the beamspot plane + // Get the PathToPlane BaseTrackState ts_bs = TrackUtils.getTrackExtrapAtVtxSurfRK(trackState, bFieldMap, 0., bsZ); - - - //Get the track parameters wrt the beamline using helix + + // Get the track parameters wrt the beamline using helix double [] beamLine = new double [] {bsZ, 0}; double [] helixParametersAtBS = TrackUtils.getParametersAtNewRefPoint(beamLine, trackState); - FillGBLTrackPlot(trkpFolder + "trk_extr_bs_x_rk", isTop, charge, ts_bs.getReferencePoint()[1]); FillGBLTrackPlot(trkpFolder + "trk_extr_bs_y_rk", isTop, charge, ts_bs.getReferencePoint()[2]); - //Ill defined - should be defined wrt bsX and bsY + // Ill defined - should be defined wrt bsX and bsY FillGBLTrackPlot(trkpFolder + "d0_vs_bs_rk", isTop, charge, ts_bs.getD0()); FillGBLTrackPlot(trkpFolder + "d0_vs_bs_extrap", isTop, charge, helixParametersAtBS[BaseTrack.D0]); - + double s = HelixUtils.PathToXPlane(TrackUtils.getHTF(trackState), bsZ, 0., 0).get(0); FillGBLTrackPlot(trkpFolder + "z0_vs_bs", isTop, charge, trackState.getZ0() + s*trackState.getTanLambda()); FillGBLTrackPlot(trkpFolder + "z0_vs_bs_rk", isTop, charge, ts_bs.getZ0()); FillGBLTrackPlot(trkpFolder + "z0_vs_bs_extrap", isTop, charge, helixParametersAtBS[BaseTrack.Z0]); - FillGBLTrackPlot(trkpFolder + "phi_vs_bs_extrap", isTop, charge, helixParametersAtBS[BaseTrack.PHI]); - - //TH2D - Filling + + // TH2D - Filling FillGBLTrackPlot(trkpFolder + "d0_vs_phi", isTop, charge, trackState.getPhi(), trackState.getD0()); FillGBLTrackPlot(trkpFolder + "d0_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackState.getD0()); FillGBLTrackPlot(trkpFolder + "d0_vs_p", isTop, charge, trackp, trackState.getD0()); - - //Ill defined - should be defined wrt bsX and bsY + + // Ill defined - should be defined wrt bsX and bsY FillGBLTrackPlot(trkpFolder + "d0bs_vs_p", isTop, charge, trackp, helixParametersAtBS[BaseTrack.D0]); - + FillGBLTrackPlot(trkpFolder + "z0_vs_p", isTop, charge, trackp, trackState.getZ0()); FillGBLTrackPlot(trkpFolder + "z0bs_vs_p", isTop, charge, trackp, ts_bs.getZ0()); - - //Interesting plot to get a sense where z-vtx is. - //If z0 is referenced to the right BS z location, the slope of vs tanLambda is 0 + + // Interesting plot to get a sense where z-vtx is. + // If z0 is referenced to the right BS z location, the slope of vs tanLambda is 0 FillGBLTrackPlot(trkpFolder + "z0_vs_tanLambda", isTop, charge, trackState.getTanLambda(), trackState.getZ0()); FillGBLTrackPlot(trkpFolder + "z0bs_vs_tanLambda", isTop,charge, trackState.getTanLambda(), ts_bs.getZ0()); - - + if (b_doDetailPlots) { int ibins = 15; double start = -12; double end = -5; double step = (end-start) / (double)ibins; - + for (int ibin = 0; ibin < ibins; ibin++) { double bslocZ = start + step * ibin; double s_bslocZ = HelixUtils.PathToXPlane(TrackUtils.getHTF(trackState), bslocZ, 0., 0).get(0); @@ -524,49 +506,47 @@ private void doBasicGBLtrack(Track trk, Map sensorHits) String ibinstr = String.valueOf(ibin); aidaGBL.histogram2D(trkpDetailFolder + "z0_vs_tanLambda_bsZ_" + ibinstr + isTop).fill(trackState.getTanLambda(), z0Corr); aidaGBL.profile1D(trkpDetailFolder + "z0_vs_tanLambda_bsZ_p_" + ibinstr + isTop).fill(trackState.getTanLambda(), z0Corr); - //System.out.printf("bslocZ %.5f s_bslocZ = %.5f z0C0rr %.5f \n", bslocZ, s_bslocZ, z0Corr); - //aidaGBL.histogram3D(trkpDetailFolder+"z0_vs_tanLambda_bsZ"+isTop).fill(bslocZ,trackState.getTanLambda(),z0Corr); - //aidaGBL.profile2D(trkpDetailFolder+"z0_vs_tanLambda_bsZ_p"+isTop).fill(bslocZ,trackState.getTanLambda(),z0Corr); - } + // System.out.printf("bslocZ %.5f s_bslocZ = %.5f z0C0rr %.5f \n", bslocZ, s_bslocZ, z0Corr); + // aidaGBL.histogram3D(trkpDetailFolder+"z0_vs_tanLambda_bsZ"+isTop).fill(bslocZ,trackState.getTanLambda(),z0Corr); + // aidaGBL.profile2D(trkpDetailFolder+"z0_vs_tanLambda_bsZ_p"+isTop).fill(bslocZ,trackState.getTanLambda(),z0Corr); + } } } - + private void doGBLresiduals(Track trk, Map sensorHits, EventHeader event) { - + Map sensorMPIDs = new HashMap(); double trackTime = 0.; double trackTimeSD = 0.; - for (HpsSiSensor sensor : sensorHits.keySet()) { - //Also fill here the sensorMPIDs map + // Also fill here the sensorMPIDs map sensorMPIDs.put(sensor.getMillepedeId(), sensor); ITransform3D trans = sensor.getGeometry().getGlobalToLocal(); - + // position of hit (track crossing the sensor before GBL extrapolation) // the hit information available on each sensor is meaningful only along the measurement direction, // Hep3Vector hitPos = new BasicHep3Vector(sensorHits.get(sensor).getPosition()); // instead: extract the information of the hit of the track at the sensor position before GBL TrackState trackState = trk.getTrackStates().get(0); Hep3Vector hitTrackPos = TrackStateUtils.getLocationAtSensor(trackState, sensor, bfield); - + if (hitTrackPos == null) { if (debug) { System.out.printf("GBLOutputDriver::doGBLresiduals:: hitTrackPos is null to sensor %s\n", sensor.toString()); } continue; } - + Hep3Vector hitTrackPosSensor = new BasicHep3Vector(hitTrackPos.v()); trans.transform(hitTrackPosSensor); // after the transformation x and y in the sensor frame are reversed // This plot is ill defined. - + aidaGBL.histogram2D(hitFolder + "hit_u_vs_v_sensor_frame_" + sensor.getName()).fill(hitTrackPosSensor.y(), hitTrackPosSensor.x()); - //aidaGBL.histogram2D("hit_u_vs_v_sensor_frame_" + sensor.getName()).fill(hitPos.y(), hitPos.x()); - //aidaGBL.histogram2D("hit y vs x lab-frame " + sensor.getName()).fill(hitPos.y(), hitPos.x()); - - + // aidaGBL.histogram2D("hit_u_vs_v_sensor_frame_" + sensor.getName()).fill(hitPos.y(), hitPos.x()); + // aidaGBL.histogram2D("hit y vs x lab-frame " + sensor.getName()).fill(hitPos.y(), hitPos.x()); + // position predicted on track after GBL Hep3Vector extrapPos = null; Hep3Vector extrapPosSensor = null; @@ -575,7 +555,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, return; extrapPosSensor = new BasicHep3Vector(extrapPos.v()); trans.transform(extrapPosSensor); - //aidaGBL.histogram2D("residual after GBL vs u predicted " + sensor.getName()).fill(extrapPosSensor.x(), res); + // aidaGBL.histogram2D("residual after GBL vs u predicted " + sensor.getName()).fill(extrapPosSensor.x(), res); aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); // select track charge if(trk.getCharge()>0) { @@ -583,7 +563,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, }else if(trk.getCharge()<0) { aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_neg_sensor_frame_" + sensor.getName()).fill(extrapPosSensor.y(), extrapPosSensor.x()); } - + // post-GBL residual Hep3Vector hitPos = new BasicHep3Vector(sensorHits.get(sensor).getPosition()); Hep3Vector hitPosSensor = new BasicHep3Vector(hitPos.v()); @@ -593,9 +573,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_u_hit_" + sensor.getName()).fill(hitPosSensor.x(), resSensor.x()); aidaGBL.histogram1D(resFolder + "residual_after_GBL_" + sensor.getName()).fill(resSensor.x()); - trackTime += sensorHits.get(sensor).getTime(); - if (debug) { System.out.printf("hitPos %s hitPosSensor %s \n", hitPos.toString(), hitPosSensor.toString()); @@ -612,16 +590,16 @@ private void doGBLresiduals(Track trk, Map sensorHits, Hep3Vector testZ = trans.inverse().rotated(new BasicHep3Vector(0, 0, 1)); System.out.printf("unMeasCoord %s MeasCoord %s \n transX %s transY %s transZ %s \n", unmeasuredCoordinate.toString(), measuredCoordinate.toString(), testX.toString(), testY.toString(), testZ.toString()); } - }//loop on sensor hits + }// loop on sensor hits trackTime /= (float)sensorHits.size(); - + for (HpsSiSensor sensor : sensorHits.keySet()) { trackTimeSD += Math.pow(trackTime - sensorHits.get(sensor).getTime(), 2); } - + trackTimeSD = Math.sqrt(trackTimeSD / ((float) sensorHits.size() - 1.)); - + RelationalTable trackResidualsTable = null; if (event.hasCollection(LCRelation.class, trackResidualsRelColName)) { trackResidualsTable = new BaseRelationalTable(RelationalTable.Mode.ONE_TO_ONE, RelationalTable.Weighting.UNWEIGHTED); @@ -632,26 +610,26 @@ private void doGBLresiduals(Track trk, Map sensorHits, } } } else { - //System.out.println("null TrackResidualsGBL Data Relations."); - //Failed finding TrackResidualsGBL + // System.out.println("null TrackResidualsGBL Data Relations."); + // Failed finding TrackResidualsGBL return; } - + GenericObject trackRes = (GenericObject) trackResidualsTable.from(trk); if (trackRes == null) { - //System.out.println("null TrackResidualsGBL Data."); + // System.out.println("null TrackResidualsGBL Data."); return; } - - //it's bias-unbias-bias-unbias-bias-unbias.... - //TODO add in trackRes the number of hits on tracks ? + + // it's bias-unbias-bias-unbias-bias-unbias.... + // TODO add in trackRes the number of hits on tracks ? int nres = (trackRes.getNInt() - 1); - + String vol = "_top"; if (trk.getTrackStates().get(0).getTanLambda() < 0) vol = "_bottom"; - //get the bias first + // get the bias first for (int i_hit =0; i_hit <= nres-1 ; i_hit+=2) { if (trackRes.getIntVal(i_hit) != -999) { LOGGER.info("PF: "+ trackCollectionName+ " trackRes.getIntVal(i_hit) " + trackRes.getIntVal(i_hit)); @@ -659,22 +637,22 @@ private void doGBLresiduals(Track trk, Map sensorHits, LOGGER.info("NHits " + nres + " MPID sensor:" + trackRes.getIntVal(i_hit) + " " + sensorName + " " + i_hit); LOGGER.info("Track residuals: " + sensorName + " " + trackRes.getDoubleVal(i_hit) + " " + trackRes.getFloatVal(i_hit)); - - //General residuals Per volume + + // General residuals Per volume aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol).fill(trackRes.getDoubleVal(i_hit)); - + if (trackRes.getIntVal(i_hit) < 9) - //L1L4 + // L1L4 aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L1L4").fill(trackRes.getDoubleVal(i_hit)); else - //L5L7 + // L5L7 aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L5L7").fill(trackRes.getDoubleVal(i_hit)); - - //Top go from 0 to 20, bottom go from 25 to 45 + + // Top go from 0 to 20, bottom go from 25 to 45 int spacing = 0; if (vol == "_bottom") spacing = sensors.size() / 2 + mod; - + aidaGBL.histogram2D(resFolder + "bresidual_GBL_mod").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); aidaGBL.profile1D(resFolder + "bresidual_GBL_mod_p").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); @@ -689,7 +667,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, // get the unbias for (int i_hit = 1; i_hit <= nres-1 ; i_hit+=2) { if (trackRes.getIntVal(i_hit) != -999) { - //Measured hit + // Measured hit HpsSiSensor hps_sensor = sensorMPIDs.get(trackRes.getIntVal(i_hit)); Hep3Vector hitPosG = new BasicHep3Vector(sensorHits.get(hps_sensor).getPosition()); Hep3Vector hitPosSensorG = new BasicHep3Vector(hitPosG.v()); @@ -697,7 +675,7 @@ private void doGBLresiduals(Track trk, Map sensorHits, g2l.transform(hitPosSensorG); String sensorName = (sensorMPIDs.get(trackRes.getIntVal(i_hit))).getName(); - //Predicted hit + // Predicted hit Hep3Vector extrapPos = null; Hep3Vector extrapPosSensor = null; extrapPos = TrackUtils.extrapolateTrackPositionToSensor(trk, hps_sensor, sensors, bfield); @@ -705,26 +683,25 @@ private void doGBLresiduals(Track trk, Map sensorHits, continue; extrapPosSensor = new BasicHep3Vector(extrapPos.v()); g2l.transform(extrapPosSensor); - + LOGGER.info("NHits " + nres + " MPID sensor:" + trackRes.getIntVal(i_hit) + " " + sensorName + " " + i_hit); LOGGER.info("Track uresiduals: " + sensorName + " " + trackRes.getDoubleVal(i_hit) + " " + trackRes.getFloatVal(i_hit)); - //General residuals Per volume + // General residuals Per volume aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol).fill(trackRes.getDoubleVal(i_hit)); - + if (trackRes.getIntVal(i_hit) < 9) - //L1L4 + // L1L4 aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L1L4").fill(trackRes.getDoubleVal(i_hit)); else - //L5L7 + // L5L7 aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L5L7").fill(trackRes.getDoubleVal(i_hit)); - - - //Top go from 0 to 20, bottom go from 25 to 45 + + // Top go from 0 to 20, bottom go from 25 to 45 int spacing = 0; if (vol == "_bottom") spacing = sensors.size()/2 + mod; - + aidaGBL.histogram2D(resFolder + "uresidual_GBL_mod").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); aidaGBL.profile1D(resFolder + "uresidual_GBL_mod_p").fill(trackRes.getIntVal(i_hit) + spacing, trackRes.getDoubleVal(i_hit)); aidaGBL.histogram1D(resFolder + "uresidual_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit)); @@ -732,15 +709,14 @@ private void doGBLresiduals(Track trk, Map sensorHits, aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_v_pred_" + sensorName).fill(extrapPosSensor.y(), trackRes.getDoubleVal(i_hit)); aidaGBL.histogram1D(epullFolder + "ureserror_GBL_" + sensorName).fill(trackRes.getFloatVal(i_hit)); aidaGBL.histogram1D(epullFolder + "ures_pull_GBL_" + sensorName).fill(trackRes.getDoubleVal(i_hit) / trackRes.getFloatVal(i_hit)); - - //Get the hit time + + // Get the hit time double hitTime = sensorHits.get(hps_sensor).getTime(); - - //Get the track time (it's the average of hits-on-track time) - + + // Get the track time (it's the average of hits-on-track time) double dT_hit_track = hitTime - trackTime; double dT_hit_sigma = (hitTime - trackTime) / trackTimeSD; - + aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_dT_hit_" + sensorName).fill(dT_hit_track, trackRes.getDoubleVal(i_hit)); aidaGBL.histogram2D(resFolder + "uresidual_GBL_vs_dTs_hit_" + sensorName).fill(dT_hit_sigma, trackRes.getDoubleVal(i_hit)); } @@ -748,10 +724,10 @@ private void doGBLresiduals(Track trk, Map sensorHits, LOGGER.info("Track refit failed? No unbiased residual for " + i_hit); } } - }//doGBLresiduals - + }// doGBLresiduals + private List findMissingLayer(Track trk) { - + List layers = new ArrayList(); layers.add(1); layers.add(2); @@ -760,14 +736,14 @@ private List findMissingLayer(Track trk) { layers.add(5); layers.add(6); layers.add(7); - + List LayersOnTrack = new ArrayList(); List missingHits = new ArrayList(); - + for (TrackerHit hit : trk.getTrackerHits()) { - + int stripLayer = ((HpsSiSensor) ((RawTrackerHit) hit.getRawHits().get(0)).getDetectorElement()).getLayerNumber(); - + int hpslayer = (stripLayer + 1 ) / 2; LayersOnTrack.add(hpslayer); } @@ -776,21 +752,20 @@ private List findMissingLayer(Track trk) { if (!LayersOnTrack.contains(layer)) missingHits.add(layer); } - + return missingHits; } - private void setupPlots() { double xmax = 0.25; double kxmax = 0.001; // unused variable - + int nbins = 250; List volumes = new ArrayList(); volumes.add("_top"); volumes.add("_bottom"); int mod_2dplot_bins = sensors.size() + mod*2; - + for (String vol : volumes) { aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol, nbins, -xmax, xmax); aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol, nbins, -xmax, xmax); @@ -798,28 +773,25 @@ private void setupPlots() { aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L1L4", nbins, -xmax, xmax); aidaGBL.histogram1D(resFolder + "bresidual_GBL" + vol + "_L5L7", nbins, -xmax, xmax); aidaGBL.histogram1D(resFolder + "uresidual_GBL" + vol + "_L5L7", nbins, -xmax, xmax); - } - - //res/kinks TH2D - //5 empty bins to distinguish between top and bottom + + // res/kinks TH2D + // 5 empty bins to distinguish between top and bottom aidaGBL.histogram2D(resFolder + "bresidual_GBL_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, nbins, -xmax, xmax); aidaGBL.profile1D(resFolder + "bresidual_GBL_mod_p", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5); aidaGBL.histogram2D(resFolder + "uresidual_GBL_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, 400, -0.4, 0.4); aidaGBL.profile1D(resFolder + "uresidual_GBL_mod_p", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5); - - - for (SiSensor sensor : sensors) { + for (SiSensor sensor : sensors) { HpsSiSensor sens = (HpsSiSensor) sensor.getGeometry().getDetectorElement(); xmax = 0.5; nbins = 250; int l = (sens.getLayerNumber() + 1) / 2; if (l > 1) xmax = 0.05 + (l - 1) * 0.08; aidaGBL.histogram1D(resFolder+"residual_before_GBL_" + sensor.getName(), nbins, -xmax, xmax); - + xmax = 0.250; - + if (l >= 6) xmax = 0.250; aidaGBL.histogram1D(resFolder + "residual_after_GBL_" + sensor.getName(), nbins, -xmax, xmax); @@ -833,14 +805,14 @@ private void setupPlots() { aidaGBL.histogram1D(epullFolder + "ureserror_GBL_" + sensor.getName(), nbins, 0.0, 0.2); aidaGBL.histogram1D(epullFolder + "bres_pull_GBL_" + sensor.getName(), nbins, -5, 5); aidaGBL.histogram1D(epullFolder + "ures_pull_GBL_" + sensor.getName(), nbins, -5, 5); - + aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_u_hit_" + sensor.getName(), 100, -20.0, 20.0, 100, -0.04, 0.04); aidaGBL.histogram2D(resFolder + "residual_after_GBL_vs_v_predicted_" + sensor.getName(), 100, -55.0, 55.0, 100, -0.04, 0.04); aidaGBL.histogram2D(hitFolder + "hit_u_vs_v_sensor_frame_" + sensor.getName(), 300, -60.0, 60.0, 300, -25, 25); aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_pos_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); aidaGBL.histogram2D(hitFolder + "predicted_u_vs_v_neg_sensor_frame_" + sensor.getName(), 100, -60, 60, 100, -25, 25); - + xmax = 0.0006; if(l == 1){ xmax = 0.0002; @@ -857,30 +829,30 @@ private void setupPlots() { aidaGBL.histogram1D(kinkFolder + "lambda_kink_" + sensor.getName(), 250, -xmax, xmax); aidaGBL.histogram1D(kinkFolder + "phi_kink_" + sensor.getName(), 250, -xmax, xmax); } - + aidaGBL.histogram2D(kinkFolder + "lambda_kink_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, nbins, -0.001, 0.001); aidaGBL.profile1D(kinkFolder + "lambda_kink_mod_p", mod_2dplot_bins, -0.5,mod_2dplot_bins-0.5); aidaGBL.histogram2D(kinkFolder + "phi_kink_mod", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5, nbins, -0.001, 0.001); aidaGBL.profile1D(kinkFolder + "phi_kink_mod_p", mod_2dplot_bins, -0.5, mod_2dplot_bins-0.5); - + List charges = new ArrayList(); charges.add(""); charges.add("_pos"); charges.add("_neg"); - + int nbins_t = 200; - - //For momentum + + // For momentum int nbins_p = 150; double pmax = 8.; - + double z0max = 1; double d0max = 5; // unused variable double z0bsmax = 0.2; - + for (String vol : volumes) { for (String charge : charges) { - //TH1Ds + // TH1Ds aidaGBL.histogram1D(trkpFolder + "d0" + vol + charge, nbins_t, -5.0, 5.0); aidaGBL.histogram1D(trkpFolder + "z0" + vol + charge, nbins_t, -1.3, 1.3); aidaGBL.histogram1D(trkpFolder + "phi" + vol + charge, nbins_t, -0.06, 0.06); @@ -892,7 +864,7 @@ private void setupPlots() { aidaGBL.histogram1D(trkpFolder + "p_MissingLastLayer" + vol + charge, nbins_p, 0., pmax); aidaGBL.histogram1D(trkpFolder + "p_hole" + vol + charge, nbins_p, 0., pmax); aidaGBL.histogram1D(trkpFolder + "p_slot" + vol + charge, nbins_p, 0., pmax); - + aidaGBL.histogram1D(trkpFolder + "Chi2" + vol + charge, nbins_t*2, 0, 200); aidaGBL.histogram1D(trkpFolder + "nHits" + vol + charge, 15, 0, 15); aidaGBL.histogram1D(trkpFolder + "trk_extr_or_x" + vol + charge, nbins_t, -3, 3); @@ -907,13 +879,11 @@ private void setupPlots() { aidaGBL.histogram1D(trkpFolder + "z0_vs_bs_extrap" + vol + charge, 2*nbins_t, -z0bsmax, z0bsmax); aidaGBL.histogram1D(trkpFolder + "z0_vs_bs" + vol + charge, 2*nbins_t, -z0bsmax, z0bsmax); aidaGBL.histogram1D(trkpFolder + "phi_vs_bs_extrap" + vol + charge, 2*nbins_t, -0.06, 0.06); - - - //TH2Ds - + + // TH2Ds aidaGBL.histogram2D(trkpFolder + "d0_vs_phi" + vol + charge, nbins_t, -0.3, 0.3, nbins_t, -5.0, 5.0); aidaGBL.histogram2D(trkpFolder + "Chi2_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t*2, 0, 200); - //aidaGBL.histogram2D("d0_vs_phi_bs"+vol+charge,nbins_t,-5.0,5.0,nbins_t,-0.3,0.3); + // aidaGBL.histogram2D("d0_vs_phi_bs"+vol+charge,nbins_t,-5.0,5.0,nbins_t,-0.3,0.3); aidaGBL.histogram2D(trkpFolder + "d0_vs_tanLambda" + vol + charge, nbins_t, -0.2, 0.2, nbins_t, -5.0, 5.0); aidaGBL.histogram2D(trkpFolder + "d0_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t, -5.0, 5.0); aidaGBL.histogram2D(trkpFolder + "d0bs_vs_p" + vol + charge, nbins_p, 0.0, pmax, nbins_t, -5.0, 5.0); @@ -929,11 +899,9 @@ private void setupPlots() { aidaGBL.histogram2D(trkpFolder + "pT_vs_phi" + vol + charge, nbins_t, -0.3, 0.3, nbins_p, 0., pmax); aidaGBL.histogram2D(trkpFolder + "pT_vs_tanLambda" + vol + charge, nbins_t, -0.2, 0.2, nbins_p, 0., pmax); - - if (b_doDetailPlots) { - //TH2Ds - detail + // TH2Ds - detail int ibins = 15; double start= -12; double end = -5; @@ -943,13 +911,13 @@ private void setupPlots() { aidaGBL.histogram2D(trkpDetailFolder + "z0_vs_tanLambda_bsZ_" + ibinstr + vol, nbins_t, -0.1, 0.1, nbins_t, -z0max, z0max); aidaGBL.profile1D(trkpDetailFolder + "z0_vs_tanLambda_bsZ_p_" + ibinstr + vol, nbins_t, -0.1, 0.1); } - //aidaGBL.histogram3D("z0_vs_tanLambda_bsZ"+vol,60,-12,-6,nbins_t,-0.1,0.1,nbins_t,-z0max,z0max); - //aidaGBL.profile2D("z0_vs_tanLambda_bsZ_p"+vol,60,-12,6,nbins_t,-0.1,0.1); + // aidaGBL.histogram3D("z0_vs_tanLambda_bsZ"+vol,60,-12,-6,nbins_t,-0.1,0.1,nbins_t,-z0max,z0max); + // aidaGBL.profile2D("z0_vs_tanLambda_bsZ_p"+vol,60,-12,6,nbins_t,-0.1,0.1); } - }//charge loop - }//vol loop + }// charge loop + }// vol loop } - + public void endOfData() { if (outputPlots != null) { try { @@ -966,7 +934,6 @@ public void endOfData() { if (obj instanceof IBaseHistogram) aidaGBL.tree().rm(obj.name()); } } - } catch (IOException ex) { LOGGER.log(Level.SEVERE, null, ex); } From c039802769440799ab5dd426208f33f5dad2f598 Mon Sep 17 00:00:00 2001 From: Sarah Gaiser Date: Tue, 18 Apr 2023 16:31:19 -0700 Subject: [PATCH 5/8] Doxygen and cleanup --- .gitignore | 4 + Doxyfile | 2706 +++++++++++++++++ .../recon/AlignmentMonitoringKF.lcsim | 2 +- .../recon/tracking/gbl/GBLOutputDriver.java | 3 +- .../recon/tracking/gbl/KalmanToGBLDriver.java | 137 +- .../tracking/gbl/SimpleGBLTrajAliDriver.java | 820 +++-- .../tracking/kalman/KalmanPatRecDriver.java | 7 +- 7 files changed, 3133 insertions(+), 546 deletions(-) create mode 100644 Doxyfile diff --git a/.gitignore b/.gitignore index a3b9e65387..f8b1f365dd 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,7 @@ latex/ # editor swap files .*.swp + +# doxygen documentation +html/ +latex/ diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000000..2ee47ef81d --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2706 @@ +# Doxyfile 1.9.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "My Project" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = YES + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.py + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /