BiggestChopModule.cxx

Go to the documentation of this file.

// $Id: BiggestChopModule.cxx,v 1.6 2006/10/25 15:04:00 tagg Exp $
//
// FILL_IN: [Document your code!!]
//
// n.tagg1@physics.ox.ac.uk
#include "BiggestChopModule.h"
#include "DigitVector.h"
#include "CandChopListHandle.h"
#include "CandChopList.h"

#include "MessageService/MsgService.h"
#include "MinosObjectMap/MomNavigator.h"
#include "JobControl/JobCModuleRegistry.h" // For JOBMODULE macro
#include "Algorithm/AlgFactory.h"
#include "CandData/CandRecord.h"
#include "Candidate/CandContext.h"
#include "CandDigit/CandDigitListHandle.h"
#include "CandDigit/CandDigitList.h"
#include "CandDigit/CandDigitHandle.h"

#include "DataUtil/GetRawBlock.h"
#include "RawData/RawDigitDataBlock.h"
#include "RawData/RawDigit.h"
#include "Plex/PlexHandle.h"
#include "Calibrator/Calibrator.h"
#include "Conventions/Munits.h"


JOBMODULE(BiggestChopModule, "BiggestChopModule",
          "Chooses the biggest chop from the list.");
CVSID(" $Id: BiggestChopModule.cxx,v 1.6 2006/10/25 15:04:00 tagg Exp $");

BiggestChopModule::BiggestChopModule() :
  fChopsWithLi(0),
  fSnarlsWithLi(0)
{
}

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

BiggestChopModule::~BiggestChopModule()
{
  MSG("BiggestChop",Msg::kInfo) << "Number of chops rejected as LI event: "   << fChopsWithLi << endl;
  MSG("BiggestChop",Msg::kInfo) << "Number of snarls with an  LI event:   "   << fSnarlsWithLi << endl;
}

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

