BmnDch.cxx

Go to the documentation of this file.

// -------------------------------------------------------------------------
// -----                       BmnDch source file                      -----
// -------------------------------------------------------------------------
 
#include "BmnDch.h"
 
#include "BmnDchGeo.h"
#include "BmnDchGeoPar.h"
#include "CbmStack.h"
#include "FairGeoBuilder.h"
#include "FairGeoInterface.h"
#include "FairGeoLoader.h"
#include "FairGeoMedia.h"
#include "FairGeoNode.h"
#include "FairRootManager.h"
#include "FairRun.h"
#include "FairRuntimeDb.h"
#include "FairVolume.h"
#include "TFile.h"
#include "TGDMLParse.h"
#include "TGeoManager.h"
#include "TMath.h"
#include "TObjArray.h"
#include "TParticle.h"
#include "TParticlePDG.h"
#include "TVirtualMC.h"
 
#include <iostream>
 
//------------------------------------------------------------------------------------------------------------------------
BmnDch::BmnDch()
    : FairDetector("DCH", kTRUE)
{
    fPointCollection = new TClonesArray("BmnDchPoint");
    fPosIndex = 0;
    fVerboseLevel = 1;
    ResetParameters();
}
 
//------------------------------------------------------------------------------------------------------------------------
BmnDch::BmnDch(const char* name, Bool_t active)
    : FairDetector(name, active)
{
    fPointCollection = new TClonesArray("BmnDchPoint");
    fPosIndex = 0;
    fVerboseLevel = 1;
    ResetParameters();
}
 
//------------------------------------------------------------------------------------------------------------------------
BmnDch::~BmnDch()
{
    if (fPointCollection) {
        fPointCollection->Delete();
        delete fPointCollection;
    }
}
 
//------------------------------------------------------------------------------------------------------------------------
int BmnDch::DistAndPoints(TVector3 p3, TVector3 p4, TVector3& pa, TVector3& pb)
{
    pa = (p3 + p4) * 0.5;
    pb = pa;
    // pa=p3; //del
    // pb=pa; //del
    return 0;
}
 
//------------------------------------------------------------------------------------------------------------------------
TVector3 BmnDch::GlobalToLocal(TVector3& global)
{
    Double_t globPos[3];
    Double_t localPos[3];
    global.GetXYZ(globPos);
    gMC->Gmtod(globPos, localPos, 1);
 
    return TVector3(localPos);
}
 
//------------------------------------------------------------------------------------------------------------------------
TVector3 BmnDch::LocalToGlobal(TVector3& local)
{
    Double_t globPos[3];
    Double_t localPos[3];
    local.GetXYZ(localPos);
    gMC->Gdtom(localPos, globPos, 1);
 
    return TVector3(globPos);
}
 
