DataQualityFilter.cxx

Go to the documentation of this file.

#include "DataQualityFilter.h"

#include "MessageService/MsgService.h"     
#include "MinosObjectMap/MomNavigator.h"   
#include "JobControl/JobCommand.h"         
#include "JobControl/JobCModuleRegistry.h" 

#include "RawData/RawRecord.h"
#include "CandData/CandRecord.h"


//
// $Log $
//

ClassImp(DataQualityFilter)

CVSID("$Id: DataQualityFilter.cxx,v 1.8 2008/08/25 13:09:18 blake Exp $");

JOBMODULE(DataQualityFilter,"DataQualityFilter","DataQualityFilter");

DataQualityFilter::DataQualityFilter() :
  fTime(0),
  fCurrentTime(0),
  fFilter(0),
  fSpillStatus(-1),
  fBeamStatus(-1),
  fHvStatus(-1),
  fCoilStatus(-1),
  fGpsStatus(-1),
  fDetectorStatus(-1),
  fFilterOnOff(0),
  fFilterBadBeam(0),
  fFilterBadDetector(0),
  fWriteOutResults(0),
  fUseLookup(0),
  fFilterFileName("dataqualityfilter.root"),
  fFilterFile(0),
  fFilterTree(0)
{
  MSG("DataQualityFilter",Msg::kDebug) << " *** DataQualityFilter::DataQualityFilter() *** " << endl;

  fDQhandle = new DataQualityInterface();
}

DataQualityFilter::~DataQualityFilter()
{
  MSG("DataQualityFilter",Msg::kDebug) << " *** DataQualityFilter::~DataQualityFilter() *** " << endl;

  if( fDQhandle ) delete fDQhandle;
}

void DataQualityFilter::BeginJob()
{
  MSG("DataQualityFilter",Msg::kInfo) << " *** DataQualityFilter::BeginJob(...) *** " << endl;

}

JobCResult DataQualityFilter::Ana(const MomNavigator *mom) 
{
  MSG("DataQualityFilter",Msg::kInfo) << " *** DataQualityFilter::Ana(...) *** " << endl;

  fSpillStatus=-1;
  fBeamStatus=-1;
  fHvStatus=-1;
  fCoilStatus=-1;
  fGpsStatus=-1;
  fDetectorStatus=-1;
  fBeamType=-1;
  fProtonsOnTarget=0.0;
  fFilter=0;

  JobCResult result(JobCResult::kAOK);
  
  // Get RawRecord
  // =============
  RawRecord* rawrec = dynamic_cast<RawRecord*>(mom->GetFragment("RawRecord"));
  if( rawrec ){ 
    MSG("DataQualityFilter",Msg::kDebug) << " Found RawRecord " << endl;
    VldContext* vldc = (VldContext*)(rawrec->GetVldContext());
    fCurrentTime=vldc->GetTimeStamp().GetSec();
    fSpillStatus=fDQhandle->GetSpillStatus(*vldc);
    fBeamStatus=fDQhandle->GetBeamStatus(*vldc);
    fBeamType=fDQhandle->GetBeamType(*vldc);
    fProtonsOnTarget=fDQhandle->GetProtonsOnTarget(*vldc);
    if( fUseLookup ){
      fDetectorStatus=fDQhandle->LookupDetectorStatus(*vldc);
      fHvStatus=fDQhandle->LookupHvStatus(*vldc);
      fCoilStatus=fDQhandle->LookupCoilStatus(*vldc);
      fGpsStatus=1;
    }
    else{
      fDetectorStatus=fDQhandle->GetDetectorStatus(*vldc);
      fHvStatus=fDQhandle->GetHvStatus(*vldc);
      fCoilStatus=fDQhandle->GetCoilStatus(*vldc);
      fGpsStatus=fDQhandle->GetGpsStatus(*vldc);
    }
  }

  // Get CandRecord
  // ==============
  CandRecord* candrec = dynamic_cast<CandRecord*>(mom->GetFragment("CandRecord"));
  if( candrec ){
    MSG("DataQualityFilter",Msg::kDebug) << " Found CandRecord " << endl;
    
  }

  // Set Filter
  // ==========
  // check whether filters are on/off then pass/fail event
  if( ( fFilterBadBeam==0     || fBeamStatus==1     ) 
   && ( fFilterBadDetector==0 || fDetectorStatus==1 ) ){
    fFilter=1;
  }
  
  // Write out Results
  // =================
  if( fCurrentTime!=fTime ){
    fLiveTime=1;
    if( fTime>0 
     && fCurrentTime-fTime>1 ) fLiveTime=fCurrentTime-fTime;
    fTime=fCurrentTime;
    if( fWriteOutResults ) this->WriteOutResults();
  }

  MSG("DataQualityFilter",Msg::kDebug) << " Time=" << fTime << endl;
  MSG("DataQualityFilter",Msg::kDebug) << " BeamType=" << fBeamType << endl;
  MSG("DataQualityFilter",Msg::kDebug) << " SpillStatus=" << fSpillStatus << endl;
  MSG("DataQualityFilter",Msg::kDebug) << " ProtonsOnTarget=" << fProtonsOnTarget << endl;
  MSG("DataQualityFilter",Msg::kDebug) << " DetectorStatus=" << fDetectorStatus << " [HV=" << fHvStatus << ", coil=" << fCoilStatus << ", gps=" << fGpsStatus << "]" << endl;   
  MSG("DataQualityFilter",Msg::kDebug) << " Beam=[" << fFilterBadBeam << "|" << fBeamStatus << "] Detector=[" << fFilterBadDetector << "|" << fDetectorStatus << "]" << endl;
  MSG("DataQualityFilter",Msg::kDebug) << " Filter=[" << fFilterOnOff << "|" << fFilter << "]" << endl;
  
  // Apply Filter
  // ============
  if( fFilterOnOff ){
    if( fFilter ){
      MSG("DataQualityFilter",Msg::kInfo) << " *** PASSED FILTER *** " << endl;
      return JobCResult::kPassed;
    }
    else{
      MSG("DataQualityFilter",Msg::kInfo) << " *** FAILED FILTER *** " << endl;
      return JobCResult::kFailed;
    }
  }

  return result;

}