JobCResult BiggestChopModule::Reco(MomNavigator* mom)
{
  JobCResult result = JobCResult::kPassed;

  // config.
  Registry& cfg = this->GetConfig();
  const char* algName        = cfg.GetCharString("BiggestChopAlgorithm");
  const char* algConfigName  = cfg.GetCharString("BiggestChopAlgConfig");
  const char* listIn         = cfg.GetCharString("ListIn");
  const char* listOut        = cfg.GetCharString("ListOut");
  bool        switchPerToTemp = cfg.GetInt("SwitchPersToTemp");
  double      minEnergy      = cfg.GetDouble("MinEnergy");
  bool        omitLiEvents   = cfg.GetInt("OmitLiEvents");
  double      liVetoWindowLow = cfg.GetDouble("LiVetoWindowLow");
  double      liVetoWindowHigh= cfg.GetDouble("LiVetoWindowHigh");
  
  // Find PrimaryCandidateRecord fragment in MOM.
  CandRecord *candrec = dynamic_cast<CandRecord *>
    (mom->GetFragment("CandRecord", "PrimaryCandidateRecord"));
  if (candrec == 0) {
    MSG("BiggestChop", Msg::kWarning) << "No PrimaryCandidateRecord in MOM."
                                 << endl;
    return JobCResult::kFailed;
  }

  
  if(switchPerToTemp) {
    // The user requested that we get rid of the original CandDigitList
    // in favor of the new (chopped) list.
    // Find the original digit list. of chops.
    CandDigitListHandle *orig_cdlh = dynamic_cast<CandDigitListHandle*>
      (candrec->FindCandHandle("CandDigitListHandle", listOut));
   
    if(orig_cdlh)
      candrec->SwitchCandHandlePersToTemp(orig_cdlh);
  }

  // find the list of chops.
  CandChopListHandle *chopList = dynamic_cast<CandChopListHandle*>
    (candrec->FindCandHandle("CandChopListHandle", listIn));


  if(!chopList) {
    MSG("BiggestChop",Msg::kError) << "Could not find a ChopList in Mom." << endl;
    result.SetWarning().SetFailed();
    return result;
  }

  if(chopList->GetNDaughters()==0) {
    MSG("BiggestChop",Msg::kError) << "Could not find any Chops in the ChopList." << endl;
    result.SetWarning().SetFailed();
    return result;
  }

  
  const VldContext* contextptr = chopList->GetVldContext();

  // Find the RawDigitDataBlock.
  // Use it to find any TPMT hits to reject LI
  double liTime = 100.;
  if(omitLiEvents) {
    const RawDigitDataBlock* rddb = DataUtil::GetRawBlock<RawDigitDataBlock>(mom);
    if(!rddb) {
      MSG("BiggestChop",Msg::kError) << "Could not find a RawDigitDataBlock in Mom." << endl;
      result.SetWarning().SetFailed();
      return result;
    }
    assert(contextptr);
    PlexHandle plex(*contextptr);

    RawDigit *rawdigit;
    TIter iter = rddb->GetDatumIter();
    TObject* tobj;
    while( (tobj=iter.Next() ) ) {
      if( ( rawdigit = dynamic_cast<RawDigit*>(tobj) ) ) {;
        RawDigit* rawdigit = dynamic_cast<RawDigit*>(tobj);
        
        RawChannelId rcid = rawdigit->GetChannel();
        ReadoutType::Readout_t type = plex.GetReadoutType(rcid);
        
        if(type == ReadoutType::kFlashTrigPMT) {
          if( rawdigit->GetADC() > 100) {
            liTime = Calibrator::Instance().GetTimeFromTDC(rawdigit->GetTDC(),rawdigit->GetChannel());    
            MSG("BiggestChop",Msg::kDebug) << "Found LI trigger at " << liTime << endl;
          }
        }
      }
    }
  }

  // Loop through and find the best.
  CandDigitListHandleItr listItr(chopList->GetDaughterIterator());

  CandDigitListHandle bestChop;
  double              bestChopEnergy = -1;
  bool                vetoedLi = false;

  double vetoLow  = liTime + liVetoWindowLow;
  double vetoHigh = liTime + liVetoWindowHigh;

  while( CandDigitListHandle *chop = listItr()) {
    
    // Add up the energy in this chop.
    double energy = 0;    
    double chopStart = 99e9;
    double chopEnd   = -99e9;
    CandDigitHandleItr digitItr(chop->GetDaughterIterator());
    while(CandDigitHandle *cdh = digitItr()) {
      if(!cdh->GetPlexSEIdAltL().IsVetoShield()) {
        energy += cdh->GetCharge();
        double t = cdh->GetTime();
        if(t<chopStart) chopStart = t;
        if(t>chopEnd)   chopEnd   = t;
      }
    }
    
    // Is this chop an LI event?    
    double choptime = chop->GetAbsTime();   
    bool isLI = false;

    MSG("BiggestChop",Msg::kDebug) << "Comparing chop time " << choptime 
                                   << " to " << liTime 
                                   << " delta = " << chopStart-liTime << endl;    
    
    // look for any intersection with the LI event, from -1 to +31 us from the 
    // TPMT hit.
    if( (chopEnd>vetoLow) && (chopStart<vetoHigh) ) isLI = true;
    
    // See if we have a winner.
    if(energy>bestChopEnergy) {
      if(isLI){
        vetoedLi = true;
        fChopsWithLi++;
      }    

      if(isLI && omitLiEvents) {
        MSG("BiggestChop",Msg::kDebug) << "Chop is too close to an LI event." << endl;  
      } else {     
        bestChopEnergy = energy;
        bestChop = *chop;
      }
    }     
  }

  if(vetoedLi) fSnarlsWithLi++; // Statistics gathering.
     
  if(bestChopEnergy<minEnergy) {
    // We didn't find a match.
    MSG("Chop",Msg::kWarning) << "Found insufficient energy in any chop. NO chop chosen" << endl;
    return JobCResult::kFailed;
  }

  MSG("Chop",Msg::kDebug) << "Chose chop " << bestChop.GetName() << " with energy " << bestChopEnergy << endl;
  
  // Ok, now we want a copy of bestChop. Boy, this is laborious:
  DigitVector v(&bestChop);
  AlgFactory &af = AlgFactory::GetInstance();
  AlgHandle adlh = af.GetAlgHandle(algName,algConfigName);
  CandContext cx(this, mom);
  cx.SetDataIn(&v);
  CandDigitListHandle outList = CandDigitList::MakeCandidate(adlh,cx);
  outList.SetName(listOut);
  outList.SetTitle("Biggest chop chosen by BiggestChopModule");
 
  candrec->SecureCandHandle(outList);
                     

  return JobCResult::kPassed; // kNoDecision, kFailed, etc.
}

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



JobCResult BiggestChopModule::Ana(const MomNavigator* /*mom*/)
{
  return JobCResult::kPassed; // kNoDecision, kFailed, etc.
}

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

const Registry& BiggestChopModule::DefaultConfig() const
{
  //======================================================================
  // Supply the default configuration for the module
  //======================================================================
  static Registry r; // Default configuration for module
  
  // Set name of config
  std::string name = this->JobCModule::GetName();
  name += ".config.default";
  r.SetName(name.c_str());
  
  // Set values in configuration
  r.UnLockValues();
  r.Set("BiggestChopAlgorithm","AlgChop");
  r.Set("BiggestChopAlgConfig","default");
  r.Set("ListIn",         "candchoplist");
  r.Set("ListOut",        "canddigitlist");
  r.Set("SwitchPersToTemp",1);
  r.Set("MinEnergy",      0.0);
  r.Set("OmitLiEvents",   1);
  r.Set("LiVetoWindowLow",-1.0*Munits::microsecond);
  r.Set("LiVetoWindowHigh",31.0*Munits::microsecond);

  r.LockValues();

  return r;
}

---