ExternalDetector.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef ALICEO2_EXT_EXTERNALDETECTOR_H
#define ALICEO2_EXT_EXTERNALDETECTOR_H
 
#include "DetectorsBase/Detector.h"           // for DetImpl
#include "DetectorsCommonDataFormats/DetID.h" // for DetID
#include "ExternalDetectors/Hit.h"            // for the generic external hit type
 
#include "Rtypes.h"
#include "TLorentzVector.h"
 
#include <functional>
#include <set>
#include <string>
#include <unordered_map>
#include <vector>
 
class FairVolume;
class TGeoMatrix;
class TVector3;
 
namespace o2::ext
{
 
struct ExternalDetectorOptions {
  std::string root_macro_file;               // ROOT macro describing the CAD geometry (O2_CADtoTGeo.py output)
  std::string anchor_volume;                 // existing volume into which the geometry is hooked
  TGeoMatrix const* placement = nullptr;     // placement of the geometry inside the anchor (may be null)
  std::vector<std::string> sensitiveMedia;   // media (substring match on the medium name) to be made sensitive
  std::vector<std::string> sensitiveVolumes; // volumes (substring match on the volume name) to be made sensitive
  int detID = o2::detectors::DetID::ITS;     // DetID this detector's hits are tied to (identity / output format)
  std::string sensitiveMacro;                // optional ROOT macro implementing the sensitive action
  std::string sensitiveFunction;             // global function in the macro returning the action (default "sensitiveAction()")
};
 
class ExternalDetector : public o2::base::DetImpl<ExternalDetector>
{
 public:
  using SensitiveFcn = std::function<bool(o2::ext::ExternalDetector*)>;
 
  ExternalDetector(const char* name, const char* title, ExternalDetectorOptions options);
  ExternalDetector();
  ~ExternalDetector() override;
 
  static std::vector<ExternalDetector*> createFromJSON(const std::string& jsonfile);
 
  void ConstructGeometry() override;
 
  void InitializeO2Detector() override;
 
  Bool_t ProcessHits(FairVolume* v = nullptr) override;
 
  void Register() override;
 
  std::vector<o2::ext::Hit>* getHits(Int_t iColl) const
  {
    if (iColl == 0) {
      return mHits;
    }
    return nullptr;
  }
 
  void Reset() override;
  void EndOfEvent() override;
 
  void FinishPrimary() override {}
  void BeginPrimary() override {}
  void PostTrack() override {}
  void PreTrack() override {}
 
  o2::ext::Hit* addHit(int trackID, int sensorID, const TVector3& startPos, const TVector3& endPos,
                       const TVector3& startMom, double startE, double endTime, double eLoss,
                       unsigned char startStatus, unsigned char endStatus, int pdg = 0, float length = 0.f);
 
  int currentSensorID() const;
 
  int currentTrackID() const;
 
 protected:
  Bool_t defaultProcessHits();
 
  void collectSensitiveVolumeNames(TGeoVolume* vol, std::set<TGeoVolume*>& visited);
 
  ExternalDetectorOptions mOptions;
 
  std::vector<std::string> mSensitiveVolumeNames; 
  std::set<int> mSensitiveVolIDs;                 
  std::unordered_map<int, int> mVolID2SensorID;   
 
  struct TrackData {
    bool mHitStarted;              
    unsigned char mTrkStatusStart; 
    TLorentzVector mPositionStart; 
    TLorentzVector mMomentumStart; 
    double mEnergyLoss;            
  } mTrackData;                    
 
  std::vector<o2::ext::Hit>* mHits = nullptr; 
 
  SensitiveFcn mSensitiveAction;        
  FairVolume* mCurrentVolume = nullptr; 
 
  int mStepCount = 0; 
 
 private:
  ExternalDetector(const ExternalDetector&);
  ExternalDetector& operator=(const ExternalDetector&);
 
  template <typename Det>
  friend class o2::base::DetImpl;
  ClassDefOverride(ExternalDetector, 1);
};
 
} // namespace o2::ext
 
#endif