sbndcode/sbndcode/CosmicId/Algs/CosmicIdAlg.h

Go to the documentation of this file.

#ifndef COSMICIDALG_H_SEEN
#define COSMICIDALG_H_SEEN


///////////////////////////////////////////////
// CosmicIdAlg.h
//
// Functions for fiducial volume cosmic tagger
// T Brooks (tbrooks@fnal.gov), November 2018
///////////////////////////////////////////////

#include "sbndcode/CosmicId/Algs/FiducialVolumeCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/StoppingParticleCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/GeometryCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/CpaCrossCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/ApaCrossCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/CrtHitCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/CrtTrackCosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/PandoraT0CosmicIdAlg.h"
#include "sbndcode/CosmicId/Algs/PandoraNuScoreCosmicIdAlg.h"
#include "sbndcode/CosmicId/Utils/CosmicIdUtils.h"

// framework
#include "art/Framework/Principal/Event.h"
#include "fhiclcpp/ParameterSet.h" 
#include "fhiclcpp/types/Table.h"
#include "fhiclcpp/types/Atom.h"
#include "art/Framework/Principal/Handle.h" 
#include "canvas/Persistency/Common/Ptr.h" 

// LArSoft
#include "lardataobj/RecoBase/Track.h"
#include "lardataobj/RecoBase/Hit.h"
#include "lardataobj/RecoBase/PFParticle.h"
#include "lardataobj/AnalysisBase/T0.h"
#include "lardataobj/AnalysisBase/Calorimetry.h"

// c++
#include <vector>
#include <utility>


namespace sbnd{

  class CosmicIdAlg {
  public:

    struct BeamTime {
      using Name = fhicl::Name;
      using Comment = fhicl::Comment;

      fhicl::Atom<double> BeamTimeMin {
        Name("BeamTimeMin"),
        Comment("")
      };

      fhicl::Atom<double> BeamTimeMax {
        Name("BeamTimeMax"),
        Comment("")
      };

    };

    struct Config {
      using Name = fhicl::Name;
      using Comment = fhicl::Comment;

      fhicl::Atom<art::InputTag> CrtHitModuleLabel {
        Name("CrtHitModuleLabel"),
        Comment("tag of CRT hit producer data product")
      };

      fhicl::Atom<art::InputTag> CrtTrackModuleLabel {
        Name("CrtTrackModuleLabel"),
        Comment("tag of CRT track producer data product")
      };

      fhicl::Atom<art::InputTag> TpcTrackModuleLabel {
        Name("TpcTrackModuleLabel"),
        Comment("tag of TPC track producer data product")
      };

      fhicl::Atom<art::InputTag> CaloModuleLabel {
        Name("CaloModuleLabel"),
        Comment("tag of calorimetry producer data product")
      };

      fhicl::Atom<art::InputTag> PandoraLabel {
        Name("PandoraLabel"),
        Comment("tag of pandora data product")
      };

