GGSTHitsReader Class Reference

Class for reading output of GGSHitsAction. More...

#include <GGSTHitsReader.h>

Inheritance diagram for GGSTHitsReader:

Collaboration diagram for GGSTHitsReader:

Public Member Functions
	GGSTHitsReader ()
	Constructor.
	~GGSTHitsReader ()
	Destructor.
bool	SetChain (TChain *hitsChain)
	Sets the chain. More...
void	GetEntry (Long64_t entry)
void	SetDetector (const char *detector, bool readPartHits=false, bool readPosHits=false)
	Enables reading hit informations of the specified detector. More...
bool	DetectorExists (const char *detector, bool particleHits=false, bool positionHits=false)
	Checks the existence of a given detector within the hits tree. More...
void	ListDetectors ()
	Prints a list of detectors which are present in hits tree on standard output.
std::vector< TString >	GetListOfDetectors ()
	Returns the list of detectors which are present in hits tree on standard output.
Int_t	GetNHits (const char *detector)
	Gets the number of hits for the specified detector. More...
Int_t	GetNHits (int iDet)
	Gets the number of hits for the specified detector. More...
GGSTIntHitBase *	GetHit (const char *detector, unsigned int iHit)
	Get the specified hit. More...
GGSTIntHitBase *	GetHit (int iDet, unsigned int iHit)
	Get the specified hit. More...
std::string	GetIntHitsClassName (const char *detector)
	Gets the name of the class of the integrated hits for the given detector. More...
std::string	GetIntHitsClassName (int iDet)
	Gets the name of the class of the integrated hits for the given detector. More...
int	GetDetectorIndex (const char *detector)
	Retrieves the index of requested detector. More...
bool	HasPartHits (const char *detector)
	Check if particle hits data is available for the specified detector. More...
bool	HasPosHits (const char *detector)
	Check if position hits data is available for the specified detector. More...
float	GetIntHitThreshold (const std::string &detector)
	Retrieves the thresholds used when saving the integrated hits. More...
float	GetPartHitThreshold (const std::string &detector)
	Retrieves the thresholds used when saving the particle hits. More...
float	GetPosHitThreshold (const std::string &detector)
	Retrieves the thresholds used when saving the position hits. More...
Public Member Functions inherited from GGSTChainReader
virtual	~GGSTChainReader ()
	Destructor.

Detailed Description

Class for reading output of GGSHitsAction.

This class provides methods to read the information about hits in sensitive detectors as saved by GGSHitsAction. Since the hits tree has a branch for every sensitive detector, the user must specify which branches are to be read by calling SetDetector. The hits can be retrieved using GetHit.

Definition at line 37 of file GGSTHitsReader.h.

Member Function Documentation

bool GGSTHitsReader::DetectorExists	(	const char *	detector,
		bool	particleHits = false,
		bool	positionHits = false
	)

Checks the existence of a given detector within the hits tree.

Checks whether the given detector exists inside the hits tree. Note that this routine does not check whether the detector has been set for hit reading or not.

Parameters

detector	The detector to search for.
particleHits	if true then the existence of particle hits for the given detector will also be checked.
positionHits	if true then the existence of position hits for the given detector will also be checked.

Returns

true if hits for the specified detector with the specified hits exist in the hits tree.

See Also

SetDetector

Definition at line 232 of file GGSTHitsReader.cpp.

                                                                                              {
  int type = -1;
  if (_chain) {
    std::string detectorString{detector};
    detectorString += "-GGSIntHits";
    type = _CheckBranch(detectorString.c_str());
  }
  if (type == 0 && particleHits) {
    std::string detectorString{detector};
    detectorString += "-GGSPartHits";
    type = _CheckBranch(detectorString.c_str());
  }
  if (type == 1 && positionHits) {
    std::string detectorString{detector};
    detectorString += "-GGSPosHits";
    type = _CheckBranch(detectorString.c_str());
  }

  return (type != -1);
}

int GGSTHitsReader::GetDetectorIndex

(

const char *

detector

)

Retrieves the index of requested detector.

This index can be used to quickly retrieve hits using the GetHit(int, unsigned int) overload of GetHit.

Parameters

detector

The name of the detector.

Returns

The index of the desired detector.

Definition at line 384 of file GGSTHitsReader.cpp.

                                                         {
  for (UInt_t i = 0; i < _detectors.size(); i++) {
    if (!strcmp(_detectors[i].name.data(), detector))
      return i;
  }
  return -1;
}