//----------------------------------------------------------------------------------------------------------------------
Bool_t BmnDch::ProcessHits(FairVolume* vol)
{
    // TGeoVolume *currentVolume = gGeoManager->GetCurrentVolume();
    // TString currentVolumeName = currentVolume->GetName();
 
    // Set parameters at entrance of volume. Reset ELoss.
    if (gMC->IsTrackEntering()) {
        ResetParameters();
 
        fELoss = 0.;
        fTime = gMC->TrackTime() * 1.0e09;
        fLength = gMC->TrackLength();
        fIsPrimary = 0;
        fCharge = -1;
        fPdgId = 0;
 
        TLorentzVector PosIn;
        gMC->TrackPosition(PosIn);
        fPosIn.SetXYZ(PosIn.X(), PosIn.Y(), PosIn.Z());
        gMC->TrackMomentum(fMom);
 
        TParticle* part = gMC->GetStack()->GetCurrentTrack();
        if (part) {
            fIsPrimary = (Int_t)part->IsPrimary();
            fCharge = (Int_t)part->GetPDG()->Charge();
            fPdgId = (Int_t)part->GetPdgCode();
        }
 
        fVolumeID = vol->getMCid();
        fPlaneNumber = gGeoManager->GetCurrentNode()->GetNumber();
        fTrackID = gMC->GetStack()->GetCurrentTrackNumber();
    }
 
    // Sum energy loss for all steps in the active volume
    fELoss += gMC->Edep();
 
    // Create BmnDchPoint at EXIT of active volume;
    if ((gMC->IsTrackExiting() || gMC->IsTrackStop() || gMC->IsTrackDisappeared()) && fELoss >= 0) {
        TLorentzVector PosOut;
        gMC->TrackPosition(PosOut);
        fPosOut.SetXYZ(PosOut.X(), PosOut.Y(), PosOut.Z());
 
        // Line defined in local coordinates
        TVector3 p1(0, 0, 0);   // 10 - arbitrary number...
        TVector3 p2(10, 0, 0);
 
        // Conversion to global coordinates
        p1 = LocalToGlobal(p1);
        p2 = LocalToGlobal(p2);
        Double_t phi = TMath::ATan2(p2.Y() - p1.Y(), p2.X() - p1.X());
 
        // "will-be-filled-out-soon" Points of closest approach
        TVector3 trackPosition(0, 0, 0);   // trackPosition => point on track, fPos => point on straw
 
        // calculate points of closest approach between track and straw
        // int result =
        DistAndPoints(fPosIn, fPosOut, fPos, trackPosition);
 
        BmnDchPoint* p =
            AddHit(fTrackID, fVolumeID, fPos, fPos.Perp(), TVector3(fMom.Px(), fMom.Py(), fMom.Pz()), fTime,
                   (fLength + gMC->TrackLength()) / 2, fELoss, fIsPrimary, fCharge, fPdgId, trackPosition);
        p->SetPhi(phi);   // AZ
        p->SetPlaneNumber(fPlaneNumber);
 
        ((CbmStack*)gMC->GetStack())->AddPoint(kDCH);
    }
 
    return kTRUE;
}
 
//------------------------------------------------------------------------------------------------------------------------
void BmnDch::EndOfEvent()
{
    if (fVerboseLevel)
        Print("");
    fPointCollection->Delete();
    fPosIndex = 0;
}
 
//------------------------------------------------------------------------------------------------------------------------
void BmnDch::Register()
{
    FairRootManager::Instance()->Register("DCHPoint", "DCH", fPointCollection, kTRUE);
}
 
//------------------------------------------------------------------------------------------------------------------------
TClonesArray* BmnDch::GetCollection(Int_t iColl) const
{
    if (iColl == 0)
        return fPointCollection;
    return NULL;
}
 
//------------------------------------------------------------------------------------------------------------------------
void BmnDch::Print(Option_t*) const
{
    Int_t nHits = fPointCollection->GetEntriesFast();
    cout << "-I- BmnDch: " << nHits << " points registered in this event." << endl;
 
    if (fVerboseLevel > 1)
        for (Int_t i = 0; i < nHits; i++)
            (*fPointCollection)[i]->Print();
}
 
//------------------------------------------------------------------------------------------------------------------------
void BmnDch::Reset()
{
    fPointCollection->Delete();
    ResetParameters();
}
 
//------------------------------------------------------------------------------------------------------------------------
void BmnDch::CopyClones(TClonesArray* cl1, TClonesArray* cl2, Int_t offset)
{
    Int_t nEntries = cl1->GetEntriesFast();
    cout << "-I- BmnDch: " << nEntries << " entries to add." << endl;
    TClonesArray& clref = *cl2;
    BmnDchPoint* oldpoint = NULL;
 
    for (Int_t i = 0; i < nEntries; i++) {
        oldpoint = (BmnDchPoint*)cl1->At(i);
        Int_t index = oldpoint->GetTrackID() + offset;
        oldpoint->SetTrackID(index);
        new (clref[fPosIndex]) BmnDchPoint(*oldpoint);
        fPosIndex++;
    }
 
    cout << "-I- BmnDch: " << cl2->GetEntriesFast() << " merged entries." << endl;
}
 
