StripSRListModule.cxx

Go to the documentation of this file.

// $Id: StripSRListModule.cxx,v 1.29 2010/01/06 18:52:19 rhatcher Exp $
//
// StripSRListModule.cxx
//
// Begin_Html<img src="../../pedestrians.gif" align=center>
// <a href="../source_warning.html">Warning for beginners</a>.<br> 
//
// A JobControl Module for filling raw CandStripSRList from RawData.
//
// Author:  R. Lee 2001.01.19
//
// Also see <a href="../../root_crib/index.html">The ROOT Crib</a> and 
// <a href="../CandStripSR.html"> CandStripSR Classes</a> (part of
// <a href="../index.html">The MINOS Class User Guide</a>)End_Html

#include <cassert>

#include "TROOT.h"

#include "CandStripSR/StripSRListModule.h"

#include "Algorithm/AlgConfig.h"
#include "Algorithm/AlgFactory.h"
#include "Algorithm/AlgHandle.h"
#include "CandData/CandHeader.h"
#include "CandData/CandRecord.h"
#include "CandDigit/CandDigitListHandle.h"
#include "CandDigit/CandDeMuxDigitListHandle.h"
#include "Candidate/CandContext.h"
#include "Conventions/Munits.h"
#include "Conventions/StripEnd.h"
#include "Conventions/Detector.h"
#include "JobControl/JobCModuleRegistry.h"
#include "JobControl/JobCommand.h"
#include "MessageService/MsgService.h"
#include "MinosObjectMap/MomNavigator.h"
#include "RawData/RawDigit.h"
#include "RawData/RawHeader.h"
#include "RawData/RawRecord.h"
#include "RawData/RawDigitDataBlock.h"
#include "RawData/RawChannelId.h"
#include "RawData/RawDaqSnarlHeader.h"
#include "RawData/RawDaqHeaderBlock.h"
#include "RawData/RawDigitDataBlock.h"
#include "RawData/RawVarcErrorInTfBlock.h"

#include "RecoBase/CandStripListHandle.h"
#include "RecoBase/CandStripHandle.h"
#include "RecoBase/CandStrip.h"
#include "RecoBase/CandStripList.h"

#include "Validity/VldContext.h"

ClassImp(StripSRListModule)

//......................................................................
CVSID("$Id: StripSRListModule.cxx,v 1.29 2010/01/06 18:52:19 rhatcher Exp $");
JOBMODULE(StripSRListModule, "StripSRListModule",
         "Builds CandStripList from CandDigitList");

//......................................................................
StripSRListModule::StripSRListModule():
        fTFolder(0)
{

        //fStats=new StripStat();

        //from George Irwin:
// Put CandStripSRList's statistics object in /Loon/CandStripSR folder


   if (fTFolder==0) {
     TFolder *lf = dynamic_cast<TFolder *>(gROOT->FindObject("Loon"));
     if (lf==0) {
       MSG("StripSR", Msg::kDebug) << "Creating Loon TFolder" << endl;
       lf = gROOT->GetRootFolder()->AddFolder("Loon", "Loon analysis");
       gROOT->GetListOfBrowsables()->Add(lf, "Loon");
     }
     fTFolder = lf->AddFolder("CandStripSR", "CandStripSR statistics");
     fTFolder->Add(&fStats);
   }
   




}

//......................................................................
StripSRListModule::~StripSRListModule() 
{
}

//......................................................................
void StripSRListModule::BeginJob() 
{ 
}
//......................................................................
void StripSRListModule::EndJob() 
{ 

        fStats.Print();

}
//......................................................................

const Registry &StripSRListModule::DefaultConfig() const
{
//
//  Purpose:    Method to set default module configuration.
//  
//  Arguments:  n/a
//  
//  Return:     Registry item containing default configuration.
//  

  static Registry def_cfg;
  static bool been_here = false;
  if(been_here)return def_cfg;
  been_here=true;

  string name = this->JobCModule::GetName();
  name += ".config.default";
  def_cfg.SetName(name.c_str());

  // Set defaults
  def_cfg.Set("StripListAlgorithm","AlgStripSRList");
  def_cfg.Set("StripListAlgConfig","default");
  def_cfg.Set("ListIn","canddigitlist");
  def_cfg.Set("ListOut","CandStripList");
  def_cfg.Set("LogLevel","Fatal");
  def_cfg.Set("UseDeMuxQualityWord", 0); 
  return def_cfg;
}