      fhicl::Atom<bool> ApplyFiducialCut {
        Name("ApplyFiducialCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyStoppingCut {
        Name("ApplyStoppingCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyGeometryCut {
        Name("ApplyGeometryCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyCpaCrossCut {
        Name("ApplyCpaCrossCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyApaCrossCut {
        Name("ApplyApaCrossCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyCrtTrackCut {
        Name("ApplyCrtTrackCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyCrtHitCut {
        Name("ApplyCrtHitCut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyPandoraT0Cut {
        Name("ApplyPandoraT0Cut"),
        Comment("")
      };

      fhicl::Atom<bool> ApplyPandoraNuScoreCut {
        Name("ApplyPandoraNuScoreCut"),
        Comment("")
      };

      fhicl::Atom<bool> UseTrackAngleVeto {
        Name("UseTrackAngleVeto"),
        Comment("")
      };

      fhicl::Atom<double> MinSecondTrackLength {
        Name("MinSecondTrackLength"),
        Comment("")
      };

      fhicl::Atom<double> MinVertexDistance {
        Name("MinVertexDistance"),
        Comment("")
      };

      fhicl::Atom<double> MinMergeAngle {
        Name("MinMergeAngle"),
        Comment("")
      };

      fhicl::Table<FiducialVolumeCosmicIdAlg::Config> FVTagAlg {
        Name("FVTagAlg"),
      };

      fhicl::Table<StoppingParticleCosmicIdAlg::Config> SPTagAlg {
        Name("SPTagAlg"),
      };

      fhicl::Table<CpaCrossCosmicIdAlg::Config> CCTagAlg {
        Name("CCTagAlg"),
      };

      fhicl::Table<ApaCrossCosmicIdAlg::Config> ACTagAlg {
        Name("ACTagAlg"),
      };

      fhicl::Table<CrtHitCosmicIdAlg::Config> CHTagAlg {
        Name("CHTagAlg"),
      };

      fhicl::Table<CrtTrackCosmicIdAlg::Config> CTTagAlg {
        Name("CTTagAlg"),
      };

      fhicl::Table<PandoraT0CosmicIdAlg::Config> PTTagAlg {
        Name("PTTagAlg"),
      };

      fhicl::Table<PandoraNuScoreCosmicIdAlg::Config> PNTagAlg {
        Name("PNTagAlg"),
      };

      fhicl::Table<BeamTime> BeamTimeLimits {
        Name("BeamTimeLimits"),
        Comment("")
      };

    };

    CosmicIdAlg(const Config& config);

    CosmicIdAlg(const fhicl::ParameterSet& pset) :
      CosmicIdAlg(fhicl::Table<Config>(pset, {})()) {}

    CosmicIdAlg();

    ~CosmicIdAlg();

    void reconfigure(const Config& config);

    // Change which cuts are run
    void SetCuts(bool FV, bool SP, bool Geo, bool CC, bool AC, bool CT, bool CH, bool PT, bool PN);

    // Reset which cuts are run from fhicl parameters
    void ResetCuts();

    // Run cuts to decide if track looks like a cosmic
    bool CosmicId(recob::Track track, const art::Event& event, std::vector<double> t0Tpc0, std::vector<double> t0Tpc1);

    // Run cuts to decide if PFParticle looks like a cosmic
    bool CosmicId(detinfo::DetectorPropertiesData const& detProp,
                  recob::PFParticle pfparticle, std::map< size_t, art::Ptr<recob::PFParticle> > pfParticleMap, const art::Event& event, std::vector<double> t0Tpc0, std::vector<double> t0Tpc1);

    // Getters for the underlying algorithms
    StoppingParticleCosmicIdAlg StoppingAlg() const {return spTag;}
    CrtHitCosmicIdAlg CrtHitAlg() const {return chTag;}
    CrtTrackCosmicIdAlg CrtTrackAlg() const {return ctTag;}
    ApaCrossCosmicIdAlg ApaAlg() const {return acTag;}
    PandoraNuScoreCosmicIdAlg PandoraNuScoreAlg() const {return pnTag;}

  private:

    double fBeamTimeMin;
    double fBeamTimeMax;

    art::InputTag fTpcTrackModuleLabel;
    art::InputTag fPandoraLabel;
    art::InputTag fCrtHitModuleLabel;
    art::InputTag fCrtTrackModuleLabel;
    art::InputTag fCaloModuleLabel;

    bool fApplyFiducialCut;
    bool fApplyStoppingCut;
    bool fApplyGeometryCut;
    bool fApplyCpaCrossCut;
    bool fApplyApaCrossCut;
    bool fApplyCrtTrackCut;
    bool fApplyCrtHitCut;
    bool fApplyPandoraT0Cut;
    bool fApplyPandoraNuScoreCut;

    std::vector<bool> fOriginalSettings;

    bool fUseTrackAngleVeto;
    double fMinSecondTrackLength;
    double fMinVertexDistance;
    double fMinMergeAngle;

    FiducialVolumeCosmicIdAlg    fvTag;
    StoppingParticleCosmicIdAlg  spTag;
    GeometryCosmicIdAlg          geoTag;
    CpaCrossCosmicIdAlg          ccTag;
    ApaCrossCosmicIdAlg          acTag;
    CrtHitCosmicIdAlg            chTag;
    CrtTrackCosmicIdAlg          ctTag;
    PandoraT0CosmicIdAlg         ptTag;
    PandoraNuScoreCosmicIdAlg    pnTag;

  };

}

#endif