void GGSTHitsReader::GetEntry ( Long64_t  entry )

virtual

@ brief Reads the specified entry from the hit branches.

Only detectors specified by SetDetector will be read (and only those hits specified in SetDetector call).

Parameters

entry

The desired entry.

Implements GGSTChainReader.

Definition at line 80 of file GGSTHitsReader.cpp.

                                            {
  static const std::string routineName("GGSTHitsReader::GetEntry");

  if (entry != _chain->GetReadEntry()) {
    _chain->GetEntry(entry);
  }

  if (_chain->GetChainEntryNumber(0) != _firstEntryOfCurrentFile) {
    GGSCOUT(DEBUG) << "Switching to file " << _chain->GetFile()->GetName() << GGSENDL;
    _firstEntryOfCurrentFile = _chain->GetChainEntryNumber(0);

    // Read the GGSHitDetInfo TClonesArray from the new file
    delete _detInfo;
    _detInfo = (TClonesArray *)(_chain->GetFile()->Get("GGSHitDetInfo"));

    // Update the detector indexes in _detectors
    for (unsigned int iDet = 0; iDet < _detectors.size(); iDet++)
      _detectors[iDet].detInfoArrayIndex = _GetDetectorIndexFromStorage(_detectors[iDet].logVolName.data());

    // Reload time bins and thresholds
    _timeBins.clear();
    _thresholds.clear();
    for (unsigned int iDet = 0; iDet < _detectors.size(); iDet++) {
      delete _timeBins[iDet];
      _timeBins.push_back((TArrayF *)(_chain->GetFile()->Get(TString(_detectors[iDet].name) + "-GGSIntHits-TimeBins")));
      delete _thresholds[iDet];
      _thresholds.push_back(
          (std::vector<float> *)(_chain->GetFile()->Get(TString(_detectors[iDet].name) + "-GGSIntHits-Thresholds")));
    }
  }
}

GGSTIntHitBase * GGSTHitsReader::GetHit	(	const char *	detector,
		unsigned int	iHit
	)

Get the specified hit.

This method searches for the desired hit in the specified detector. The detector will be fetched from the detectors internal index by means of a comparison of the name passed as first argument with the stored detector names. This involves a std::string comparison which might hurt performance when done inside the hit loop. If needed, to improve performance use the GetHit(int, unsigned int) overload.

Parameters

detector	The desired detector.
iHit	The desired hit of the specified detector

Returns

Pointer to the hit object (nullptr if iHit is out of bounds).

Definition at line 324 of file GGSTHitsReader.cpp.

                                                                              {
  int iDet = GetDetectorIndex(detector);
  if (iDet != -1)
    return GetHit(iDet, iHit);
  else
    return nullptr;
}

GGSTIntHitBase * GGSTHitsReader::GetHit	(	int	iDet,
		unsigned int	iHit
	)

Get the specified hit.

The detector index to be passed as first argument can be retrieved by calling GetDetectorIndex.

Parameters

iDet	The detector index.
iHit	The desired hit of the specified detector

Returns

Pointer to the hit object (nullptr if iHit is out of bounds).

Definition at line 332 of file GGSTHitsReader.cpp.

                                                                  {
  static TClonesArray *hitArray = nullptr;
  hitArray = _GetHitArray(iDet);
  if (hitArray) {
    GGSTIntHitBase *hit = (GGSTIntHitBase *)(hitArray->At(iHit));
    if (hit) {
      // Compute non-persistent informations
      hit->eDep = hit->eDepTimeBin.GetSum();
      hit->_hitDetInfo = _GetDetectorInfo(_detectors[iDet].detInfoArrayIndex);
      hit->_timeBins = _timeBins[iDet];
      if (hit->_hitDetInfo)
        hit->_hitVolInfo = (GGSTHitVolInfo *)(hit->_hitDetInfo->volumes.At(hit->_volumeIndex));
      else
        hit->_hitVolInfo = nullptr;
      if (_readPartHits[iDet]) {
        hit->_partHits = (TClonesArray *)(_partHitArrays[iDet]->At(iHit));
      }
      if (_readPosHits[iDet]) {
        // Set pointer to position hits collection for each particle hit
        TClonesArray *partHits = hit->_partHits;
        int nPartHits = partHits->GetEntries();
        for (int iPartHit = 0; iPartHit < nPartHits; iPartHit++) {
          GGSTPartHit *partHit = (GGSTPartHit *)(partHits->At(iPartHit));
          partHit->_posHits = (TClonesArray *)(_posHitArrays[iDet]->At(partHit->_posHitIndex));
        }
      }
      return hit;
    }
  }
  return nullptr;
}