//......................................................................
JobCResult StripSRListModule::Reco(MomNavigator *mom)
{
  JobCResult result(JobCResult::kPassed);
    
  // load configuration 
  const char* tmps = 0;
  Int_t tmpi=0;  
  const char* alg_name = 0;
  const char* alg_config_name = 0;
  const char* list_in = 0;
  const char* list_out = 0;
  Int_t useDeMuxQualityWord=0;

  Registry& cfg = this->GetConfig();
  if (cfg.Get("StripListAlgorithm",tmps)) alg_name = tmps;
  if (cfg.Get("StripListAlgConfig",tmps)) alg_config_name = tmps;
  if (cfg.Get("ListIn",tmps)) list_in = tmps;
  if (cfg.Get("ListOut",tmps)) list_out = tmps;
  if (cfg.Get("UseDeMuxQualityWord",tmpi)) useDeMuxQualityWord = tmpi;
    
  // make sure raw record is available, in particular one from the DaqSnarl
  // stream to ensure that it has the RawDigitDataBlock (i.e. digits)
  RawRecord *rr = dynamic_cast<RawRecord *>(mom->GetFragment("RawRecord",0,"DaqSnarl"));
  if (rr == 0) {
    MSG("EventSR", Msg::kWarning) << "No RawRecord in MOM." << endl;
    return result;
  }
    
  // Find PrimaryCandidateRecord fragment in MOM.
  CandRecord *candrec = dynamic_cast<CandRecord *>
    (mom->GetFragment("CandRecord", "PrimaryCandidateRecord"));
  if (candrec == 0) {
    MSG("StripSR", Msg::kWarning) << "No PrimaryCandidateRecord in MOM."
                                  << endl;
    result.SetWarning().SetFailed();
    return result;
  }
 
  CandDigitListHandle *cdlh = dynamic_cast<CandDigitListHandle *>
    (candrec->FindCandHandle("CandDigitListHandle", list_in));
  
  // Require number of CandDigits to be non-zero.
   if (!cdlh || cdlh->GetNDaughters() < 1) {
     MSG("StripSR", Msg::kDebug)
                  << "Null CandDigit list.  Bail out of event." << endl;
     result.SetFailed();
     return result;
   }

   // if the demux quality usage is enabled, continue processing
   // only in the case of a successful demuxing step
   if(useDeMuxQualityWord == 1 
      && cdlh->GetVldContext()->GetDetector() == Detector::kFar){
     const CandDeMuxDigitListHandle *ddlh = 0;
     if(cdlh->InheritsFrom("CandDeMuxDigitListHandle")){ 
       ddlh = dynamic_cast<const CandDeMuxDigitListHandle *>(cdlh);
       if(ddlh->GetDeMuxDigitListFlagWord() == CandDeMuxDigitList::kEventFailedFilter ){
         MSG("StripSR", Msg::kDebug) << "failed DeMuxDigitList filter" << endl;
         result.SetFailed();
         return result;
       }
     }
   }//end check on demux quality words

   AlgFactory &af = AlgFactory::GetInstance();
   AlgHandle adlh = af.GetAlgHandle(alg_name,alg_config_name);
   CandContext cx(this, mom);
   cx.SetDataIn(cdlh);
   CandStripListHandle cslh = CandStripList::MakeCandidate(adlh, cx);

   cslh.SetName(list_out);
   cslh.SetTitle(TString("Created by StripSRListModule from ").
                 Append(cdlh->GetName()));
   candrec->SecureCandHandle(cslh);


   return result;
}

ClassImp(StripStat)


//       StripStat helper class                                  //
StripStat::StripStat(): 
    fDoNoiseNear(true), fDoNoiseStats(false), fNearNoiseADC(40)
{

}
StripStat::~StripStat()
{

}
void StripStat::Add(const RawChannelId& rcid, Bool_t noise)
{

        if (fNearStripStats.find(rcid) == fNearStripStats.end() )
        {
                // is this paranoia?
                fNearStripStats[rcid].all=0;
                fNearStripStats[rcid].noise=0;
        }

        fNearStripStats[rcid].all++;
        if (noise) fNearStripStats[rcid].noise++;
}

void StripStat::Print()
{

        MSG("StripSR",Msg::kInfo) <<"\n NearDet Strip Noise Filtering="<<
                fDoNoiseNear<< "\n"<<endl;
        if (!fDoNoiseStats) {
                MSG("StripSR", Msg::kInfo) << "DoNoiseStats=false. No"<<
                " NearDet noise statistics in StripSRListModule.\n"
                <<"  NearNoiseADC="<<fNearNoiseADC <<endl;
                return;
        }

        MSG("StripSR", Msg::kInfo) << 
        "----------------------------------------------------------------\n"
        << "     Strips Cut by StripSRListModule::CleanNoiseNear\n" 
        << "      single digits with ADC<"<<fNearNoiseADC<< " \n" 
        <<"     Stripends with more than 10%% cut out of at least 10 strips:\n" <<
        "----------------------------------------------------------------\n"
                <<endl;
        MSG("StripSR", Msg::kInfo) << setw(10)<< "Crate" << 
                                setw(10) <<"Master"<<
                                setw(10) <<"MasterCh"<<
                                setw(10) <<"Menu"<<
                                setw(10) <<"Total"<<
                                setw(10) <<"Cut"<<
                                setw(10) <<"Fraction"<<endl;

        for (map<RawChannelId,fStripStats>::iterator itmap=
                        fNearStripStats.begin();
                        itmap != fNearStripStats.end();
                        itmap++)
        {

                RawChannelId rcid=itmap->first;
                fStripStats stats=itmap->second;
                if ( 9 < stats.noise) {
                                Float_t fraction=(Float_t) 
                                                stats.noise/stats.all;
                                if (fraction > 0.1)
                                MSG("StripSR", Msg::kInfo) 
                                << setw(10)<< (rcid.GetCrate())<< 
                                setw(10) <<  (rcid.GetMaster())<<
                                setw(10) <<  (rcid.GetMinder())<<
                                setw(10) <<  (rcid.GetMenu())<<
                                setw(10) <<  stats.all<<
                                setw(10) <<stats.noise<<
                                setw(10) << fraction
                                <<endl;
                }

        } // itmap

        MSG("StripSR", Msg::kInfo) << 
        "----------------------------------------------------------------\n"
        <<
        "----------------------------------------------------------------\n"
                <<endl;


}

---