//------------------------------------------------------------------------------------------------------------------------
void BmnDch::ConstructGeometry()
{
    TString fileName = GetGeometryFileName();
 
    if (fileName.EndsWith(".root")) {
        LOG(info) << "Constructing DCH geometry from ROOT file " << fileName.Data();
        ConstructRootGeometry();
    } else if (fileName.EndsWith(".geo")) {
        LOG(info) << "Constructing DCH geometry from ASCII file " << fileName.Data();
        ConstructAsciiGeometry();
    } else if (fileName.EndsWith(".gdml")) {
        LOG(info) << "Constructing DCH geometry from GDML file " << fileName.Data();
        ConstructGDMLGeometry(nullptr);
    } else {
        LOG(fatal) << "Geometry format of DCH file " << fileName.Data() << " not supported.";
    }
}
 
// -----   ConstructAsciiGeometry   -------------------------------------------
void BmnDch::ConstructAsciiGeometry()
{
    FairGeoLoader* geoLoad = FairGeoLoader::Instance();
    FairGeoInterface* geoFace = geoLoad->getGeoInterface();
    BmnDchGeo* DCHGeo = new BmnDchGeo();
    DCHGeo->setGeomFile(GetGeometryFileName());
    geoFace->addGeoModule(DCHGeo);
 
    Bool_t rc = geoFace->readSet(DCHGeo);
    if (rc)
        DCHGeo->create(geoLoad->getGeoBuilder());
    TList* volList = DCHGeo->getListOfVolumes();
    // store geo parameter
    FairRun* fRun = FairRun::Instance();
    FairRuntimeDb* rtdb = FairRun::Instance()->GetRuntimeDb();
    BmnDchGeoPar* par = (BmnDchGeoPar*)(rtdb->getContainer("BmnDchGeoPar"));
    TObjArray* fSensNodes = par->GetGeoSensitiveNodes();
    TObjArray* fPassNodes = par->GetGeoPassiveNodes();
 
    TListIter iter(volList);
    FairGeoNode* node = NULL;
    FairGeoVolume* aVol = NULL;
 
    while ((node = (FairGeoNode*)iter.Next())) {
        aVol = dynamic_cast<FairGeoVolume*>(node);
        if (node->isSensitive()) {
            fSensNodes->AddLast(aVol);
        } else {
            fPassNodes->AddLast(aVol);
        }
    }
    par->setChanged();
    par->setInputVersion(fRun->GetRunId(), 1);
    ProcessNodes(volList);
}
 
