ParticleFilterModule.cxx

Go to the documentation of this file.

// $Id: ParticleFilterModule.cxx,v 1.3 2003/12/16 03:23:46 vahle Exp $
//
// Filters data using information from CandCalDetPIDHandle objects
//
// kordosky@hep.utexas.edu
#include "CalDetDST/ParticleFilterModule.h"
#include "CalDetPID/CalDetParticleType.h"
#include "CalDetPID/CandCalDetPIDHandle.h"
#include "CalDetPID/NtpCalDetPID.h"
#include "CalDetDST/UberRecord.h"
#include "CalDetDST/UberRecordLite.h"
#include "MessageService/MsgService.h"
#include "MinosObjectMap/MomNavigator.h"
#include "JobControl/JobCModuleRegistry.h" // For JOBMODULE macro
#include "DataUtil/GetCandidate.h"

JOBMODULE(ParticleFilterModule, "ParticleFilterModule",
          "Filters events based on CandCalDetPID objects");
CVSID("$Id: ParticleFilterModule.cxx,v 1.3 2003/12/16 03:23:46 vahle Exp $");
//......................................................................

ParticleFilterModule::ParticleFilterModule()
{
//======================================================================
// Default constructor
//======================================================================
}

//......................................................................

ParticleFilterModule::~ParticleFilterModule()
{
//======================================================================
// Destructor
//======================================================================
}

//......................................................................

void ParticleFilterModule::BeginJob()
{
//======================================================================
// blah
//======================================================================
}

//......................................................................

JobCResult ParticleFilterModule::Ana(const MomNavigator* mom)
{
//======================================================================
// 
//======================================================================
   MSG("CalDetDST",Msg::kDebug)<<"In Particle filter mod, ana"<<endl;
     JobCResult result=JobCResult::kPassed;
     bool got_nada=true;
     Int_t ptype = CalDetParticleType::kUnknown;
     Bool_t nov = kFALSE;
     Bool_t inct = kFALSE;
     Float_t olchi2 = 0.;
     
     if(fUseDST==0){
          const CandCalDetPIDHandle* cpidh_ptr= 
               DataUtil::GetCandidate<CandCalDetPIDHandle>(mom,
                               "CandCalDetPIDHandle");

          ptype=cpidh_ptr->GetPIDType();
          nov=cpidh_ptr->NoOverlap();
          inct=cpidh_ptr->InCERTime();
          olchi2=cpidh_ptr->GetOLChi2();
          got_nada=false;
     }
     else{
          const UberRecord* ur=
               dynamic_cast<const UberRecord*>(mom->GetFragment("UberRecord"));
          if(ur!=0){
               ptype=ur->cpid.pid;
               nov=ur->cpid.nov;
               inct=ur->cpid.inct;
               olchi2=ur->cpid.olchi2;
               got_nada=false;
          }
          else{
               const UberRecordLite* url=
                    dynamic_cast<const UberRecordLite*>
                    (mom->GetFragment("UberRecordLite"));
               if(url!=0){
                    ptype=url->cpid.pid;
                    nov=url->cpid.nov;
                    inct=url->cpid.inct;
                    got_nada=false;
               }
          }
     }

     // fail an event for which I can't find pid information
     if(got_nada){
          if(fUseDST==0){
               MSG("CalDetDST", Msg::kWarning)<<"Could not find a CandCalDetPIDHandle to use in the PID selection.\nI'll fail this event!"<<endl;
          }
          else{
               MSG("CalDetDST", Msg::kWarning)<<"Could not find an UberRecord or UberRecordLite to use in the PID selection.\nI'll fail this event!"<<endl;
          }
          return JobCResult::kFailed;
     }

     // filter based on particle type
     if(ptype&fParticleType){
          // pass this event
          MSG("CalDetDST", Msg::kDebug)
               <<"Configured to pass: "
               <<CalDetParticleType::AsString(fParticleType)<<"\n"
               <<"Passing a: "<<CalDetParticleType::AsString(ptype)<<endl;
     }
     else{
          // fail it
          result=JobCResult::kFailed;
          MSG("CalDetDST", Msg::kDebug)
               <<"Configured to pass: "
               <<CalDetParticleType::AsString(fParticleType)<<"\n"
               <<"Failing a: "<<CalDetParticleType::AsString(ptype)<<endl;
     }

     // filter based on overlap criterion
     if(fCutOverlaps){
          if(nov){
               MSG("CalDetDST", Msg::kDebug)<<"Not an overlap."<<endl;
          }
          else{
               MSG("CalDetDST", Msg::kDebug)<<"An overlap."<<endl;
               result=JobCResult::kFailed;
          }
     }

     if(fCutCerTime){
        if(inct){
           MSG("CalDetDST", Msg::kDebug)<<"Cerenkov in time."<<endl;
        }
        else{
           MSG("CalDetDST", Msg::kDebug)<<"Cerenkov not in time."<<endl;
           result=JobCResult::kFailed;
        }
     }
     
     if(fCutChi2){
        if(olchi2<fChi2Limit){
           MSG("CalDetDST", Msg::kDebug)<<"olchi2 below "<<fChi2Limit<<endl;
        }
        else{
           MSG("CalDetDST", Msg::kDebug)<<"olchi2 above "<<fChi2Limit<<endl;
           result=JobCResult::kFailed;
        }
     } 
     
     return result;
}