std::string GGSTHitsReader::GetIntHitsClassName

(

const char *

detector

)

Gets the name of the class of the integrated hits for the given detector.

Parameters

detector

The name of the detector;

Returns

The position hits class name.

Definition at line 364 of file GGSTHitsReader.cpp.

                                                                  {
  int iDet = GetDetectorIndex(detector);
  if (iDet >= 0) {
    return GetIntHitsClassName(iDet);
  } else {
    return "";
  }
}

std::string GGSTHitsReader::GetIntHitsClassName

(

int

iDet

)

Gets the name of the class of the integrated hits for the given detector.

Parameters

iDet	The index of the detector;

Returns

The position hits class name.

Definition at line 373 of file GGSTHitsReader.cpp.

                                                      {
  TClonesArray *hitArray = _GetHitArray(iDet);
  if (hitArray) {
    std::string retValue = hitArray->GetName();
    return retValue.substr(0, retValue.size() - 1);
  } else {
    return "";
  }
}

float GGSTHitsReader::GetIntHitThreshold

(

const std::string &

detector

)

Retrieves the thresholds used when saving the integrated hits.

Parameters

detector

The name of the detector.

Returns

The value of the threshold [GeV].

Exceptions

std::range_error	if the given detector is not present.
std::runtime_error	if thresholds are not available in the input file.

Definition at line 422 of file GGSTHitsReader.cpp.

                                                                  {
  const std::string routineName("GSTHitsReader::GetIntHitThreshold");
  int detIndex = GetDetectorIndex(detector.c_str());
  if (detIndex == -1) {
    throw std::range_error(routineName + ": detector " + detector + " not found");
  }

  if (_thresholds[detIndex]) {
    return (*(_thresholds[detIndex]))[0];
  } else {
    throw std::runtime_error(routineName + ": thresholds for integrated hits not available for detector " + detector);
  }
}

Int_t GGSTHitsReader::GetNHits

(

const char *

detector

)

Gets the number of hits for the specified detector.

Parameters

detector

The desired detector.

Returns