/*
// -----   ConstructGDMLGeometry   -------------------------------------------
void BmnDch::ConstructGDMLGeometry()
{
    TGDMLParse parser;
    TGeoVolume* v1 = parser.GDMLReadFile(GetGeometryFileName());
 
    v1->Dump();
 
    if (v1 == 0)
        fLogger->Fatal(MESSAGE_ORIGIN, "\033[5m\033[31mFairModule::ConstructGDMLGeometry(): could construct geometry
from GDML File!!  \033[0m", GetGeometryFileName().Data());
 
    TGeoNode* n = v1->GetNode(0);
 
    n->Dump();
 
    gGeoManager->cd();
 
    // add gdml volume to the simulation TGeoManager
    gGeoManager->AddVolume(v1);
 
    // force rebuilding of voxels
    TGeoVoxelFinder* voxels = v1->GetVoxels();
    if (voxels)
        voxels->SetNeedRebuild();
 
    //To avoid having different names of the default matrices because we could have get the volume from another
    //TGeoManager, we reset the default matrix name
    //TGeoMatrix* M = n->GetMatrix();
    //M->SetDefaultName();
 
    //Now we can remove the matrix so that the new geomanager will rebuild it properly
    //gGeoManager->GetListOfMatrices()->Remove(M);
    //TGeoHMatrix* global = gGeoManager->GetHMatrix();
    //gGeoManager->GetListOfMatrices()->Remove(global); //Remove the Identity matrix
 
    //Now we can add the node to the existing cave
    TGeoVolume* Cave = gGeoManager->GetTopVolume();
    Cave->AddNode(v1, 0, 0);
 
    // correction from O. Merle: in case of a TGeoVolume (v1) set the material properly
    // Assign medium to the the volume v, this has to be done in all cases:
    // case 1: For CAD converted volumes they have no mediums (only names)
    // case 2: TGeoVolumes, we need to be sure that the material is defined in this session
    FairGeoMedia* Media = FairGeoLoader::Instance()->getGeoInterface()->getMedia();
    FairGeoBuilder* geobuild = FairGeoLoader::Instance()->getGeoBuilder();
    TGeoMedium* med1 = v1->GetMedium();
    med1->Dump();
    if (med1)
    {
      TGeoMaterial* mat1 = v1->GetMaterial();
      TGeoMaterial* newMat = gGeoManager->GetMaterial(mat1->GetName());
      if (newMat == 0)
      {
        cout<<"The Material is not defined in the TGeoManager"<<endl;
        // The Material is not defined in the TGeoManager, we try to create one if we have enough information about it
        FairGeoMedium* FairMedium = Media->getMedium(mat1->GetName());
        if (!FairMedium)
        {
          fLogger->Fatal(MESSAGE_ORIGIN,"Material %s is not defined in ASCII file nor in Root file we Stop creating
geometry", mat1->GetName());
          //     FairMedium=new FairGeoMedium(mat1->GetName());
          //      Media->addMedium(FairMedium);
        }
 
        Int_t nmed = geobuild->createMedium(FairMedium);
        v1->SetMedium(gGeoManager->GetMedium(nmed));
        gGeoManager->SetAllIndex();
      }
      else
      {
        cout<<"Material is already available in the TGeoManager"<<endl;
        // Material is already available in the TGeoManager and we can set it
        TGeoMedium* med2 = gGeoManager->GetMedium(mat1->GetName());
        v1->SetMedium(med2);
      }
    }
    else
    {
      if (strcmp(v1->ClassName(),"TGeoVolumeAssembly") != 0)
      {
        //[R.K.-3.3.08]  // When there is NO material defined, set it to avoid conflicts in Geant
        fLogger->Fatal(MESSAGE_ORIGIN,"The volume  %s  Has no medium information and not an Assembly so we have to
quit", v1->GetName());
      }
    }
 
    // now go through the herachy and set the materials properly, this is important becase the CAD converter
    // produce TGeoVolumes with materials that have only names and no properties
    ExpandNode(gGeoManager->GetTopVolume()->GetNode(gGeoManager->GetTopVolume()->GetNdaughters()-1));
 
 
    // Define output ROOT file with dch geometry
    TFile* outfile = new TFile("dch.root", "RECREATE");
    v1->Write();
    outfile->Close();
}
// ----------------------------------------------------------------------------
*/
 
// -----   ConstructGDMLGeometry   -------------------------------------------
void BmnDch::ConstructGDMLGeometry(TGeoMatrix*)
{
    TFile* old = gFile;
    TGDMLParse parser;
    TGeoVolume* gdmlTop;
 
    // Before importing GDML
    Int_t maxInd = gGeoManager->GetListOfMedia()->GetEntries() - 1;
 
    gdmlTop = parser.GDMLReadFile(GetGeometryFileName());
 
    // Cheating - reassigning media indices after GDML import (need to fix this in TGDMLParse class!!!)
    //   for (Int_t i=0; i<gGeoManager->GetListOfMedia()->GetEntries(); i++)
    //      gGeoManager->GetListOfMedia()->At(i)->Dump();
    // After importing GDML
    Int_t j = gGeoManager->GetListOfMedia()->GetEntries() - 1;
    Int_t curId;
    TGeoMedium* m;
    do {
        m = (TGeoMedium*)gGeoManager->GetListOfMedia()->At(j);
        curId = m->GetId();
        m->SetId(curId + maxInd);
        j--;
    } while (curId > 1);
 
    Int_t newMaxInd = gGeoManager->GetListOfMedia()->GetEntries() - 1;
 
    gGeoManager->GetTopVolume()->AddNode(gdmlTop, 1, 0);
    ExpandNodeForGdml(gGeoManager->GetTopVolume()->GetNode(gGeoManager->GetTopVolume()->GetNdaughters() - 1));
 
    for (Int_t k = maxInd + 1; k < newMaxInd + 1; k++) {
        TGeoMedium* medToDel = (TGeoMedium*)(gGeoManager->GetListOfMedia()->At(maxInd + 1));
        LOG(debug) << "    removing media " << medToDel->GetName() << " with id " << medToDel->GetId() << " (k=" << k
                   << ")";
        gGeoManager->GetListOfMedia()->Remove(medToDel);
    }
    gGeoManager->SetAllIndex();
 
    gFile = old;
}
 
