Cluster3DModule.cxx

Go to the documentation of this file.

// Module created with help of gen_module program by M.Messier
//
// Module for 3D Clustering
//
// Katarzyna Grzelak K.Grzelak1@physics.ox.ac.uk

#include <cassert>

#include "Cluster3D/Cluster3DModule.h"
#include "Algorithm/AlgConfig.h"
#include "Algorithm/AlgFactory.h"
#include "Algorithm/AlgHandle.h"
#include "CandData/CandHeader.h"
#include "CandData/CandRecord.h"
#include "Candidate/CandContext.h"
#include "Conventions/Munits.h"
#include "JobControl/JobCModuleRegistry.h"
#include "JobControl/JobCommand.h"
#include "MessageService/MsgService.h"
#include "MinosObjectMap/MomNavigator.h"
#include "Validity/VldContext.h"
#include "CandDigit/CandDigitListHandle.h"
#include "RecoBase/CandSliceListHandle.h"
#include "RecoBase/CandStripListHandle.h"
#include "Cluster3D/CandCluster3DListHandle.h"
#include "Cluster3D/CandCluster3DList.h"
#include "Cluster3D/CandCluster3DHandle.h"

#include <iostream>

using std::cout;
using std::endl;

ClassImp(Cluster3DModule)

JOBMODULE(Cluster3DModule,"Cluster3DModule","Clustering in 3D");
CVSID("$Id: Cluster3DModule.cxx,v 1.3 2007/03/01 17:44:17 rhatcher Exp $");
//......................................................................

Cluster3DModule::Cluster3DModule()  
{
//======================================================================
// Purpose: Default constructor
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule Constructor - " << endl;

  AlgFactory &af = AlgFactory::GetInstance();
  af.Register("AlgCluster3DList","default","libCluster3D.so","AlgConfig");
  af.Register("AlgCluster3D","default","libCluster3D.so","AlgConfig");

}

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

Cluster3DModule::~Cluster3DModule()
{
//======================================================================
// Purpose: Default destructor
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule Destructor - " << endl;

}

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

void Cluster3DModule::BeginJob()
{
//======================================================================
// Purpose: Something that should be done at the begin of job
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::BeginJob - " << endl;

}

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

void Cluster3DModule::EndJob()
{
//======================================================================
// Purpose: Something that should be done at the end of job
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::EndJob - " << endl;

}

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

void Cluster3DModule::BeginFile()
{
//======================================================================
// Purpose: Something that should be done at the begin of file
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::BeginFile - " << endl;

}

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

void Cluster3DModule::EndFile()
{
//======================================================================
// Purpose: Something that should be done at the end of file
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::EndFile - " << endl;

}

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

void Cluster3DModule::BeginRun()
{
//======================================================================
// Purpose: Something that should be done at the begin of run
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::BeginRun - " << endl;

}

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

void Cluster3DModule::EndRun()
{
//======================================================================
// Purpose: Something that should be done at the end of run
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::EndRun - " << endl;

}

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