The number of hits (0 if the specified detector does not exist.

Definition at line 303 of file GGSTHitsReader.cpp.

                                                   {
  static short int iHitArray;
  iHitArray = GetDetectorIndex(detector);
  if (iHitArray != -1)
    return (_GetHitArray(iHitArray))->GetEntries();
  else
    return 0;
}

Int_t GGSTHitsReader::GetNHits

(

int

iDet

)

Gets the number of hits for the specified detector.

The detector index to be passed as first parameter can be retrieved by calling GetDetectorIndex.

Parameters

iDet	Index of the desired detector.

Returns

The number of hits (0 if the specified detector does not exist.

Definition at line 314 of file GGSTHitsReader.cpp.

                                       {
  TClonesArray *detArray = _GetHitArray(iDet);
  if (detArray)
    return detArray->GetEntries();
  else
    return 0;
}

float GGSTHitsReader::GetPartHitThreshold

(

const std::string &

detector

)

Retrieves the thresholds used when saving the particle hits.

Parameters

detector

The name of the detector.

Returns

The value of the threshold [GeV].

Exceptions

std::range_error	if the given detector is not present.
std::runtime_error	if thresholds are not available in the input file.

Definition at line 438 of file GGSTHitsReader.cpp.

                                                                   {
  const std::string routineName("GSTHitsReader::GetIntHitThreshold");
  int detIndex = GetDetectorIndex(detector.c_str());
  if (detIndex == -1) {
    throw std::range_error(routineName + ": detector " + detector + " not found");
  }

  if (_thresholds[detIndex]) {
    return (*(_thresholds[detIndex]))[1];
  } else {
    throw std::runtime_error(routineName + ": thresholds for particle hits not available for detector " + detector);
  }
}

float GGSTHitsReader::GetPosHitThreshold

(

const std::string &

detector

)

Retrieves the thresholds used when saving the position hits.

Parameters

detector

The name of the detector.

Returns

The value of the threshold [GeV].

Exceptions

std::range_error	if the given detector is not present.
std::runtime_error	if thresholds are not available in the input file.

Definition at line 454 of file GGSTHitsReader.cpp.

                                                                  {
  const std::string routineName("GSTHitsReader::GetIntHitThreshold");
  int detIndex = GetDetectorIndex(detector.c_str());
  if (detIndex == -1) {
    throw std::range_error(routineName + ": detector " + detector + " not found");
  }

  if (_thresholds[detIndex]) {
    return (*(_thresholds[detIndex]))[2];
  } else {
    throw std::runtime_error(routineName + ": thresholds for position hits not available for detector " + detector);
  }
}

bool GGSTHitsReader::HasPartHits

(

const char *

detector

)

Check if particle hits data is available for the specified detector.

Parameters

detector

The name of the detector.

Returns

true if particle hits data is available, false otherwise.

Definition at line 394 of file GGSTHitsReader.cpp.

                                                     {
  if (_chain) {
    TString branchName(detector);
    branchName.Append("-GGSPartHits");
    TBranch *branch = _chain->GetBranch(branchName);
    if (branch)
      return true;
    else
      return false;
  } else
    return false;
}

bool GGSTHitsReader::HasPosHits

(

const char *

detector

)

Check if position hits data is available for the specified detector.

Parameters

detector

The name of the detector.

Returns

true if position hits data is available, false otherwise.

Definition at line 409 of file GGSTHitsReader.cpp.

                                                    {
  if (_chain) {
    TString branchName(detector);
    branchName.Append("-GGSPosHits");
    TBranch *branch = _chain->GetBranch(branchName);
    if (branch)
      return true;
    else
      return false;
  } else
    return false;
}

bool GGSTHitsReader::SetChain ( TChain *  hitsChain )

virtual

Sets the chain.

This method sets the hits chain, from which the informations will be read.

Parameters

hitsChain

The chain containing the hits.

Implements GGSTChainReader.

Definition at line 46 of file GGSTHitsReader.cpp.

                                               {
  _chain = hitsChain;
  delete _detInfo;
  _detInfo = (TClonesArray *)(_chain->GetFile()->Get("GGSHitDetInfo"));

  // Search for hit branches in master chain
  for (int iBranch = 0; iBranch < _chain->GetListOfBranches()->GetEntries(); iBranch++) {
    if (TString(((TBranch *)(_chain->GetListOfBranches()->At(iBranch)))->GetName()).Contains("GGSIntHits")) {
      return true;
    }
  }

  // Search for hit branches in friend chains
  if (_chain->GetListOfFriends()) {
    for (int iFriend = 0; iFriend < _chain->GetListOfFriends()->GetEntries(); iFriend++) {
      TTree *currFriend = ((TFriendElement *)(_chain->GetListOfFriends()->At(iFriend)))->GetTree();
      for (int iBranch = 0; iBranch < currFriend->GetListOfBranches()->GetEntries(); iBranch++) {
        if (TString(((TBranch *)(currFriend->GetListOfBranches()->At(iBranch)))->GetName()).Contains("GGSIntHits")) {
          return true;
        }
      }
    }
  }

  _chain = nullptr;
  delete _detInfo;
  _detInfo = nullptr;
  _firstEntryOfCurrentFile = -1;

  return false;
}

void GGSTHitsReader::SetDetector	(	const char *	detector,
		bool	readPartHits = false,
		bool	readPosHits = false
	)

Enables reading hit informations of the specified detector.

This routine will enable the reading of hits for the specified detector. Hits of other detector will not be read to improve I/O performance. The flags allow for reading particle and/or position hits if available (by default they will not be read from ROOT file, again to maximize I/O performance). Reading of position hits requires reading particle hits, so a true value for readPosHits will force also readPartHits to true. This method throws a std::runtime_exception if the given detector does not exist or if the requested particle and/or position hits are not available, and provides the strong exception guarantee (i.e. no modification to the reader is done if an exception is thrown).

Parameters

detector	The detector name.
readPartHits	if true, particle hits will be read (if available).
readPosHits	if true, position hits will be read (if available).

Exceptions

std::runtime_error

if the requested detector+hits combination is not available.

Definition at line 114 of file GGSTHitsReader.cpp.

                                                                                          {
  static const std::string routineName("GGSTHitsReader::SetDetector");

  if (!_chain)
    return;

  if (readPosHits) {
    readPartHits = true;
  }

  TString detBranchName = detector;
  detBranchName.Append("-GGSIntHits");
  TBranch *branches[3] = {nullptr, nullptr, nullptr}; // New branches (for integrated, particle and position hits)
  if (_CheckBranch(detBranchName) == 0) {
    int detIndex = GetDetectorIndex(detector); // detIndex == -1 if the detector has not been set
    std::string partHitsBranchName{std::string(detector).append("-GGSPartHits")};
    std::string posHitsBranchName{std::string(detector).append("-GGSPartHits")};
    TBranch *partHitsBranch = _chain->GetBranch(partHitsBranchName.c_str());
    TBranch *posHitsBranch = _chain->GetBranch(posHitsBranchName.c_str());

    std::string infoString("Set detector ");
    infoString.append(detector);

    // Position hits
    if (readPosHits) {
      if (posHitsBranch) {
        infoString.append(" (+PosHits)");
        if (detIndex == -1) {
          _posHitArrays.push_back(nullptr);
          _chain->SetBranchAddress(posHitsBranchName.c_str(), &(_posHitArrays.back()));
          _readPosHits.push_back(true);
        } else {
          _chain->SetBranchAddress(posHitsBranchName.c_str(), &(_posHitArrays[detIndex]));
          _readPosHits[detIndex] = true;
        }
        branches[2] = posHitsBranch;
      } else {
        throw std::runtime_error(std::string("PosHits missing for detector ") + detector);
      }
    } else {
      if (detIndex == -1) {
        _posHitArrays.push_back(nullptr);
        _readPosHits.push_back(false);
      } else {
        if (posHitsBranch) {
          posHitsBranch->ResetAddress();
        }
        _posHitArrays[detIndex] = nullptr; // FIXME: should the element be deleted before this? Is it
                                           // owned by the file/branch?
        _readPosHits[detIndex] = false;
      }
    }

    // Particle hits
    if (readPartHits) {
      if (partHitsBranch) {
        infoString.append(" (+PartHits)");
        if (detIndex == -1) {
          _partHitArrays.push_back(nullptr);
          _chain->SetBranchAddress(partHitsBranchName.c_str(), &(_partHitArrays.back()));
          _readPartHits.push_back(true);
        } else {
          _chain->SetBranchAddress(partHitsBranchName.c_str(), &(_partHitArrays[detIndex]));
          _readPartHits[detIndex] = true;
        }
        branches[1] = partHitsBranch;
      } else {
        throw std::runtime_error(std::string("PartHits missing for detector ") + detector);
      }
    } else {
      if (detIndex == -1) {
        _partHitArrays.push_back(nullptr);
        _readPartHits.push_back(false);
      } else {
        if (partHitsBranch) {
          partHitsBranch->ResetAddress();
        }
        _partHitArrays[detIndex] = nullptr; // FIXME: should the element be deleted before this? Is it
                                            // owned by the file/branch?
        _readPartHits[detIndex] = false;
      }
    }

    if (detIndex == -1) {
      _intHitArrays.push_back(nullptr);
      _chain->SetBranchAddress(detBranchName, &(_intHitArrays.back()));
      branches[0] = _chain->GetBranch(detBranchName);
      delete _detInfo;
      _detInfo = (TClonesArray *)(_chain->GetFile()->Get("GGSHitDetInfo"));
      _timeBins.push_back((TArrayF *)(_chain->GetFile()->Get(TString(detector) + "-GGSIntHits-TimeBins")));
      _thresholds.push_back(
          (std::vector<float> *)(_chain->GetFile()->Get(TString(detector) + "-GGSIntHits-Thresholds")));

      Detector det;
      det.name = detector;
      det.logVolName = detector;
      det.logVolName =
          det.logVolName.substr(0, det.logVolName.find_first_of('.')); // remove names of scorer and sensitive detector
      det.detInfoArrayIndex = _GetDetectorIndexFromStorage(det.logVolName.c_str());
      _detectors.push_back(det);
    }
    GGSCOUT(INFO) << infoString << GGSENDL;
  } else {
    throw std::runtime_error(std::string("IntHits missing for detector ") + detector);
  }

  // Synchronize the branches that have just been set for reading
  if (_chain->GetReadEntry() != -1) {
    for (int iBranch = 0; iBranch < 3; ++iBranch) {
      if (branches[iBranch]) {
        branches[iBranch]->GetEntry(_chain->GetReadEntry());
      }
    }
  }
}

---

The documentation for this class was generated from the following files:

• GGSTHitsReader.h
• GGSTHitsReader.cpp