void BmnDch::ExpandNodeForGdml(TGeoNode* node)
{
    LOG(debug) << "----------------------------------------- ExpandNodeForGdml for node " << node->GetName();
 
    TGeoVolume* curVol = node->GetVolume();
    LOG(debug) << "    volume: " << curVol->GetName();
 
    if (curVol->IsAssembly())
        LOG(debug) << "    skipping volume-assembly";
    else {
        TGeoMedium* curMed = curVol->GetMedium();
        TGeoMaterial* curMat = curVol->GetMaterial();
        TGeoMedium* curMedInGeoManager = gGeoManager->GetMedium(curMed->GetName());
        TGeoMaterial* curMatOfMedInGeoManager = curMedInGeoManager->GetMaterial();
        TGeoMaterial* curMatInGeoManager = gGeoManager->GetMaterial(curMat->GetName());
 
        // Current medium and material assigned to the volume from GDML
        LOG(debug2) << "    curMed\t\t\t\t" << curMed << "\t" << curMed->GetName() << "\t" << curMed->GetId();
        LOG(debug2) << "    curMat\t\t\t\t" << curMat << "\t" << curMat->GetName() << "\t" << curMat->GetIndex();
 
        // Medium and material found in the gGeoManager - either the pre-loaded one or one from GDML
        LOG(debug2) << "    curMedInGeoManager\t\t" << curMedInGeoManager << "\t" << curMedInGeoManager->GetName()
                    << "\t" << curMedInGeoManager->GetId();
        LOG(debug2) << "    curMatOfMedInGeoManager\t\t" << curMatOfMedInGeoManager << "\t"
                    << curMatOfMedInGeoManager->GetName() << "\t" << curMatOfMedInGeoManager->GetIndex();
        LOG(debug2) << "    curMatInGeoManager\t\t" << curMatInGeoManager << "\t" << curMatInGeoManager->GetName()
                    << "\t" << curMatInGeoManager->GetIndex();
 
        TString matName = curMat->GetName();
        TString medName = curMed->GetName();
 
        if (curMed->GetId() != curMedInGeoManager->GetId()) {
            if (fFixedMedia.find(medName) == fFixedMedia.end()) {
                LOG(debug) << "    Medium needs to be fixed";
                fFixedMedia[medName] = curMedInGeoManager;
                Int_t ind = curMat->GetIndex();
                gGeoManager->RemoveMaterial(ind);
                LOG(debug) << "    removing material " << curMat->GetName() << " with index " << ind;
                for (Int_t i = ind; i < gGeoManager->GetListOfMaterials()->GetEntries(); i++) {
                    TGeoMaterial* m = (TGeoMaterial*)gGeoManager->GetListOfMaterials()->At(i);
                    m->SetIndex(m->GetIndex() - 1);
                }
 
                LOG(debug) << "    Medium fixed";
            } else {
                LOG(debug) << "    Already fixed medium found in the list    ";
            }
        } else {
            if (fFixedMedia.find(medName) == fFixedMedia.end()) {
                LOG(debug) << "    There is no correct medium in the memory yet";
 
                FairGeoLoader* geoLoad = FairGeoLoader::Instance();
                FairGeoInterface* geoFace = geoLoad->getGeoInterface();
                FairGeoMedia* geoMediaBase = geoFace->getMedia();
                FairGeoBuilder* geobuild = geoLoad->getGeoBuilder();
 
                FairGeoMedium* curMedInGeo = geoMediaBase->getMedium(medName);
                if (curMedInGeo == 0) {
                    LOG(fatal) << "    Media not found in Geo file: " << medName;
                    //! This should not happen.
                    //! This means that somebody uses material in GDML that is not in the media.geo file.
                    //! Most probably this is the sign to the user to check materials' names in the CATIA model.
                } else {
                    LOG(debug) << "    Found media in Geo file" << medName;
                    /*Int_t nmed = */ geobuild->createMedium(curMedInGeo);
                    fFixedMedia[medName] = (TGeoMedium*)gGeoManager->GetListOfMedia()->Last();
                    gGeoManager->RemoveMaterial(curMatOfMedInGeoManager->GetIndex());
                    LOG(debug) << "    removing material " << curMatOfMedInGeoManager->GetName() << " with index "
                               << curMatOfMedInGeoManager->GetIndex();
                    for (Int_t i = curMatOfMedInGeoManager->GetIndex();
                         i < gGeoManager->GetListOfMaterials()->GetEntries(); i++)
                    {
                        TGeoMaterial* m = (TGeoMaterial*)gGeoManager->GetListOfMaterials()->At(i);
                        m->SetIndex(m->GetIndex() - 1);
                    }
                }
 
                if (curMedInGeo->getSensitivityFlag()) {
                    LOG(debug) << "    Adding sensitive  " << curVol->GetName();
                    AddSensitiveVolume(curVol);
                }
            } else {
                LOG(debug) << "    Already fixed medium found in the list";
                LOG(debug) << "!!! Sensitivity: " << fFixedMedia[medName]->GetParam(0);
                if (fFixedMedia[medName]->GetParam(0) == 1) {
                    LOG(debug) << "    Adding sensitive  " << curVol->GetName();
                    AddSensitiveVolume(curVol);
                }
            }
        }
 
        curVol->SetMedium(fFixedMedia[medName]);
        gGeoManager->SetAllIndex();
 
        //      gGeoManager->GetListOfMaterials()->Print();
        //      gGeoManager->GetListOfMedia()->Print();
    }
 
    //! Recursevly go down the tree of nodes
    if (curVol->GetNdaughters() != 0) {
        TObjArray* NodeChildList = curVol->GetNodes();
        TGeoNode* curNodeChild;
        for (Int_t j = 0; j < NodeChildList->GetEntriesFast(); j++) {
            curNodeChild = (TGeoNode*)NodeChildList->At(j);
            ExpandNodeForGdml(curNodeChild);
        }
    }
}
 
// Check if Sensitive-----------------------------------------------------------
Bool_t BmnDch::CheckIfSensitive(std::string name)
{
    TString tsname = name;
    if (tsname.Contains("Active"))
        return kTRUE;
 
    return kFALSE;
 
    //  if(0 == TString(name).CompareTo("DCHDetV")) {
    //    return kTRUE;
    //  }
    //  return kFALSE;
}
 
//------------------------------------------------------------------------------------------------------------------------
BmnDchPoint* BmnDch::AddHit(Int_t trackID,
                            Int_t detID,
                            TVector3 pos,
                            Double_t radius,
                            TVector3 mom,
                            Double_t time,
                            Double_t length,
                            Double_t eLoss,
                            Int_t isPrimary,
                            Double_t charge,
                            Int_t pdgId,
                            TVector3 trackPos)
{
    TClonesArray& clref = *fPointCollection;
    Int_t size = clref.GetEntriesFast();
    // std::cout << "ELoss: " << eLoss << "\n";
    return new (clref[size])
        BmnDchPoint(trackID, detID, pos, radius, mom, time, length, eLoss, isPrimary, charge, pdgId, trackPos);
}