JobCResult Cluster3DModule::Ana(const MomNavigator* /* mom */)
{
//======================================================================
// Purpose: Analysis module 
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::Ana - " << endl;

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

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

JobCResult Cluster3DModule::Reco(MomNavigator* mom)
{
//======================================================================
// Purpose: Reconstruction module
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::Reco - " << endl;

// Find Candidate Record

  CandRecord* candrec = dynamic_cast<CandRecord*>(mom->GetFragment("CandRecord","PrimaryCandidateRecord"));
  if(candrec==0){
    MSG("Cluster3D",Msg::kWarning) 
       << "Cluster3DModule::Reco: Failed to Find CandRecord " << endl;
    return (JobCResult::kWarning);
  }

  //
  // Find number of digits for debug purposes
  //

  CandDigitListHandle *digitlist = dynamic_cast<CandDigitListHandle*>
    (candrec->FindCandHandle("CandDigitListHandle"));

  if(!digitlist){
    MSG("Cluster3D",Msg::kDebug)
       << " No CandDigitListHandle in CandRecord" << endl;
  }
  else{
    Int_t ndigits = digitlist->GetNDaughters();
    MSG("Cluster3D",Msg::kDebug)  
       << " Found " << ndigits << " digits" << endl;
  }

  // Find CandSliceList in the primary Candidate Record

  CandSliceListHandle* slclisth = dynamic_cast<CandSliceListHandle*>
(candrec->FindCandHandle("CandSliceListHandle") );

  //There should be non-zero number of slices

  if(!slclisth){
    MSG("Cluster3D",Msg::kWarning) << "Cluster3DModule::Reco:" 
             << "No CandSliceListHandle in CandRecord" << endl;
    return JobCResult::kFailed;
  }
  else{
    Int_t nslice = slclisth->GetNDaughters();
    MSG("Cluster3D",Msg::kDebug) << " Cluster3DModule::Reco: " 
       << " Found " << nslice << " slices" << endl;
  }

  // Select algorithm

  // create Singleton Instance of AlgFactory
  AlgFactory &af = AlgFactory::GetInstance();

  // create AlgHandle
  AlgHandle aclh = af.GetAlgHandle("AlgCluster3DList","default");

  // Define context : CandContext 
  CandContext cx(this, mom);
  cx.SetDataIn(slclisth);
  cx.SetCandRecord(candrec);

  // Make Candidate - MakeCandidate method creates  a CandCluster3DList
  // object using the Algorithm handle and the CandContext.
 
  CandCluster3DListHandle clustlisth = 
        CandCluster3DList::MakeCandidate(aclh, cx);

    CandCluster3DListHandle* cl = &clustlisth;
    Int_t nclust = cl->GetNDaughters();
    MSG("Cluster3D",Msg::kDebug) << " Cluster3DModule::Reco: " 
       << " Found " << nclust << " clusters" << endl;

  // Set Name and Title

   clustlisth.SetName("CandCluster3DList");
   clustlisth.SetTitle(TString("Created by Cluster3DModule from ").
                 Append(slclisth->GetName()));


// Add handle to CandRecord
   candrec->SecureCandHandle(clustlisth);

  return JobCResult::kAOK; // possibilites: kPassed, kFailed, 
                           // kAOK, kWarning, kError, kFatal
}

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

const Registry& Cluster3DModule::DefaultConfig() const
{
//======================================================================
// Purpose: Supply the default configuration for the module
//======================================================================
  static Registry r; // Create registry that keeps the default 
                     // configuration for module

  // Set name of config

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


  // Set parameters for the algorithm

  // Get singleton instance of AlgFactory.

  AlgFactory &af = AlgFactory::GetInstance();

  // Get algorithm handle and its config
   
  AlgHandle alglisthandle = af.GetAlgHandle("AlgCluster3DList","default");
  AlgConfig &alglistconfig = alglisthandle.GetAlgConfig();

  //alglistconfig.UnLockValues();

  alglistconfig.Set("plnDist",4); // max distance between two cells in planes
  alglistconfig.Set("stpDist",8); // max distance between two cells in stps
  //
  // There should be enough strips OR enough energy 
  // (sum of pe's) to form a cluster 
  //
  alglistconfig.Set("minClustStp",4); // min number of strips to form a cluster
  alglistconfig.Set("minClustAmbStp",4); // min number of strips which belong
  // ONLY to a given cluster to treat this cluster as a real one
  alglistconfig.Set("minClustPe",10.); // min sum of pe's to form a cluster
  alglistconfig.Set("maxDist",3); // max distance between planes to form a cell
  //                               
  alglistconfig.Set("xTalk",1); // rejection of crossTalk hits:- 1=on 0=off
  alglistconfig.Set("xTalkMode",2); // 1 = rejection of all XTalk hits
                                    // 2 = rejection of the isolated XTalk hits
  alglistconfig.Set("xTalkPeCut",2.); // if strip has only one digit 
                    // and pulse height is < xTalkPeCut than it is a crosstalk
  alglistconfig.Set("timeInfo",0); // Timing information used:- 1=yes 0=no
  alglistconfig.Set("vLightInScint",2.179); // eff. velocity of light in scint
  alglistconfig.Set("t1-t2ResolutionInNs",3.5); // t1-t2 time resolution
  
  //alglistconfig.LockValues();
  // Keys = Names
  //alglistconfig.LockKeys();

  // Set general parameters for module

  // This bit is important if one wants to
  // guard against typos when configuring a module
  //   
  // a FILLED out default configuration Registry 
  // has to be returned
  

  static bool been_here = false;
  if (!been_here) {
      been_here = true;

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

      /*  

      r.Set("ListIn","CandSliceSRList");
      r.Set("ListOut","CandClusterSRList");

      */

      r.Merge(alglistconfig);
      r.LockValues();
  }

  // returns registry with the default configuration to the JobModule 

  return r;
}

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

void Cluster3DModule::Config(const Registry& r)
{
//======================================================================
// Purpose: Configure the module given the Registry r
//======================================================================

  Int_t    tmpi;
  Double_t tmpd;
  //const char* tmps;

  
  //if (r.Get("Print",tmpb)) { fPrint = tmpb; }
  //if (r.Get("Cdist",tmpi)) { fCdist = tmpi; }
  //if (r.Get("Vscint",tmpd)) { fVscint = tmpd; }
  //if (r.Get("UseStream",tmps)) { fName = tmps; }


  // Get singleton instance of AlgFactory.

  AlgFactory &af = AlgFactory::GetInstance();

  // Get algorithm handle and its config
   
  AlgHandle alglisthandle = af.GetAlgHandle("AlgCluster3DList","default");
  AlgConfig &alglistconfig = alglisthandle.GetAlgConfig();

  alglistconfig.UnLockValues();

  /*
  Int_t tmpi;
  Double_t tmpd;
  const Char_t *tmpc = 0;

  if (r.Get("ListIn",tmpc)) fListIn  = tmpc;
  if (r.Get("ListOut",tmpc)) fListOut = tmpc;
  */

  if (r.Get("plnDist",tmpi)) {
    alglistconfig.Set("plnDist",tmpi);
  }
  if (r.Get("stpDist",tmpi)) {
    alglistconfig.Set("stpDist",tmpi);
  }
  if (r.Get("minClustStp",tmpi)) {
    alglistconfig.Set("minClustStp",tmpi);
  }
  if (r.Get("minClustAmbStp",tmpi)) {
    alglistconfig.Set("minClustAmbStp",tmpi);
  }
  if (r.Get("minClustPe",tmpd)) {
    alglistconfig.Set("minClustPe",tmpd);
  }
  if (r.Get("maxDist",tmpi)) {
    alglistconfig.Set("maxDist",tmpi);
  }
  if (r.Get("xTalk",tmpi)) {
    alglistconfig.Set("xTalk",tmpi);
  }
  if (r.Get("xTalkMode",tmpi)) {
    alglistconfig.Set("xTalkMode",tmpi);
  }
  if (r.Get("xTalkPeCut",tmpd)) {
    alglistconfig.Set("xTalkPeCut",tmpd);
  }
  if (r.Get("timeInfo",tmpi)) {
    alglistconfig.Set("timeInfo",tmpi);
  }
  if (r.Get("vLightInScint",tmpd)) {
    alglistconfig.Set("vLightInScint",tmpd);
  }
  if (r.Get("t1-t2ResolutionInNs",tmpd)) {
    alglistconfig.Set("t1-t2ResolutionInNs",tmpd);
  }

  alglistconfig.LockValues();

}

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

void Cluster3DModule::Help()
{
//======================================================================
// HELP
// No longer needed. Use Module::Report() to see list of parameters
// which can be set using Set("name=value"). You can override the 
// default Report command
//
//======================================================================
}

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

/*
void Cluster3DModule::Report()
{
//======================================================================
// FILL_IN: [Document your code!!]
//======================================================================
}
*/


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

void Cluster3DModule::Reset()
{
//======================================================================
// FILL_IN: [Document your code!!]
//======================================================================
}

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

JobCResult Cluster3DModule::Get(MomNavigator* /* mom */)
{
//======================================================================
// FILL_IN: [Document your code!!]
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::Get - " << endl;

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

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

JobCResult Cluster3DModule::Put(const MomNavigator* /* mom */)
{
//======================================================================
// FILL_IN: [Document your code!!]
//======================================================================

  MSG("Cluster3D",Msg::kDebug) << " - Cluster3DModule::Put - " << endl;

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

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

---