//......................................................................

const Registry& ParticleFilterModule::DefaultConfig() const
{
//======================================================================
// Supply the default configuration for the module
//======================================================================
  static Registry r; // Default configuration for module

  // Set name of config
  std::string name = this->GetName();
  name += ".config.default";
  r.SetName(name.c_str());

  // Set values in configuration
  r.UnLockValues();
  // by default look for electrons
  r.Set("ParticleType", CalDetParticleType::kElectron);

  r.Set("CutOverlaps", 0); // do not cut out overlaps by default
  r.Set("CutCerTime", 0); // do not cut out overlaps by default
  r.Set("CutChi2",0); //do not cut out chi2 by default
  r.Set("Chi2Limit",1.1); //set default limit of chi2 cut at <1.1
  r.Set("UseDST", 0); // do not try to use the uberdst by default

  r.LockValues();

  return r;
}

//......................................................................

void ParticleFilterModule::Config(const Registry& r)
{
//======================================================================
// Configure the module given the Registry r
//======================================================================
  int    tmpi;

  if (r.Get("ParticleType",tmpi)) { fParticleType = tmpi; }
  if (r.Get("CutOverlaps", tmpi)) { fCutOverlaps = tmpi; }
  if (r.Get("CutCerTime", tmpi)) { fCutCerTime = tmpi; }
  if (r.Get("CutChi2", tmpi)) {fCutChi2=tmpi;}
  if (r.Get("UseDST", tmpi)) { fUseDST = tmpi; }
  
  double tmpf;
  if (r.Get("Chi2Limit",tmpf)) {fChi2Limit = (Float_t)tmpf; }

}

//......................................................................

void ParticleFilterModule::Help()
{
//======================================================================
// Prints a helpful message.
//======================================================================

     MSG("CalDetDST", Msg::kInfo)
          <<"\n************** Help with ParticleFilterModule *****************\n"
          <<"ParticleFilterModule::Ana():\n"
          <<"===============================================================\n"
          <<"Filters events based on the contents of a\n"
          <<"CandCalDetPID object.\n"
          <<"Example: To select pions and muons do:\n\n"
          <<"Registry& r = \n"
          <<"jc.Path(\"X\").Mod(\"ParticleFilterModule\").GetConfig();\n"
          <<"r.UnlockValues();\n"
          <<"r.Set(\"ParticleType\","
          <<"CalDetParticleType::kPion|CalDetParticleType::kMuon);\n"
          <<"r.LockValues();\n"
          <<"jc.Path(\"X\").Mod(\"ParticleFilterModule\").Config(r);\n"
          <<"\nThis method will return kFailed if the particle type does\n"
          <<"not match the requested type, or in case no CandCalDetPID\n"
          <<"object can be found.\n"
          <<"===============================================================\n"
          <<"\nTakes config parameters:\n"
          <<" Int_t \"ParticleType\".\n"
          <<" Int_t \"CutOverlaps\". (!=0 to remove overlappers)\n"
          <<" Int_t \"CutCerTime\". (!=0 to cut on cer timing)\n"
          <<" Int_t \"CutChi2\". (!=0 to cut on chi2)\n"
          <<" Float_t \"Chi2Limit\". (Set upper limit on acceptable chi2)\n"
          <<" Int_t \"UseDST\". (!=0 to try and use the dst)\n"
          <<endl;

}

---