const Registry& DataQualityFilter::DefaultConfig() const
{
  MSG("DataQualityFilter",Msg::kDebug) << " *** DataQualityFilter::DefaultConfig() *** " << endl;
 
  static Registry r;
  r.SetName("DataQualityFilter.config.default");
  r.UnLockValues();
  r.Set("FilterOnOff",fFilterOnOff);
  r.Set("FilterBadBeam",fFilterBadBeam);
  r.Set("FilterBadDetector",fFilterBadDetector);
  r.Set("WriteOutResults",fWriteOutResults);
  r.Set("UseLookupTable",fUseLookup);
  r.Set("OutputFile",fFilterFileName);
  r.LockValues();
                    
  return r;
}
  
void DataQualityFilter::Config(const Registry& r)
{
  MSG("DataQualityFilter",Msg::kDebug) << " *** DataQualityFilter::Config() *** " << endl;

  Int_t tmpint;
  const char* tmpchar = 0;
          
  if(r.Get("FilterOnOff",tmpint)) fFilterOnOff = tmpint;        
  if(r.Get("FilterBadBeam",tmpint)) fFilterBadBeam = tmpint;
  if(r.Get("FilterBadDetector",tmpint)) fFilterBadDetector = tmpint;
  if(r.Get("WriteOutResults",tmpint)) fWriteOutResults = tmpint;
  if(r.Get("UseLookupTable",tmpint)) fUseLookup = tmpint;
  if(r.Get("OutputFile",tmpchar)) fFilterFileName=tmpchar;

  MSG("DataQualityFilter",Msg::kDebug)
    << "  configuration: " << endl
    << "     FilterOnOff=" << fFilterOnOff << endl
    << "     FilterBadBeam=" << fFilterBadBeam << endl
    << "     FilterBadDetector=" << fFilterBadDetector << endl
    << "     WriteOutResults=" << fWriteOutResults << endl
    << "     UseLookupTable=" << fUseLookup << endl
    << "     OutputFile=" << fFilterFileName << endl;

  return;
}
  
void DataQualityFilter::HandleCommand(JobCommand* command)
{
  TString cmd = command->PopCmd();
  if(cmd=="Set"){
    TString opt = command->PopOpt();
                                                                                    
  }
}

void DataQualityFilter::EndJob() 
{
  MSG("DataQualityFilter",Msg::kInfo) << " *** DataQualityFilter::EndJob() *** " << endl;                                                                               
  if(fFilterFile){
    MSG("DataQualityFilter",Msg::kInfo) << " *** saving info to file ... " << endl;
    TDirectory* tmpd = gDirectory;
    fFilterFile->cd();
    fFilterTree->Write();
    fFilterFile->Close();
    gDirectory = tmpd;
    MSG("DataQualityFilter",Msg::kInfo) << "      ... info saved to file *** " << endl;
  }
}

void DataQualityFilter::WriteOutResults()
{
  MSG("DataQualityFilter",Msg::kDebug) << " *** DataQualityFilter::WriteOutResults() *** " << endl; 

  if(!fFilterFile){
    TDirectory* tmpd = gDirectory;
    fFilterFile = new TFile(fFilterFileName.Data(),"RECREATE");
    fFilterTree = new TTree("DataQualityFilter","DataQualityFilter");
    fFilterTree->SetAutoSave(300);
    fFilterTree->Branch("Time",&fTime,"Time/I");
    fFilterTree->Branch("BeamType",&fBeamType,"BeamType/I");
    fFilterTree->Branch("BeamStatus",&fBeamStatus,"BeamStatus/I");
    fFilterTree->Branch("SpillStatus",&fSpillStatus,"SpillStatus/I");
    fFilterTree->Branch("HvStatus",&fHvStatus,"HvStatus/I");
    fFilterTree->Branch("CoilStatus",&fCoilStatus,"CoilStatus/I");
    fFilterTree->Branch("GpsStatus",&fGpsStatus,"GpsStatus/I");
    fFilterTree->Branch("DetectorStatus",&fDetectorStatus,"DetectorStatus/I");
    fFilterTree->Branch("LiveTime",&fLiveTime,"LiveTime/I");
    fFilterTree->Branch("ProtonsOnTarget",&fProtonsOnTarget,"ProtonsOnTarget/D");
    fFilterTree->Branch("FilterOnOff",&fFilterOnOff,"FilterOnOff/I");
    fFilterTree->Branch("FilterBadBeam",&fFilterBadBeam,"FilterBadBeam/I");
    fFilterTree->Branch("FilterBadDetector",&fFilterBadDetector,"FilterDetector/I");
    fFilterTree->Branch("Filter",&fFilter,"Filter/I");
    gDirectory = tmpd;
  }

  if(fFilterFile){
    TDirectory* tmpd = gDirectory;
    fFilterFile->cd();
    fFilterTree->Fill();
    gDirectory = tmpd;
  }
}

---